diff --git a/lib/validators/schema.js b/lib/validators/schema.js index ad4e1293..a4027ad6 100644 --- a/lib/validators/schema.js +++ b/lib/validators/schema.js @@ -6,6 +6,23 @@ const AjvDraft4 = require('ajv-draft-04'); const { getSpecificationName } = require('../util'); +/** + * We've had issues with specs larger than 2MB+ with 1,000+ errors causing memory leaks so if we + * have a spec with more than `LARGE_SPEC_ERROR_CAP` errors and it's **stringified** length is + * larger than `LARGE_SPEC_LIMITS` then we will only return the first `LARGE_SPEC_ERROR_CAP` errors. + * + * Ideally we'd be looking at the byte size of the spec instead of looking at its stringified + * length value but the Blob API, which we'd use to get its size with `new Blob([str]).size;`, was + * only recently introduced in Node 15. + * + * w/r/t the 5,000,000 limit here: The spec we found causing these memory leaks had a size of + * 13,934,323 so 5mil seems like a decent cap to start with. + * + * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Blob} + */ +const LARGE_SPEC_ERROR_CAP = 20; +const LARGE_SPEC_SIZE_CAP = 5000000; + module.exports = validateSchema; /** @@ -48,13 +65,33 @@ function validateSchema(api, options) { const isValid = ajv.validate(schema, api); if (!isValid) { const err = ajv.errors; + + let additionalErrors = 0; + let reducedErrors = reduceAjvErrors(err); + if (reducedErrors.length >= LARGE_SPEC_ERROR_CAP) { + try { + if (JSON.stringify(api).length >= LARGE_SPEC_SIZE_CAP) { + additionalErrors = reducedErrors.length - 20; + reducedErrors = reducedErrors.slice(0, 20); + } + } catch (err) { + // If we failed to stringify the API definition to look at its size then we should process + // all of its errors as-is. + } + } + let message = `${getSpecificationName(api)} schema validation failed.\n`; message += '\n'; - message += betterAjvErrors(schema, api, reduceAjvErrors(err), { + message += betterAjvErrors(schema, api, reducedErrors, { colorize: options.validate.colorizeErrors, indent: 2, }); + if (additionalErrors) { + message += '\n\n'; + message += `Plus an additional ${additionalErrors} errors. Please resolve the above and re-run validation to see more.`; + } + throw ono.syntax(err, { details: err }, message); } } diff --git a/package-lock.json b/package-lock.json index 8b9c267f..25aef5ca 100644 --- a/package-lock.json +++ b/package-lock.json @@ -12,7 +12,7 @@ "@apidevtools/openapi-schemas": "^2.1.0", "@apidevtools/swagger-methods": "^3.0.2", "@jsdevtools/ono": "^7.1.3", - "@readme/better-ajv-errors": "^1.5.0", + "@readme/better-ajv-errors": "^1.6.0", "@readme/json-schema-ref-parser": "^1.2.0", "ajv": "^8.12.0", "ajv-draft-04": "^1.0.0", @@ -1662,9 +1662,9 @@ } }, "node_modules/@babel/runtime": { - "version": "7.20.13", - "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.20.13.tgz", - "integrity": "sha512-gt3PKXs0DBoL9xCvOIIZ2NEqAGZqHjAnmVbfQtB620V0uReIQutpel14KcneZuer7UioY8ALKZ7iocavvzTNFA==", + "version": "7.21.0", + "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.21.0.tgz", + "integrity": "sha512-xwII0//EObnq89Ji5AKYQaRYiW/nZ3llSv29d49IuxPhKbtJoLP+9QUUZ4nVragQVtaVGeZrpB+ZtG/Pdy/POw==", "dependencies": { "regenerator-runtime": "^0.13.11" }, @@ -2921,12 +2921,12 @@ "dev": true }, "node_modules/@readme/better-ajv-errors": { - "version": "1.5.0", - "resolved": "https://registry.npmjs.org/@readme/better-ajv-errors/-/better-ajv-errors-1.5.0.tgz", - "integrity": "sha512-dJLAlfN5ahAb6J5t+zCv0YeJsf4mrRHllwBb6pIYZa4yfFKs3lOSAN+i+ChebbpnqCkw7IrwzPz9vzk8p5mCEw==", + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/@readme/better-ajv-errors/-/better-ajv-errors-1.6.0.tgz", + "integrity": "sha512-9gO9rld84Jgu13kcbKRU+WHseNhaVt76wYMeRDGsUGYxwJtI3RmEJ9LY9dZCYQGI8eUZLuxb5qDja0nqklpFjQ==", "dependencies": { "@babel/code-frame": "^7.16.0", - "@babel/runtime": "^7.17.8", + "@babel/runtime": "^7.21.0", "@humanwhocodes/momoa": "^2.0.3", "chalk": "^4.1.2", "json-to-ast": "^2.0.3", @@ -19174,9 +19174,9 @@ } }, "@babel/runtime": { - "version": "7.20.13", - "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.20.13.tgz", - "integrity": "sha512-gt3PKXs0DBoL9xCvOIIZ2NEqAGZqHjAnmVbfQtB620V0uReIQutpel14KcneZuer7UioY8ALKZ7iocavvzTNFA==", + "version": "7.21.0", + "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.21.0.tgz", + "integrity": "sha512-xwII0//EObnq89Ji5AKYQaRYiW/nZ3llSv29d49IuxPhKbtJoLP+9QUUZ4nVragQVtaVGeZrpB+ZtG/Pdy/POw==", "requires": { "regenerator-runtime": "^0.13.11" } @@ -20121,12 +20121,12 @@ "dev": true }, "@readme/better-ajv-errors": { - "version": "1.5.0", - "resolved": "https://registry.npmjs.org/@readme/better-ajv-errors/-/better-ajv-errors-1.5.0.tgz", - "integrity": "sha512-dJLAlfN5ahAb6J5t+zCv0YeJsf4mrRHllwBb6pIYZa4yfFKs3lOSAN+i+ChebbpnqCkw7IrwzPz9vzk8p5mCEw==", + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/@readme/better-ajv-errors/-/better-ajv-errors-1.6.0.tgz", + "integrity": "sha512-9gO9rld84Jgu13kcbKRU+WHseNhaVt76wYMeRDGsUGYxwJtI3RmEJ9LY9dZCYQGI8eUZLuxb5qDja0nqklpFjQ==", "requires": { "@babel/code-frame": "^7.16.0", - "@babel/runtime": "^7.17.8", + "@babel/runtime": "^7.21.0", "@humanwhocodes/momoa": "^2.0.3", "chalk": "^4.1.2", "json-to-ast": "^2.0.3", diff --git a/package.json b/package.json index 87cf35bc..2efcc599 100644 --- a/package.json +++ b/package.json @@ -76,7 +76,7 @@ "@apidevtools/openapi-schemas": "^2.1.0", "@apidevtools/swagger-methods": "^3.0.2", "@jsdevtools/ono": "^7.1.3", - "@readme/better-ajv-errors": "^1.5.0", + "@readme/better-ajv-errors": "^1.6.0", "@readme/json-schema-ref-parser": "^1.2.0", "ajv": "^8.12.0", "ajv-draft-04": "^1.0.0", diff --git a/test/specs/large-file-memory-leak/cloudflare-stringified.json b/test/specs/large-file-memory-leak/cloudflare-stringified.json new file mode 100644 index 00000000..bd01279d --- /dev/null +++ b/test/specs/large-file-memory-leak/cloudflare-stringified.json @@ -0,0 +1 @@ +{"components":{"schemas":{"0rtt":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["0rtt"],"example":"0rtt"},"value":{"$ref":"#/components/schemas/0rtt_value"}}}],"description":"0-RTT session resumption enabled for this zone.","title":"0-RTT Value"},"0rtt_value":{"default":"off","description":"Value of the 0-RTT setting.","enum":["on","off"],"type":"string"},"AAAARecord":{"allOf":[{"properties":{"content":{"description":"A valid IPv6 address.","example":"2400:cb00:2049:1::173.245.59.16","format":"ipv6","type":"string"},"name":{"$ref":"#/components/schemas/name-xThA5RuS"},"proxied":{"$ref":"#/components/schemas/proxied"},"type":{"description":"Record type.","enum":["AAAA"],"example":"AAAA","type":"string"}}},{"$ref":"#/components/schemas/base"}],"required":["type","name","content"],"title":"AAAA Record"},"ARecord":{"allOf":[{"properties":{"content":{"description":"A valid IPv4 address.","example":"198.51.100.4","format":"ipv4","type":"string"},"name":{"$ref":"#/components/schemas/name-xThA5RuS"},"proxied":{"$ref":"#/components/schemas/proxied"},"type":{"description":"Record type.","enum":["A"],"example":"A","type":"string"}}},{"$ref":"#/components/schemas/base"}],"required":["type","name","content"],"title":"A Record"},"CAARecord":{"allOf":[{"properties":{"content":{"description":"Formatted CAA content. See 'data' to set CAA properties.","readOnly":true,"type":"string"},"data":{"description":"Components of a CAA record.","properties":{"flags":{"description":"Flags for the CAA record.","example":1,"maximum":255,"minimum":0,"type":"number"},"tag":{"description":"Name of the property controlled by this record (e.g.: issue, issuewild, iodef).","example":"issue","type":"string"},"value":{"description":"Value of the record. This field's semantics depend on the chosen tag.","type":"string"}},"type":"object"},"name":{"$ref":"#/components/schemas/name-xThA5RuS"},"type":{"description":"Record type.","enum":["CAA"],"example":"CAA","type":"string"}}},{"$ref":"#/components/schemas/base"}],"required":["type","name","data"],"title":"CAA Record"},"CERTRecord":{"allOf":[{"properties":{"content":{"description":"Formatted CERT content. See 'data' to set CERT properties.","readOnly":true,"type":"string"},"data":{"description":"Components of a CERT record.","properties":{"algorithm":{"description":"Algorithm.","example":8,"maximum":255,"minimum":0,"type":"number"},"certificate":{"description":"Certificate.","type":"string"},"key_tag":{"description":"Key Tag.","example":1,"maximum":65535,"minimum":0,"type":"number"},"type":{"description":"Type.","example":9,"maximum":65535,"minimum":0,"type":"number"}},"type":"object"},"name":{"$ref":"#/components/schemas/name-xThA5RuS"},"type":{"description":"Record type.","enum":["CERT"],"example":"CERT","type":"string"}}},{"$ref":"#/components/schemas/base"}],"required":["type","name","data"],"title":"CERT Record"},"CNAMERecord":{"allOf":[{"properties":{"content":{"description":"A valid hostname."},"name":{"$ref":"#/components/schemas/name-xThA5RuS"},"proxied":{"$ref":"#/components/schemas/proxied"},"type":{"description":"Record type.","enum":["CNAME"],"example":"CNAME","type":"string"}}},{"$ref":"#/components/schemas/base"}],"required":["type","name","content"],"title":"CNAME Record"},"CustomNS":{"description":"A single account custom nameserver.","properties":{"dns_records":{"description":"A and AAAA records associated with the nameserver.","items":{"properties":{"type":{"description":"DNS record type.","enum":["A","AAAA"],"example":"A","type":"string"},"value":{"description":"DNS record contents (an IPv4 or IPv6 address).","example":"1.1.1.1","type":"string"}}},"type":"array"},"ns_name":{"$ref":"#/components/schemas/ns_name"},"status":{"deprecated":true,"description":"Verification status of the nameserver.","enum":["moved","pending","verified"],"example":"verified","type":"string"},"zone_tag":{"$ref":"#/components/schemas/schemas-identifier"}},"required":["dns_records","ns_name","status","zone_tag"],"title":"Custom NS"},"CustomNSInput":{"properties":{"ns_name":{"$ref":"#/components/schemas/ns_name"}},"required":["ns_name"],"title":"Custom NS Input"},"DNSKEYRecord":{"allOf":[{"properties":{"content":{"description":"Formatted DNSKEY content. See 'data' to set DNSKEY properties.","readOnly":true,"type":"string"},"data":{"description":"Components of a DNSKEY record.","properties":{"algorithm":{"description":"Algorithm.","example":5,"maximum":255,"minimum":0,"type":"number"},"flags":{"description":"Flags.","example":1,"maximum":65535,"minimum":0,"type":"number"},"protocol":{"description":"Protocol.","example":3,"maximum":255,"minimum":0,"type":"number"},"public_key":{"description":"Public Key.","type":"string"}},"type":"object"},"name":{"$ref":"#/components/schemas/name-xThA5RuS"},"type":{"description":"Record type.","enum":["DNSKEY"],"example":"DNSKEY","type":"string"}}},{"$ref":"#/components/schemas/base"}],"required":["type","name","data"],"title":"DNSKEY Record"},"DSRecord":{"allOf":[{"properties":{"content":{"description":"Formatted DS content. See 'data' to set DS properties.","readOnly":true,"type":"string"},"data":{"description":"Components of a DS record.","properties":{"algorithm":{"description":"Algorithm.","example":3,"maximum":255,"minimum":0,"type":"number"},"digest":{"description":"Digest.","type":"string"},"digest_type":{"description":"Digest Type.","example":1,"maximum":255,"minimum":0,"type":"number"},"key_tag":{"description":"Key Tag.","example":1,"maximum":65535,"minimum":0,"type":"number"}},"type":"object"},"name":{"$ref":"#/components/schemas/name-xThA5RuS"},"type":{"description":"Record type.","enum":["DS"],"example":"DS","type":"string"}}},{"$ref":"#/components/schemas/base"}],"required":["type","name","data"],"title":"DS Record"},"Everything":{"properties":{"purge_everything":{"type":"boolean"}},"type":"object"},"File":{"example":"http://www.example.com/css/styles.css","type":"string"},"Files":{"properties":{"files":{"items":{"anyOf":[{"$ref":"#/components/schemas/File"},{"$ref":"#/components/schemas/UrlAndHeaders"}]},"type":"array"}},"type":"object"},"Flex":{"anyOf":[{"$ref":"#/components/schemas/Tags"},{"$ref":"#/components/schemas/Hosts"},{"$ref":"#/components/schemas/Prefixes"}]},"HTTPSRecord":{"allOf":[{"properties":{"content":{"description":"Formatted HTTPS content. See 'data' to set HTTPS properties.","readOnly":true,"type":"string"},"data":{"description":"Components of a HTTPS record.","properties":{"priority":{"description":"priority.","example":1,"maximum":65535,"minimum":0,"type":"number"},"target":{"description":"target.","example":".","type":"string"},"value":{"description":"value.","example":"alpn=\"h3,h2\" ipv4hint=\"127.0.0.1\" ipv6hint=\"::1\"","type":"string"}},"type":"object"},"name":{"$ref":"#/components/schemas/name-xThA5RuS"},"type":{"description":"Record type.","enum":["HTTPS"],"example":"HTTPS","type":"string"}}},{"$ref":"#/components/schemas/base"}],"required":["type","name","data"],"title":"HTTPS Record"},"Host":{"description":"The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin.","items":{"example":"example.com","type":"string"},"type":"array"},"Hosts":{"properties":{"hosts":{"example":["www.example.com","images.example.com"],"items":{"type":"string"},"type":"array"}},"type":"object"},"LOCRecord":{"allOf":[{"properties":{"content":{"description":"Formatted LOC content. See 'data' to set LOC properties.","example":"IN LOC 37 46 46 N 122 23 35 W 0m 100m 0m 0m","readOnly":true,"type":"string"},"data":{"description":"Components of a LOC record.","properties":{"altitude":{"description":"Altitude of location in meters.","example":0,"maximum":42849672.95,"minimum":-100000,"type":"number"},"lat_degrees":{"description":"Degrees of latitude.","example":37,"maximum":90,"minimum":0,"type":"number"},"lat_direction":{"description":"Latitude direction.","enum":["N","S"],"example":"N"},"lat_minutes":{"default":0,"description":"Minutes of latitude.","example":46,"maximum":59,"minimum":0,"type":"number"},"lat_seconds":{"default":0,"description":"Seconds of latitude.","example":46,"maximum":59.999,"minimum":0,"type":"number"},"long_degrees":{"description":"Degrees of longitude.","example":122,"maximum":180,"minimum":0,"type":"number"},"long_direction":{"description":"Longitude direction.","enum":["E","W"],"example":"W"},"long_minutes":{"default":0,"description":"Minutes of longitude.","example":23,"maximum":59,"minimum":0,"type":"number"},"long_seconds":{"default":0,"description":"Seconds of longitude.","example":35,"maximum":59.999,"minimum":0,"type":"number"},"precision_horz":{"default":0,"description":"Horizontal precision of location.","example":0,"maximum":90000000,"minimum":0,"type":"number"},"precision_vert":{"default":0,"description":"Vertical precision of location.","example":0,"maximum":90000000,"minimum":0,"type":"number"},"size":{"default":0,"description":"Size of location in meters.","example":100,"maximum":90000000,"minimum":0,"type":"number"}},"type":"object"},"name":{"$ref":"#/components/schemas/name-xThA5RuS"},"type":{"description":"Record type.","enum":["LOC"],"example":"LOC","type":"string"}}},{"$ref":"#/components/schemas/base"}],"required":["type","name","data"],"title":"LOC Record"},"MXRecord":{"allOf":[{"properties":{"content":{"description":"A valid mail server hostname.","example":"mx.example.com","format":"hostname","type":"string"},"name":{"$ref":"#/components/schemas/name-xThA5RuS"},"priority":{"$ref":"#/components/schemas/priority-hJRwn9f1"},"type":{"description":"Record type.","enum":["MX"],"example":"MX","type":"string"}}},{"$ref":"#/components/schemas/base"}],"required":["type","name","content","priority"],"title":"MX Record"},"NAPTRRecord":{"allOf":[{"properties":{"content":{"description":"Formatted NAPTR content. See 'data' to set NAPTR properties.","readOnly":true,"type":"string"},"data":{"description":"Components of a NAPTR record.","properties":{"flags":{"description":"Flags.","type":"string"},"order":{"description":"Order.","example":100,"maximum":65535,"minimum":0,"type":"number"},"preference":{"description":"Preference.","example":10,"maximum":65535,"minimum":0,"type":"number"},"regex":{"description":"Regex.","type":"string"},"replacement":{"description":"Replacement.","type":"string"},"service":{"description":"Service.","type":"string"}},"type":"object"},"name":{"$ref":"#/components/schemas/name-xThA5RuS"},"type":{"description":"Record type.","enum":["NAPTR"],"example":"NAPTR","type":"string"}}},{"$ref":"#/components/schemas/base"}],"required":["type","name","data"],"title":"NAPTR Record"},"NSRecord":{"allOf":[{"properties":{"content":{"description":"A valid name server host name.","example":"ns1.example.com"},"name":{"$ref":"#/components/schemas/name-xThA5RuS"},"type":{"description":"Record type.","enum":["NS"],"example":"NS","type":"string"}}},{"$ref":"#/components/schemas/base"}],"required":["type","name","content"],"title":"NS Record"},"PTRRecord":{"allOf":[{"properties":{"content":{"description":"Domain name pointing to the address.","example":"example.com","type":"string"},"name":{"$ref":"#/components/schemas/name-xThA5RuS"},"type":{"description":"Record type.","enum":["PTR"],"example":"PTR","type":"string"}}},{"$ref":"#/components/schemas/base"}],"required":["type","name","content"],"title":"PTR Record"},"Prefixes":{"properties":{"prefixes":{"example":["www.example.com/foo","images.example.com/bar/baz"],"items":{"type":"string"},"type":"array"}},"type":"object"},"SMIMEARecord":{"allOf":[{"properties":{"content":{"description":"Formatted SMIMEA content. See 'data' to set SMIMEA properties.","readOnly":true,"type":"string"},"data":{"description":"Components of a SMIMEA record.","properties":{"certificate":{"description":"Certificate.","type":"string"},"matching_type":{"description":"Matching Type.","example":0,"maximum":255,"minimum":0,"type":"number"},"selector":{"description":"Selector.","example":0,"maximum":255,"minimum":0,"type":"number"},"usage":{"description":"Usage.","example":3,"maximum":255,"minimum":0,"type":"number"}},"type":"object"},"name":{"$ref":"#/components/schemas/name-xThA5RuS"},"type":{"description":"Record type.","enum":["SMIMEA"],"example":"SMIMEA","type":"string"}}},{"$ref":"#/components/schemas/base"}],"required":["type","name","data"],"title":"SMIMEA Record"},"SRVRecord":{"allOf":[{"properties":{"content":{"description":"Priority, weight, port, and SRV target. See 'data' for setting the individual component values.","example":"10 IN SRV 5 8806 example.com.","readOnly":true,"type":"string"},"data":{"description":"Components of a SRV record.","properties":{"name":{"description":"A valid hostname.","example":"example.com","format":"hostname","type":"string"},"port":{"description":"The port of the service.","example":8806,"maximum":65535,"minimum":0,"type":"number"},"priority":{"$ref":"#/components/schemas/priority-hJRwn9f1"},"proto":{"description":"A valid protocol.","example":"_tcp","type":"string"},"service":{"description":"A service type, prefixed with an underscore.","example":"_sip","type":"string"},"target":{"description":"A valid hostname.","example":"example.com","format":"hostname","type":"string"},"weight":{"description":"The record weight.","example":5,"maximum":65535,"minimum":0,"type":"number"}},"type":"object"},"name":{"description":"Service, protocol, and SRV name content. See 'data' for setting the individual component values.","example":"_sip._tcp.example.com","maxLength":255,"readOnly":true,"type":"string"},"type":{"description":"Record type.","enum":["SRV"],"example":"SRV","type":"string"}}},{"$ref":"#/components/schemas/base"}],"required":["type","data"],"title":"SRV Record"},"SSHFPRecord":{"allOf":[{"properties":{"content":{"description":"Formatted SSHFP content. See 'data' to set SSHFP properties.","readOnly":true,"type":"string"},"data":{"description":"Components of a SSHFP record.","properties":{"algorithm":{"description":"algorithm.","example":2,"maximum":255,"minimum":0,"type":"number"},"fingerprint":{"description":"fingerprint.","type":"string"},"type":{"description":"type.","example":1,"maximum":255,"minimum":0,"type":"number"}},"type":"object"},"name":{"$ref":"#/components/schemas/name-xThA5RuS"},"type":{"description":"Record type.","enum":["SSHFP"],"example":"SSHFP","type":"string"}}},{"$ref":"#/components/schemas/base"}],"required":["type","name","data"],"title":"SSHFP Record"},"SVCBRecord":{"allOf":[{"properties":{"content":{"description":"Formatted SVCB content. See 'data' to set SVCB properties.","readOnly":true,"type":"string"},"data":{"description":"Components of a SVCB record.","properties":{"priority":{"description":"priority.","example":1,"maximum":65535,"minimum":0,"type":"number"},"target":{"description":"target.","example":".","type":"string"},"value":{"description":"value.","example":"alpn=\"h3,h2\" ipv4hint=\"127.0.0.1\" ipv6hint=\"::1\"","type":"string"}},"type":"object"},"name":{"$ref":"#/components/schemas/name-xThA5RuS"},"type":{"description":"Record type.","enum":["SVCB"],"example":"SVCB","type":"string"}}},{"$ref":"#/components/schemas/base"}],"required":["type","name","data"],"title":"SVCB Record"},"TLSARecord":{"allOf":[{"properties":{"content":{"description":"Formatted TLSA content. See 'data' to set TLSA properties.","readOnly":true,"type":"string"},"data":{"description":"Components of a TLSA record.","properties":{"certificate":{"description":"certificate.","type":"string"},"matching_type":{"description":"Matching Type.","example":1,"maximum":255,"minimum":0,"type":"number"},"selector":{"description":"Selector.","example":0,"maximum":255,"minimum":0,"type":"number"},"usage":{"description":"Usage.","example":0,"maximum":255,"minimum":0,"type":"number"}},"type":"object"},"name":{"$ref":"#/components/schemas/name-xThA5RuS"},"type":{"description":"Record type.","enum":["TLSA"],"example":"TLSA","type":"string"}}},{"$ref":"#/components/schemas/base"}],"required":["type","name","data"],"title":"TLSA Record"},"TXTRecord":{"allOf":[{"properties":{"content":{"description":"Text content for the record.","example":"example text content","type":"string"},"name":{"$ref":"#/components/schemas/name-xThA5RuS"},"type":{"description":"Record type.","enum":["TXT"],"example":"TXT","type":"string"}}},{"$ref":"#/components/schemas/base"}],"required":["type","name","content"],"title":"TXT Record"},"Tags":{"properties":{"tags":{"example":["some-tag","another-tag"],"items":{"type":"string"},"type":"array"}},"type":"object"},"URIRecord":{"allOf":[{"properties":{"content":{"description":"Formatted URI content. See 'data' to set URI properties.","readOnly":true,"type":"string"},"data":{"description":"Components of a URI record.","properties":{"content":{"description":"The record content.","example":"http://example.com/example.html","type":"string"},"weight":{"description":"The record weight.","example":20,"maximum":65535,"minimum":0,"type":"number"}},"type":"object"},"name":{"$ref":"#/components/schemas/name-xThA5RuS"},"priority":{"$ref":"#/components/schemas/priority-hJRwn9f1"},"type":{"description":"Record type.","enum":["URI"],"example":"URI","type":"string"}}},{"$ref":"#/components/schemas/base"}],"required":["type","name","data","priority"],"title":"URI Record"},"UrlAndHeaders":{"properties":{"headers":{"example":"{\n \"Origin\": \"https://www.cloudflare.com\",\n \"CF-IPCountry\": \"US\",\n \"CF-Device-Type\": \"desktop\"\n}","type":"object"},"url":{"example":"http://www.example.com/cat_picture.jpg","type":"string"}},"type":"object"},"access-policy":{"oneOf":[{"$ref":"#/components/schemas/policy_with_permission_groups"}],"type":"object"},"access-requests":{"properties":{"action":{"$ref":"#/components/schemas/action-Ib2HEWrw"},"allowed":{"$ref":"#/components/schemas/allowed"},"app_domain":{"$ref":"#/components/schemas/app_domain"},"app_uid":{"$ref":"#/components/schemas/app_uid"},"connection":{"$ref":"#/components/schemas/connection-CprJdVPV"},"created_at":{"$ref":"#/components/schemas/timestamp"},"ip_address":{"$ref":"#/components/schemas/ip-ibmclV7b"},"ray_id":{"$ref":"#/components/schemas/ray_id"},"user_email":{"$ref":"#/components/schemas/email"}},"type":"object"},"access-requests-X9B1uf1S":{"properties":{"action":{"$ref":"#/components/schemas/access-requests_components-schemas-action"},"allowed":{"$ref":"#/components/schemas/schemas-allowed"},"app_domain":{"$ref":"#/components/schemas/app_domain"},"app_uid":{"$ref":"#/components/schemas/app_uid"},"connection":{"$ref":"#/components/schemas/schemas-connection"},"created_at":{"$ref":"#/components/schemas/timestamp"},"ip_address":{"$ref":"#/components/schemas/schemas-ip"},"ray_id":{"$ref":"#/components/schemas/ray_id"},"user_email":{"$ref":"#/components/schemas/schemas-email-EQUZrKsL"}},"type":"object"},"access-requests_components-schemas-action":{"description":"The event that occurred, such as a login attempt.","example":"login","type":"string"},"access-requests_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/access-requests-X9B1uf1S"},"type":"array"}}}]},"accessRules":{"description":"Defines rules for fine-grained control over content than signed URL tokens alone. Access rules primarily make tokens conditionally valid based on user information. Access Rules are specified on token payloads as the `accessRules` property containing an array of Rule objects.","properties":{"action":{"description":"The action to take when a request matches a rule. If the action is `block`, the signed token blocks views for viewers matching the rule.","enum":["allow","block"],"example":"allow","readOnly":true,"type":"string"},"country":{"description":"An array of 2-letter country codes in ISO 3166-1 Alpha-2 format used to match requests.","items":{"type":"string"},"readOnly":true,"type":"array"},"ip":{"description":"An array of IPv4 or IPV6 addresses or CIDRs used to match requests.","items":{"type":"string"},"readOnly":true,"type":"array"},"type":{"description":"Lists available rule types to match for requests. An `any` type matches all requests and can be used as a wildcard to apply default actions after other rules.","enum":["any","ip.src","ip.geoip.country"],"example":"ip.src","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"},"access_group_rule":{"description":"Matches an Access group.","properties":{"group":{"properties":{"id":{"description":"The ID of a previously created Access group.","example":"aa0a4aab-672b-4bdb-bc33-a59f1130a11f","type":"string"}},"required":["id"],"type":"object"}},"required":["group"],"title":"Access groups","type":"object"},"access_seat":{"description":"True if the seat is part of Access.","example":false,"type":"boolean"},"account":{"properties":{"created_on":{"description":"Timestamp for the creation of the account","example":"2014-03-01T12:21:02.0000Z","format":"date-time","readOnly":true,"type":"string"},"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"name":{"description":"Account name","example":"Demo Account","maxLength":100,"type":"string"},"settings":{"description":"Account settings","properties":{"enforce_twofactor":{"default":false,"description":"Indicates whether membership in this account requires that\nTwo-Factor Authentication is enabled","type":"boolean"},"use_account_custom_ns_by_default":{"default":false,"description":"Indicates whether new zones should use the account-level custom\nnameservers by default","type":"boolean"}},"type":"object"}},"required":["id","name"],"type":"object"},"account-settings-response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"properties":{"default_usage_model":{"readOnly":true},"green_compute":{"readOnly":true}},"type":"object"}}}]},"account_identifier":{"$ref":"#/components/schemas/identifier-59LodGbZ"},"account_identifier-D3Kod1Eh":{},"account_identifier-DCAPOmrB":{"example":"01a7362d577a6c3019a474fd6f485823","readOnly":true},"account_identifier-JMTrNzhX":{"$ref":"#/components/schemas/identifier-YhmC5GTP"},"account_identifier-hNAyEE6b":{"$ref":"#/components/schemas/identifier-gI2sCanq"},"account_identifier-u0eFsPPd":{"description":"The account identifier tag.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"account_subscription_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/subscription"},"type":"array"}},"type":"object"}]},"account_subscription_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}},"type":"object"}]},"acl":{"properties":{"id":{"$ref":"#/components/schemas/components-schemas-identifier"},"ip_range":{"$ref":"#/components/schemas/ip_range"},"name":{"$ref":"#/components/schemas/acl_components-schemas-name"}},"required":["id","name","ip_range"],"type":"object"},"acl_components-schemas-name":{"description":"The name of the acl.","example":"my-acl-1","type":"string"},"acns_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/CustomNS"},"type":"array"}},"type":"object"}]},"acns_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/CustomNS"}},"type":"object"}]},"action":{"description":"The action to preform when the associated traffic, identity, and device posture expressions are either absent or evaluate to 'true'.","enum":["on","off","allow","block","scan","noscan","safesearch","ytrestricted","isolate","noisolate","override","l4_override","egress","audit_ssh"],"example":"allow","type":"string"},"action-Ib2HEWrw":{"description":"The event that occurred, such as a login attempt.","example":"login","type":"string"},"action-ypBxWT3F":{"description":"The billing item action.","example":"subscription","maxLength":30,"readOnly":true,"type":"string"},"action_mode":{"default":"challenge","description":"The default action performed by the rules in the WAF package.","enum":["simulate","block","challenge"],"type":"string"},"action_parameters":{"description":"The parameters configuring the rule action.","example":{"id":"4814384a9e5d4991b9815dcfc25d2f1f"},"type":"object"},"action_parameters_redirect":{"description":"The configuration parameters for the redirect action.","properties":{"from_value":{"description":"The parameters that control the redirect.","properties":{"preserve_query_string":{"description":"Whether the query string for the request should be carried to the redirect's target url.","example":true,"type":"boolean"},"status_code":{"description":"The status code to use for the redirect.","type":"integer"},"target_url":{"oneOf":[{"properties":{"expression":{"description":"An expression defining a dynamic value for the target url of the redirect.","example":"concat(http.request.full_uri, \"/latest\")","type":"string"}},"type":"object"},{"properties":{"value":{"description":"The value defining the target url of the redirect.","example":"https://example.com/blog/latest","type":"string"}},"type":"object"}]}},"type":"object"}}},"action_parameters_rewrite":{"description":"The configuration parameters for the rewrite action.","properties":{"uri":{"description":"The URI rewrite configuration to rewrite the URI path, the query string, or both.","properties":{"path":{"description":"The new URI path sent to the origin."},"query":{"description":"The new query string sent to the origin."}},"type":"object"}}},"action_parameters_route":{"description":"The configuration parameters for the route action.","properties":{"host_header":{"description":"The value of the Host header.","example":"foo.example.com","type":"string"},"origin":{"description":"The parameters that control where the origin is.","properties":{"host":{"description":"The host to use for origin.","example":"foo.example.com","type":"string"},"port":{"description":"The port to use for origin.","type":"integer"}},"type":"object"},"sni":{"description":"The parameters that control the SNI.","properties":{"value":{"description":"The SNI used to connect to the origin.","example":"foo.example.com","type":"string"}},"type":"object"}}},"action_parameters_serve_error":{"description":"The action parameters for the serve_error action.","properties":{"content":{"description":"The new content for the response error.","example":"some html error page","type":"string"},"content_type":{"description":"The content-type of the response error.","example":"text/html","type":"string"},"status_code":{"description":"The HTTP status code of the response error.","example":530,"type":"number"}}},"action_parameters_set_cache_settings":{"description":"The configuration parameters for the set_cache_settings action.","properties":{"browser_ttl":{"description":"Set the Browser TTL.","properties":{"default":{"type":"integer"},"mode":{"example":"override_origin","type":"string"}},"type":"object"},"cache_key":{"description":"Set the Cache TTL.","properties":{"cache_deception_armor":{"example":true,"type":"boolean"},"custom_key":{"properties":{"cookie":{"properties":{"check_presence":{"example":["cookie_1"],"items":{},"type":"array"},"include":{"example":["cookie1"],"items":{},"type":"array"}},"type":"object"},"header":{"properties":{"check_presence":{"example":["header_1"],"items":{},"type":"array"},"include":{"example":["header1"],"items":{},"type":"array"}},"type":"object"},"host":{"properties":{"resolved":{"example":false,"type":"boolean"}},"type":"object"},"query_string":{"properties":{"include":{"example":"*","type":"string"}},"type":"object"},"user":{"properties":{"device_type":{"example":true,"type":"boolean"},"geo":{"example":false,"type":"boolean"},"lang":{"example":false,"type":"boolean"}},"type":"object"}},"type":"object"},"ignore_query_strings_order":{"example":true,"type":"boolean"}},"type":"object"},"edge_ttl":{"description":"Set the Cache TTL.","properties":{"mode":{"example":"respect_origin","type":"string"},"status_code_ttl":{"properties":{"status_code":{"type":"integer"},"value":{"type":"integer"}},"type":"object"}},"type":"object"},"origin_error_page_passthru":{"example":true,"type":"boolean"},"respect_strong_etags":{"example":true,"type":"boolean"},"serve_stale":{"properties":{"disable_stale_while_updating":{"example":true,"type":"boolean"}},"type":"object"}}},"action_parameters_set_config":{"description":"The configuration parameters for the set_config action.","properties":{"automatic_https_rewrites":{"description":"Enable or disable Automatic HTTPS Rewrites for matching requests","example":true,"type":"boolean"},"autominify":{"description":"Select which file extensions to minify automatically.","properties":{"css":{"example":true,"type":"boolean"},"html":{"example":true,"type":"boolean"},"js":{"example":true,"type":"boolean"}},"type":"object"},"bic":{"description":"Enable or disable Browser Integrity Check","example":true,"type":"boolean"},"disable_apps":{"description":"Disable all active Cloudflare Apps","example":true,"type":"boolean"},"disable_railgun":{"description":"Disable Cloudflare Railgun","example":true,"type":"boolean"},"disable_zaraz":{"description":"Disable Cloudflare Railgun","example":true,"type":"boolean"},"email_obfuscation":{"description":"Enable or disable Email Obfuscation","example":false,"type":"boolean"},"hotlink_protection":{"description":"Enable or disable Hotlink Protection","example":false,"type":"boolean"},"mirage":{"description":"Enable or disable Mirage","example":false,"type":"boolean"},"opportunistic_encryption":{"description":"Enable or disableOpportunistic Encryption","example":false,"type":"boolean"},"polish":{"description":"Set Polish compression options","example":"lossless","type":"string"},"rocket_loader":{"description":"Enable or disable Rocket Loader","example":false,"type":"boolean"},"security_level":{"description":"Set the Security Level","example":"low","type":"string"},"server_side_excludes":{"description":"Enable or disable Server Side Excludes","example":false,"type":"boolean"},"ssl":{"description":"Select the SSL encryption mode","example":"flexible","type":"string"},"sxg":{"description":"Enable or disable Signed Exchangesn(SXG)","example":false,"type":"boolean"}}},"actions":{"description":"The set of actions to perform if the targets of this rule match the request. Actions can redirect to another URL or override settings, but not both.","example":[{"id":"browser_check","value":"on"}],"items":{"oneOf":[{"$ref":"#/components/schemas/route-k62zYPUS"}]},"type":"array"},"activated_on":{"description":"When the Railgun was activated.","example":"2014-01-02T02:20:00Z","format":"date-time","readOnly":true,"type":"string"},"activation":{"properties":{"activated_on":{"$ref":"#/components/schemas/activated_on"},"key":{"$ref":"#/components/schemas/activation_key"},"version":{"properties":{"build":{"$ref":"#/components/schemas/build"},"number":{"$ref":"#/components/schemas/components-schemas-version"},"revision":{"$ref":"#/components/schemas/revision"}},"required":["number"],"type":"object"}},"readOnly":true,"required":["key"],"type":"object"},"activation_key":{"example":"e4edc00281cb56ebac22c81be9bac8f3","maxLength":32,"readOnly":true,"type":"string"},"active_device_count":{"description":"The number of active devices registered to the user.","example":2,"type":"number"},"activity-log-settings":{"description":"Activity log settings.","properties":{"enabled":{"description":"Enable activity logging.","example":true,"type":"boolean"}},"type":"object"},"adaptive_routing":{"description":"Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.","properties":{"failover_across_pools":{"default":false,"description":"Extends zero-downtime failover of requests to healthy origins from alternate pools, when no healthy alternate exists in the same pool, according to the failover order defined by traffic and origin steering. When set false (the default) zero-downtime failover will only occur between origins within the same pool. See `session_affinity_attributes` for control over when sessions are broken or reassigned.","example":true,"type":"boolean"}},"type":"object"},"additional_information":{"description":"Additional information related to the host name.","properties":{"suspected_malware_family":{"description":"Suspected DGA malware family.","example":"","type":"string"}},"type":"object"},"address":{"description":"The hostname or IP address of the origin server to run health checks on.","example":"www.example.com","type":"string"},"address-95deJOax":{"description":"The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare. To set an internal/reserved address, virtual_network_id must also be set.","example":"0.0.0.0","type":"string"},"address-SVXLSyuc":{"description":"The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare. To set an internal/reserved address, virtual_network_id must also be set.","example":"0.0.0.0","type":"string"},"address-maps":{"properties":{"can_delete":{"$ref":"#/components/schemas/can_delete"},"can_modify_ips":{"$ref":"#/components/schemas/can_modify_ips"},"created_at":{"$ref":"#/components/schemas/timestamp"},"default_sni":{"$ref":"#/components/schemas/default_sni"},"description":{"$ref":"#/components/schemas/schemas-description-Fsn87iOz"},"enabled":{"$ref":"#/components/schemas/enabled-i0fFiRwL"},"id":{"$ref":"#/components/schemas/identifier-v0xEcFCj"},"modified_at":{"$ref":"#/components/schemas/timestamp"}},"type":"object"},"address-maps-ip":{"properties":{"created_at":{"$ref":"#/components/schemas/timestamp"},"ip":{"$ref":"#/components/schemas/ip-8QKcCQCp"}},"type":"object"},"address-maps-ip-spXX1kUy":{"properties":{"created_at":{"$ref":"#/components/schemas/created-on"},"ip":{"$ref":"#/components/schemas/ip-gs35mKhq"}},"type":"object"},"address-maps-ldXASIMl":{"properties":{"can_delete":{"$ref":"#/components/schemas/can_delete"},"can_modify_ips":{"$ref":"#/components/schemas/can_modify_ips"},"created_at":{"$ref":"#/components/schemas/timestamp"},"default_sni":{"$ref":"#/components/schemas/default_sni"},"description":{"$ref":"#/components/schemas/address-maps_components-schemas-description"},"enabled":{"$ref":"#/components/schemas/address-maps_components-schemas-enabled"},"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"modified_at":{"$ref":"#/components/schemas/timestamp"}},"type":"object"},"address-maps-membership":{"properties":{"can_delete":{"$ref":"#/components/schemas/schemas-can_delete"},"created_at":{"$ref":"#/components/schemas/timestamp"},"identifier":{"$ref":"#/components/schemas/identifier-v0xEcFCj"},"kind":{"$ref":"#/components/schemas/kind"}},"type":"object"},"address-maps-membership-upHJKSmv":{"properties":{"can_delete":{"$ref":"#/components/schemas/schemas-can_delete"},"created_at":{"$ref":"#/components/schemas/created-on"},"identifier":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"kind":{"$ref":"#/components/schemas/components-schemas-kind"}},"type":"object"},"address-maps_components-schemas-description":{"description":"An optional description field which may be used to describe the types of IPs or zones on the map.","example":"My Ecommerce zones","nullable":true,"type":"string"},"address-maps_components-schemas-enabled":{"default":false,"description":"Whether the Address Map is enabled or not. Cloudflare's DNS will not respond with IP addresses on an Address Map until the map is enabled.","example":true,"nullable":true,"type":"boolean"},"address-maps_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/address-maps-ldXASIMl"},"type":"array"}}}]},"address-maps_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/address-maps-ldXASIMl"}}}]},"address2":{"description":"Optional address line for unit, floor, suite, etc.","example":"Suite 430","type":"string"},"addresses":{"allOf":[{"$ref":"#/components/schemas/destination_address_properties"}],"type":"object"},"advanced_certificate_pack_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"certificate_authority":{"$ref":"#/components/schemas/schemas-certificate_authority"},"cloudflare_branding":{"$ref":"#/components/schemas/cloudflare_branding"},"hosts":{"$ref":"#/components/schemas/schemas-hosts"},"id":{"$ref":"#/components/schemas/identifier-tZwYoMuc"},"status":{"$ref":"#/components/schemas/certificate-packs_components-schemas-status"},"type":{"$ref":"#/components/schemas/advanced_type"},"validation_method":{"$ref":"#/components/schemas/validation_method"},"validity_days":{"$ref":"#/components/schemas/validity_days"}},"type":"object"}},"type":"object"}]},"advanced_certificate_pack_response_single-M4alsr79":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"certificate_authority":{"$ref":"#/components/schemas/certificate_authority-VxFhhbhi"},"cloudflare_branding":{"$ref":"#/components/schemas/cloudflare_branding"},"hosts":{"$ref":"#/components/schemas/schemas-hosts"},"id":{"$ref":"#/components/schemas/certificate-packs_components-schemas-identifier"},"status":{"$ref":"#/components/schemas/certificate-packs_components-schemas-status"},"type":{"$ref":"#/components/schemas/advanced_type"},"validation_method":{"$ref":"#/components/schemas/validation_method"},"validity_days":{"$ref":"#/components/schemas/validity_days"}},"type":"object"}},"type":"object"}]},"advanced_ddos":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["advanced_ddos"],"example":"advanced_ddos"},"value":{"$ref":"#/components/schemas/advanced_ddos_value"}}}],"description":"Advanced protection from Distributed Denial of Service (DDoS) attacks on your website. This is an uneditable value that is 'on' in the case of Business and Enterprise zones.","title":"Advanced DDoS Protection"},"advanced_ddos_value":{"default":"off","description":"Value of the zone setting.\nNotes: Defaults to on for Business+ plans","enum":["on","off"],"type":"string"},"advanced_type":{"description":"Type of certificate pack.","enum":["advanced"],"example":"advanced","type":"string"},"advertised":{"description":"Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled.","example":true,"nullable":true,"type":"boolean"},"advertised_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"advertised":{"$ref":"#/components/schemas/schemas-advertised"},"advertised_modified_at":{"$ref":"#/components/schemas/modified_at_nullable"}},"type":"object"}}}]},"alert-types":{"properties":{"description":{"$ref":"#/components/schemas/alert-types_components-schemas-description"},"display_name":{"$ref":"#/components/schemas/display_name"},"filter_options":{"$ref":"#/components/schemas/schemas-filter_options"},"type":{"$ref":"#/components/schemas/alert-types_components-schemas-type"}},"type":"object"},"alert-types_components-schemas-description":{"description":"Describes the alert type.","example":"High levels of 5xx HTTP errors at your origin","type":"string"},"alert-types_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"additionalProperties":{"items":{"$ref":"#/components/schemas/alert-types"},"type":"array"},"example":{"Origin Monitoring":[{"description":"High levels of 5xx HTTP errors at your origin.","display_name":"Origin Error Rate Alert","filter_options":[{"ComparisonOperator":"==","Key":"zones","Optional":false},{"ComparisonOperator":"\u003e=","Key":"slo","Optional":true}],"type":"http_alert_origin_error"}]},"type":"object"}}}]},"alert-types_components-schemas-type":{"description":"Use this value when creating and updating a notification policy.","example":"http_alert_origin_error","type":"string"},"alert_body":{"description":"Message body included in the notification sent.","example":"SSL certificate has expired","type":"string"},"alert_type":{"description":"Refers to which event will trigger a Notification dispatch. You can use the endpoint to get available alert types which then will give you a list of possible values.","example":"universal_ssl_event_type","type":"string"},"algo":{"description":"TSIG algorithm.","example":"hmac-sha512.","type":"string"},"algorithm":{"description":"Algorithm key code.","example":"13","nullable":true,"readOnly":true,"type":"string"},"allow_all_headers":{"description":"Allows all HTTP request headers.","example":true,"type":"boolean"},"allow_all_methods":{"description":"Allows all HTTP request methods.","type":"boolean"},"allow_all_origins":{"description":"Allows all origins.","type":"boolean"},"allow_credentials":{"description":"When set to `true`, includes credentials (cookies, authorization headers, or TLS client certificates) with requests.","type":"boolean"},"allow_insecure":{"default":false,"description":"Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.","example":true,"type":"boolean"},"allow_mode_switch":{"description":"Whether to allow the user to switch WARP between modes.","example":true,"type":"boolean"},"allow_null_cipher":{"description":"When `true`, the tunnel can use a null-cipher (`ENCR_NULL`) in the ESP tunnel (Phase 2).","example":true,"type":"boolean"},"allow_updates":{"description":"Whether to receive update notifications when a new version of the client is available.","example":true,"type":"boolean"},"allowed":{"default":false,"description":"The result of the authentication event.","type":"boolean"},"allowed-r2rT3jf5":{"description":"Cloudflare Images allowed usage.","example":100000,"readOnly":true,"type":"number"},"allowedOrigins":{"description":"Lists the origins allowed to display the video. Enter allowed origin domains in an array and use `*` for wildcard subdomains. Empty arrays allow the video to be viewed on any origin.","example":["example.com"],"items":{"type":"string"},"type":"array"},"allowed_headers":{"description":"Allowed HTTP request headers.","items":{},"type":"array"},"allowed_idps":{"description":"The identity providers your users can select when connecting to this application. Defaults to all IdPs configured in your account.","items":{"description":"The identity providers selected for application.","example":"699d98642c564d2e855e9661899b7252","type":"string"},"type":"array"},"allowed_match_count":{"default":0,"description":"Related DLP policies will trigger when the match count exceeds the number set.","example":5,"maximum":1000,"minimum":0,"type":"number"},"allowed_methods":{"description":"Allowed HTTP request methods.","example":["GET"],"items":{"enum":["GET","POST","HEAD","PUT","DELETE","CONNECT","OPTIONS","TRACE","PATCH"],"type":"string"},"type":"array"},"allowed_modes":{"description":"The available states for the rule group.","example":["on","off"],"items":{"$ref":"#/components/schemas/components-schemas-mode"},"readOnly":true,"type":"array"},"allowed_modes_allow_traditional":{"description":"Defines the available modes for the current WAF rule.","example":["on","off"],"items":{"$ref":"#/components/schemas/mode_allow_traditional"},"readOnly":true,"type":"array"},"allowed_modes_anomaly":{"description":"Defines the available modes for the current WAF rule. Applies to anomaly detection WAF rules.","example":["on","off"],"items":{"$ref":"#/components/schemas/mode_anomaly"},"readOnly":true,"type":"array"},"allowed_modes_deny_traditional":{"description":"The list of possible actions of the WAF rule when it is triggered.","example":["default","disable","simulate","block","challenge"],"items":{"$ref":"#/components/schemas/mode_deny_traditional"},"readOnly":true,"type":"array"},"allowed_origins":{"description":"Allowed origins.","example":["https://example.com"],"items":{},"type":"array"},"allowed_to_leave":{"description":"Whether to allow devices to leave the organization.","example":true,"type":"boolean"},"always_online":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["always_online"],"example":"always_online"},"value":{"$ref":"#/components/schemas/always_online_value"}}}],"description":"When enabled, Cloudflare serves limited copies of web pages available from the [Internet Archive's Wayback Machine](https://archive.org/web/) if your server is offline. Refer to [Always Online](https://developers.cloudflare.com/cache/about/always-online) for more information.","title":"Always Online Mode"},"always_online_value":{"default":"on","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"always_use_https":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["always_use_https"],"example":"always_use_https"},"value":{"$ref":"#/components/schemas/always_use_https_value"}}}],"default":"off","description":"Reply to all requests for URLs that use \"http\" with a 301 redirect to the equivalent \"https\" URL. If you only want to redirect for a subset of requests, consider creating an \"Always use HTTPS\" page rule.","title":"Zone Enable Always Use HTTPS"},"always_use_https_value":{"default":"off","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"amount":{"description":"The amount associated with this billing item.","example":20.99,"readOnly":true,"type":"number"},"analytics":{"properties":{"id":{"default":1,"type":"integer"},"origins":{"example":[{"address":"198.51.100.4","changed":true,"enabled":true,"failure_reason":"No failures","healthy":true,"ip":"198.51.100.4","name":"some-origin"}],"items":{},"type":"array"},"pool":{"example":{"changed":true,"healthy":true,"id":"74bc6a8b9b0dda3d651707a2928bad0c","minimum_origins":1,"name":"some-pool"},"type":"object"},"timestamp":{"example":"2014-01-01T05:20:00.12345Z","format":"date-time","type":"string"}},"type":"object"},"analytics-aggregate_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"items":{"type":"object"},"type":"array"}}}]},"analytics_components-schemas-identifier":{"example":"17b5962d775c646f3f9725cbc7a53df4"},"analytics_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/analytics"},"type":"array"}}}]},"anomaly_description":{"description":"A summary of the purpose/function of the WAF package.","example":"Covers OWASP Top 10 vulnerabilities and more.","readOnly":true,"type":"string"},"anomaly_detection_mode":{"description":"When a WAF package uses anomaly detection, each rule is given a score when triggered. If the total score of all triggered rules exceeds the sensitivity defined on the WAF package, the action defined on the package will be taken.","example":"anomaly","readOnly":true,"type":"string"},"anomaly_name":{"description":"The name of the WAF package.","example":"OWASP ModSecurity Core Rule Set","readOnly":true,"type":"string"},"anomaly_package":{"allOf":[{"$ref":"#/components/schemas/package_definition"},{"properties":{"action_mode":{"$ref":"#/components/schemas/action_mode"},"description":{"$ref":"#/components/schemas/anomaly_description"},"detection_mode":{"$ref":"#/components/schemas/anomaly_detection_mode"},"name":{"$ref":"#/components/schemas/anomaly_name"},"sensitivity":{"$ref":"#/components/schemas/sensitivity"}}}],"required":["id","name","description","zone_id","detection_mode","sensitivity","action_mode"],"title":"Anomaly detection WAF package (OWASP)"},"anomaly_rule":{"allOf":[{"$ref":"#/components/schemas/rule_components-schemas-base-2"},{"properties":{"allowed_modes":{"$ref":"#/components/schemas/allowed_modes_anomaly"},"mode":{"$ref":"#/components/schemas/mode_anomaly"}}}],"description":"When triggered, anomaly detection WAF rules contribute to an overall threat score that will determine if a request is considered malicious. You can configure the total scoring threshold through the 'sensitivity' property of the WAF package.","required":["id","description","priority","allowed_modes","mode","group","package_id"],"title":"Anomaly detection WAF rule"},"anti-virus-settings":{"description":"Anti virus settings.","properties":{"enabled_download_phase":{"$ref":"#/components/schemas/enabled_download_phase"},"enabled_upload_phase":{"$ref":"#/components/schemas/enabled_upload_phase"},"fail_closed":{"$ref":"#/components/schemas/fail_closed"}},"type":"object"},"api-response-collection":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"items":{},"nullable":true,"type":"array"},"result_info":{"$ref":"#/components/schemas/result_info"}}}],"type":"object"},"api-response-collection-common":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"items":{},"nullable":true,"type":"array"}}}],"type":"object"},"api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/messages"},"messages":{"$ref":"#/components/schemas/messages"},"result":{"anyOf":[{"type":"object"},{"items":{},"type":"array"},{"type":"string"}]},"success":{"description":"Whether the API call was successful","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"api-response-common-failure-3ET5U4FT":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/messages"}],"example":[]},"result":{"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful","example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"api-response-common-failure-C6O0X824":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/messages"}],"example":[{"code":7003,"message":"No route for the URI."}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/messages"}],"example":[]},"result":{"enum":[null],"nullable":true},"success":{"description":"Whether the API call was successful.","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"api-response-common-jkxlh21Y":{"properties":{"errors":{"$ref":"#/components/schemas/messages"},"messages":{"$ref":"#/components/schemas/messages"},"success":{"description":"Whether the API call was successful","example":true,"type":"boolean"}},"required":["success","errors","messages"],"type":"object"},"api-response-single":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"anyOf":[{"type":"object"},{"type":"string"}],"nullable":true}}}],"type":"object"},"api-response-single-id":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/schemas-identifier"}},"required":["id"],"type":"object"}}}],"type":"object"},"api-response-single-id-TFlitJo2":{"allOf":[{"$ref":"#/components/schemas/api-response-common-jkxlh21Y"},{"properties":{"result":{"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/identifier-MZFDye9j"}},"required":["id"],"type":"object"}}}],"type":"object"},"api-response-single-id-u7jsvBJu":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},"required":["id"],"type":"object"}}}],"type":"object"},"api-response-single-ktIvFt8K":{"allOf":[{"$ref":"#/components/schemas/schemas-api-response-common"},{"properties":{"result":{"anyOf":[{"type":"object"},{"type":"string"}]}}}],"type":"object"},"api-shield":{"allOf":[{"$ref":"#/components/schemas/operation"}]},"api_access_enabled":{"description":"Enterprise only. Indicates whether or not API access is enabled specifically for this user on a given account.","example":true,"nullable":true,"type":"boolean"},"app-types":{"oneOf":[{"$ref":"#/components/schemas/application"},{"$ref":"#/components/schemas/application_type"}],"readOnly":true,"type":"object"},"app-types_components-schemas-name":{"description":"The name of the application or application type.","example":"Facebook","type":"string"},"app-types_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/app-types"},"type":"array"}}}]},"app_domain":{"description":"The URL of the Access application.","example":"test.example.com/admin","type":"string"},"app_id":{"description":"The identifier for this application. There is only one application per id.","type":"integer"},"app_id-akwLjhUv":{"example":"699d98642c564d2e855e9661899b7252"},"app_id-yTGvAfYO":{"description":"Application identifier.","example":"ea95132c15732412d22c1476fa83f27a","maxLength":32,"readOnly":true,"type":"string"},"app_id_param":{"description":"Comma-delimited list of Spectrum Application Id(s). If provided, the response will be limited to Spectrum Application Id(s) that match.","example":"ea95132c15732412d22c1476fa83f27a,d122c5f4bb71e25cc9e86ab43b142e2f","type":"string"},"app_launcher_props":{"allOf":[{"$ref":"#/components/schemas/feature_app_props-g2VC0WUC"},{"properties":{"domain":{"example":"authdomain.cloudflareaccess.com","readOnly":true},"name":{"default":"App Launcher","example":"App Launcher","readOnly":true},"type":{"description":"The application type.","example":"app_launcher","type":"string"}}}]},"app_launcher_visible":{"default":true,"description":"Displays the application in the App Launcher.","example":true,"type":"boolean"},"app_type_id":{"description":"The identifier for the type of this application. There can be many applications with the same type. This refers to the `id` of an Application Type that has been returned.","type":"integer"},"app_uid":{"description":"The unique identifier for the Access application.","example":"df7e2w5f-02b7-4d9d-af26-8d1988fca630"},"application":{"properties":{"application_type_id":{"$ref":"#/components/schemas/app_type_id"},"created_at":{"$ref":"#/components/schemas/timestamp"},"id":{"$ref":"#/components/schemas/app_id"},"name":{"$ref":"#/components/schemas/app-types_components-schemas-name"}},"type":"object"},"application-WiomAg5h":{"description":"Application that the hostname belongs to.","properties":{"id":{"type":"integer"},"name":{"example":"CLOUDFLARE","type":"string"}},"type":"object"},"application_type":{"properties":{"created_at":{"$ref":"#/components/schemas/timestamp"},"description":{"description":"A short summary of applications with this type.","example":"Applications used to communicate or collaborate in a business setting.","type":"string"},"id":{"$ref":"#/components/schemas/app_type_id"},"name":{"$ref":"#/components/schemas/app-types_components-schemas-name"}},"type":"object"},"approval_group":{"description":"A group of email addresses that can approve a temporary authentication request.","properties":{"approvals_needed":{"description":"The number of approvals needed to obtain access.","example":1,"minimum":0,"type":"number"},"email_addresses":{"description":"A list of emails that can approve the access request.","example":["test@cloudflare.com","test2@cloudflare.com"],"items":{},"type":"array"},"email_list_uuid":{"description":"The UUID of an re-usable email list.","type":"string"}},"required":["approvals_needed"],"type":"object"},"approval_groups":{"description":"Administrators who can approve a temporary authentication request.","example":[{"approvals_needed":1,"email_addresses":["test1@cloudflare.com","test2@cloudflare.com"]},{"approvals_needed":3,"email_list_uuid":"597147a1-976b-4ef2-9af0-81d5d007fc34"}],"items":{"$ref":"#/components/schemas/approval_group"},"type":"array"},"approval_required":{"default":false,"description":"Requires the user to request access from an administrator at the start of each session.","example":true,"type":"boolean"},"approved":{"description":"Approval state of the prefix (P = pending, V = active).","example":"P","type":"string"},"apps":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props-4oEch10U"},{"$ref":"#/components/schemas/self_hosted_props-pFu7lQyL"}],"title":"Self Hosted Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props-4oEch10U"},{"$ref":"#/components/schemas/saas_props-3mDdjpPa"}],"title":"SaaS Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props-4oEch10U"},{"$ref":"#/components/schemas/ssh_props"}],"title":"Browser SSH Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props-4oEch10U"},{"$ref":"#/components/schemas/vnc_props"}],"title":"Browser VNC Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props-4oEch10U"},{"$ref":"#/components/schemas/app_launcher_props"}],"title":"App Launcher Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props-4oEch10U"},{"$ref":"#/components/schemas/warp_props"}],"title":"Device Enrollment Permissions Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props-4oEch10U"},{"$ref":"#/components/schemas/biso_props"}],"title":"Browser Isolation Permissions Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props-4oEch10U"},{"$ref":"#/components/schemas/bookmark_props"}],"title":"Bookmark application","type":"object"}]},"apps_components-schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/uuid-s0SXln0q"}},"type":"object"}}}]},"apps_components-schemas-name":{"description":"The name of the application.","example":"Admin Site","type":"string"},"apps_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/apps"},"type":"array"}}}]},"apps_components-schemas-response_collection-2":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/schemas-apps-DgI9Bh95"},"type":"array"}}}]},"apps_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/apps"}}}]},"apps_components-schemas-single_response-2":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/schemas-apps-DgI9Bh95"}}}]},"apps_components-schemas-type":{"description":"The application type.","enum":["self_hosted","saas","ssh","vnc","app_launcher","warp","biso","bookmark","dash_sso"],"example":"self_hosted","type":"string"},"arch":{"description":"The cloudflared OS architecture used to establish this connection.","example":"linux_amd64","type":"string"},"argo-tunnel":{"properties":{"connections":{"description":"The tunnel connections between your origin and Cloudflare's edge.","items":{"$ref":"#/components/schemas/components-schemas-connection"},"type":"array"},"created_at":{"$ref":"#/components/schemas/cloudflare-tunnel_components-schemas-created_at"},"deleted_at":{"$ref":"#/components/schemas/deleted_at-5nLnuPfs"},"id":{"$ref":"#/components/schemas/tunnel_id"},"name":{"$ref":"#/components/schemas/tunnel_name"}},"required":["id","name","created_at","connections"],"type":"object"},"argo_smart_routing":{"default":false,"description":"Enables Argo Smart Routing for this application.\nNotes: Only available for TCP applications with traffic_type set to \"direct\".","example":true,"type":"boolean"},"asn":{"description":"Autonomous System Number (ASN) the prefix will be advertised under.","example":209242,"nullable":true,"type":"integer"},"asn-N957CyNV":{"description":"Autonomous System Number (ASN) the prefix will be advertised under.","nullable":true,"type":"integer"},"asn_components-schemas-asn":{"properties":{"asn":{"$ref":"#/components/schemas/components-schemas-asn"},"country":{"$ref":"#/components/schemas/asn_country"},"description":{"$ref":"#/components/schemas/asn_description"},"domain_count":{"type":"integer"},"top_domains":{"example":["example.com"],"items":{"type":"string"},"type":"array"},"type":{"$ref":"#/components/schemas/asn_type"}}},"asn_components-schemas-response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/asn_components-schemas-asn"}}}]},"asn_configuration":{"properties":{"target":{"description":"The configuration target. You must set the target to `asn` when specifying an Autonomous System Number (ASN) in the rule.","enum":["asn"],"example":"asn"},"value":{"description":"The AS number to match.","example":"AS12345","type":"string"}},"title":"An ASN configuration."},"asn_country":{"example":"US","type":"string"},"asn_description":{"example":"CLOUDFLARENET","type":"string"},"asn_type":{"description":"Infrastructure type of this ASN.","enum":["hosting_provider","isp","organization"],"example":"hosting_provider","type":"string"},"associated_hostnames":{"description":"The hostnames of the applications that will use this certificate.","items":{"description":"A fully-qualified domain name (FQDN).","example":"admin.example.com","type":"string"},"type":"array"},"associationObject":{"properties":{"service":{"$ref":"#/components/schemas/service"},"status":{"$ref":"#/components/schemas/mtls-management_components-schemas-status"}}},"association_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/associationObject"},"type":"array"}}}]},"attack_mitigation":{"description":"Attack mitigation settings.","nullable":true,"properties":{"enabled":{"description":"When enabled, random-prefix attacks are automatically mitigated and the origin DNS servers protected.","example":true,"type":"boolean"},"only_when_origin_unhealthy":{"default":true,"description":"Only mitigate attacks when origin servers seem unhealthy.","example":false,"type":"boolean"}},"type":"object"},"aud":{"description":"The Application Audience (AUD) tag. Identifies the application associated with the CA.","example":"737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893","maxLength":64,"readOnly":true,"type":"string"},"audit-logs":{"properties":{"action":{"properties":{"result":{"description":"A boolean that indicates if the action attempted was successful.","example":true,"type":"boolean"},"type":{"description":"A short string that describes the action that was performed.","example":"change_setting","type":"string"}},"type":"object"},"actor":{"properties":{"email":{"description":"The email of the user that performed the action.","example":"michelle@example.com","format":"email","type":"string"},"id":{"description":"The ID of the actor that performed the action. If a user performed the action, this will be their User ID.","example":"f6b5de0326bb5182b8a4840ee01ec774","type":"string"},"ip":{"description":"The IP address of the request that performed the action.","example":"198.41.129.166","type":"string"},"type":{"description":"The type of actor, whether a User, Cloudflare Admin, or an Automated System.","enum":["user","admin","Cloudflare"],"example":"user","type":"string"}},"type":"object"},"id":{"description":"A string that uniquely identifies the audit log.","example":"d5b0f326-1232-4452-8858-1089bd7168ef","type":"string"},"interface":{"description":"The source of the event.","example":"API","type":"string"},"metadata":{"description":"An object which can lend more context to the action being logged. This is a flexible value and varies between different actions.","example":{"name":"security_level","type":"firewall","value":"high","zone_name":"example.com"},"type":"object"},"newValue":{"description":"The new value of the resource that was modified.","example":"low","type":"string"},"oldValue":{"description":"The value of the resource before it was modified.","example":"high","type":"string"},"owner":{"properties":{"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},"type":"object"},"resource":{"properties":{"id":{"description":"An identifier for the resource that was affected by the action.","example":"023e105f4ecef8ad9ca31a8372d0c353","type":"string"},"type":{"description":"A short string that describes the resource that was affected by the action.","example":"zone","type":"string"}},"type":"object"},"when":{"description":"A UTC RFC3339 timestamp that specifies when the action being logged occured.","example":"2017-04-26T17:31:07Z","format":"date-time","type":"string"}},"type":"object"},"audit_logs_response_collection":{"oneOf":[{"properties":{"errors":{"nullable":true},"messages":{"example":[],"items":{},"type":"array"},"result":{"items":{"$ref":"#/components/schemas/audit-logs"},"type":"array"},"success":{"example":true,"type":"boolean"}}},{"$ref":"#/components/schemas/api-response-common"}]},"auth_domain":{"description":"The unique subdomain assigned to your Zero Trust organization.","example":"test.cloudflareaccess.com","type":"string"},"auth_id_tokens":{"description":"The total number of auth-ids seen across this calculation.","readOnly":true,"type":"integer"},"auto_connect":{"description":"The amount of time in minutes to reconnect after having been disabled.","example":0,"type":"number"},"auto_redirect_to_identity":{"default":false,"description":"When set to `true`, users skip the identity provider selection step during login.","type":"boolean"},"auto_redirect_to_identity-zRTYoQOC":{"default":false,"description":"When set to `true`, users skip the identity provider selection step during login. You must specify only one identity provider in allowed_idps.","type":"boolean"},"auto_refresh_seconds":{"description":"How often should a secondary zone auto refresh regardless of DNS NOTIFY.\nNot applicable for primary zones.","example":86400,"type":"number"},"auto_renew":{"description":"Auto-renew controls whether subscription is automatically renewed upon domain expiration.","example":true,"type":"boolean"},"automatic_https_rewrites":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["automatic_https_rewrites"],"example":"automatic_https_rewrites"},"value":{"$ref":"#/components/schemas/automatic_https_rewrites_value"}}}],"default":"off","description":"Enable the Automatic HTTPS Rewrites feature for this zone.","title":"Zone Enable Automatic HTTPS Rewrites"},"automatic_https_rewrites_value":{"default":"on","description":"Value of the zone setting.\nNotes: Default value depends on the zone's plan level.","enum":["on","off"],"type":"string"},"automatic_platform_optimization":{"properties":{"cache_by_device_type":{"description":"Indicates whether or not [cache by device type](https://developers.cloudflare.com/automatic-platform-optimization/reference/cache-device-type/) is enabled.","example":false,"type":"boolean"},"cf":{"default":false,"description":"Indicates whether or not Cloudflare proxy is enabled.","example":true,"type":"boolean"},"enabled":{"default":false,"description":"Indicates whether or not Automatic Platform Optimization is enabled.","example":true,"type":"boolean"},"hostnames":{"description":"An array of hostnames where Automatic Platform Optimization for WordPress is activated.","example":["www.example.com","example.com","shop.example.com"],"items":{"format":"hostname","type":"string"},"type":"array"},"wordpress":{"default":false,"description":"Indicates whether or not site is powered by WordPress.","example":true,"type":"boolean"},"wp_plugin":{"default":false,"description":"Indicates whether or not [Cloudflare for WordPress plugin](https://wordpress.org/plugins/cloudflare/) is installed.","example":true,"type":"boolean"}},"required":["enabled","cf","wordpress","wp_plugin","hostnames","cache_by_device_type"],"type":"object"},"availability_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"description":"Name of zone based on which account custom nameservers can be created. For example, if example.com is returned, then ns1.example.com can be used as an account custom nameserver.","example":"example.com","format":"hostname","readOnly":true,"type":"string"},"type":"array"}},"type":"object"}]},"available":{"description":"When true, the Managed Transform is available in the current Cloudflare plan.","example":true,"type":"boolean"},"available-rate-plan":{"properties":{"can_subscribe":{"$ref":"#/components/schemas/can_subscribe"},"currency":{"$ref":"#/components/schemas/currency"},"externally_managed":{"$ref":"#/components/schemas/externally_managed"},"frequency":{"$ref":"#/components/schemas/schemas-frequency"},"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"is_subscribed":{"$ref":"#/components/schemas/is_subscribed"},"legacy_discount":{"$ref":"#/components/schemas/legacy_discount"},"legacy_id":{"$ref":"#/components/schemas/legacy_id"},"name":{"$ref":"#/components/schemas/rate-plan_components-schemas-name"},"price":{"$ref":"#/components/schemas/schemas-price"}},"type":"object"},"azureAD":{"allOf":[{"$ref":"#/components/schemas/identity-provider"},{"properties":{"config":{"allOf":[{"$ref":"#/components/schemas/generic-oauth-config"},{"properties":{"directory_id":{"description":"Your Azure directory uuid","example":"\u003cyour azure directory uuid\u003e","type":"string"},"support_groups":{"description":"Should Cloudflare try to load groups from your account","type":"boolean"}},"type":"object"}]}},"type":"object"}],"title":"Azure AD","type":"object"},"azure_group_rule":{"description":"Matches an Azure group.\nRequires an Azure identity provider.","properties":{"azureAD":{"properties":{"connection_id":{"description":"The ID of your Azure identity provider.","example":"ea85612a-29c8-46c2-bacb-669d65136971","type":"string"},"id":{"description":"The ID of an Azure group.","example":"aa0a4aab-672b-4bdb-bc33-a59f1130a11f","type":"string"}},"required":["id","connection_id"],"type":"object"}},"required":["azureAD"],"title":"Azure group","type":"object"},"bandwidth":{"description":"Breakdown of totals for bandwidth in the form of bytes.","properties":{"all":{"description":"The total number of bytes served within the time frame.","type":"integer"},"cached":{"description":"The number of bytes that were cached (and served) by Cloudflare.","type":"integer"},"content_type":{"description":"A variable list of key/value pairs where the key represents the type of content served, and the value is the number in bytes served.","example":{"css":237421,"gif":1234242,"html":1231290,"javascript":123245,"jpeg":784278},"type":"object"},"country":{"description":"A variable list of key/value pairs where the key is a two-digit country code and the value is the number of bytes served to that country.","example":{"AG":2342483,"GI":984753,"US":123145433},"type":"object"},"ssl":{"description":"A break down of bytes served over HTTPS.","properties":{"encrypted":{"description":"The number of bytes served over HTTPS.","type":"integer"},"unencrypted":{"description":"The number of bytes served over HTTP.","type":"integer"}},"type":"object"},"ssl_protocols":{"description":"A breakdown of requests by their SSL protocol.","properties":{"TLSv1":{"description":"The number of requests served over TLS v1.0.","type":"integer"},"TLSv1.1":{"description":"The number of requests served over TLS v1.1.","type":"integer"},"TLSv1.2":{"description":"The number of requests served over TLS v1.2.","type":"integer"},"TLSv1.3":{"description":"The number of requests served over TLS v1.3.","type":"integer"},"none":{"description":"The number of requests served over HTTP.","type":"integer"}},"type":"object"},"uncached":{"description":"The number of bytes that were fetched and served from the origin server.","type":"integer"}},"type":"object"},"bandwidth_by_colo":{"description":"Breakdown of totals for bandwidth in the form of bytes.","properties":{"all":{"description":"The total number of bytes served within the time frame.","type":"integer"},"cached":{"description":"The number of bytes that were cached (and served) by Cloudflare.","type":"integer"},"uncached":{"description":"The number of bytes that were fetched and served from the origin server.","type":"integer"}},"type":"object"},"base":{"properties":{"comment":{"$ref":"#/components/schemas/comment"},"created_on":{"description":"When the record was created.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string"},"id":{"$ref":"#/components/schemas/identifier-zpETYDGh"},"locked":{"description":"Whether this record can be modified/deleted (true means it's managed by Cloudflare).","example":false,"readOnly":true,"type":"boolean"},"meta":{"description":"Extra Cloudflare-specific information about the record.","properties":{"auto_added":{"description":"Will exist if Cloudflare automatically added this DNS record during initial setup.","example":true,"type":"boolean"},"source":{"description":"Where the record originated from.","example":"primary","type":"string"}},"readOnly":true,"type":"object"},"modified_on":{"description":"When the record was last modified.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string"},"proxiable":{"description":"Whether the record can be proxied by Cloudflare or not.","example":true,"readOnly":true,"type":"boolean"},"tags":{"$ref":"#/components/schemas/tags"},"ttl":{"$ref":"#/components/schemas/ttl-Us5Qprrb"},"zone_id":{"$ref":"#/components/schemas/identifier-zpETYDGh"},"zone_name":{"description":"The domain of the record.","example":"example.com","format":"hostname","readOnly":true,"type":"string"}}},"base-bSfRyaRZ":{"properties":{"expires_on":{"$ref":"#/components/schemas/schemas-expires_on-SFzDZ8Kt"},"id":{"$ref":"#/components/schemas/invite_components-schemas-identifier"},"invited_by":{"$ref":"#/components/schemas/invited_by"},"invited_member_email":{"$ref":"#/components/schemas/invited_member_email"},"invited_member_id":{"description":"ID of the user to add to the organization.","example":"5a7805061c76ada191ed06f989cc3dac","maxLength":32,"nullable":true,"readOnly":true,"type":"string"},"invited_on":{"$ref":"#/components/schemas/invited_on"},"organization_id":{"description":"ID of the organization the user will be added to.","example":"5a7805061c76ada191ed06f989cc3dac","maxLength":32,"readOnly":true,"type":"string"},"organization_name":{"description":"Organization name.","example":"Cloudflare, Inc.","maxLength":100,"readOnly":true,"type":"string"},"roles":{"description":"Roles to be assigned to this user.","items":{"$ref":"#/components/schemas/schemas-role"},"type":"array"}},"required":["invited_member_id","organization_id"],"type":"object"},"base-cc0u02EK":{"properties":{"created_on":{"description":"When the Keyless SSL was created.","example":"2014-01-01T05:20:00Z","format":"date-time","readOnly":true,"type":"string"},"enabled":{"$ref":"#/components/schemas/enabled-uhOFAV56"},"host":{"$ref":"#/components/schemas/host-EEtGIG7W"},"id":{"$ref":"#/components/schemas/schemas-identifier-f8xN4YrK"},"modified_on":{"description":"When the Keyless SSL was last modified.","example":"2014-01-01T05:20:00Z","format":"date-time","readOnly":true,"type":"string"},"name":{"$ref":"#/components/schemas/name-VvYEM0tR"},"permissions":{"description":"Available permissions for the Keyless SSL for the current user requesting the item.","example":["#ssl:read","#ssl:edit"],"items":{},"readOnly":true,"type":"array"},"port":{"$ref":"#/components/schemas/port-z0PISaVA"},"status":{"$ref":"#/components/schemas/schemas-status"},"tunnel":{"$ref":"#/components/schemas/keyless_tunnel"}},"required":["id","name","host","port","status","enabled","permissions","created_on","modified_on"],"type":"object"},"base-ozkeixvx":{"properties":{"editable":{"default":true,"description":"Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).","enum":[true,false],"readOnly":true,"type":"boolean"},"id":{"description":"Identifier of the zone setting.","example":"development_mode","type":"string"},"modified_on":{"description":"last time this setting was modified.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"value":{"description":"Current value of the zone setting.","example":"on"}},"required":["id","value"]},"basic_app_response_props":{"properties":{"aud":{"$ref":"#/components/schemas/schemas-aud"},"created_at":{"$ref":"#/components/schemas/timestamp"},"id":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"},"updated_at":{"$ref":"#/components/schemas/timestamp"}},"type":"object"},"basic_app_response_props-4oEch10U":{"properties":{"aud":{"$ref":"#/components/schemas/schemas-aud"},"created_at":{"$ref":"#/components/schemas/timestamp"},"id":{"$ref":"#/components/schemas/uuid-s0SXln0q"},"updated_at":{"$ref":"#/components/schemas/timestamp"}},"type":"object"},"batch_size":{"example":10,"type":"number"},"before":{"description":"Limit the returned results to history records older than the specified date. This must be a timestamp that conforms to RFC3339.","example":"2022-05-20T20:29:58.679897Z","format":"date-time","type":"string"},"beta":{"description":"Whether the category is in beta and subject to change.","example":false,"type":"boolean"},"billing-history":{"properties":{"action":{"$ref":"#/components/schemas/action-ypBxWT3F"},"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"description":{"$ref":"#/components/schemas/schemas-description-MUzoo3Z3"},"id":{"$ref":"#/components/schemas/billing-history_components-schemas-identifier"},"occurred_at":{"$ref":"#/components/schemas/occurred_at"},"type":{"$ref":"#/components/schemas/type-52Dm78wx"},"zone":{"$ref":"#/components/schemas/schemas-zone"}},"required":["id","type","action","description","occurred_at","amount","currency","zone"],"type":"object"},"billing-history_components-schemas-identifier":{"description":"Billing item identifier tag.","example":"b69a9f3492637782896352daae219e7d","maxLength":32,"readOnly":true,"type":"string"},"billing_history_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/billing-history"},"type":"array"}}}]},"billing_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}},"type":"object"}]},"binding":{"oneOf":[{"$ref":"#/components/schemas/kv_namespace_binding"},{"$ref":"#/components/schemas/wasm_module_binding"}]},"binding_name":{"description":"A JavaScript variable name for the binding.","example":"myBinding","readOnly":true,"type":"string"},"biso_props":{"allOf":[{"$ref":"#/components/schemas/feature_app_props-g2VC0WUC"},{"properties":{"domain":{"example":"authdomain.cloudflareaccess.com/browser","readOnly":true},"name":{"default":"Clientless Web Isolation","example":"Clientless Web Isolation","readOnly":true},"type":{"description":"The application type.","example":"biso","type":"string"}}}]},"block-page-settings":{"description":"Block page layout settings.","properties":{"background_color":{"description":"Block page background color in #rrggbb format.","type":"string"},"enabled":{"description":"Enable only cipher suites and TLS versions compliant with FIPS 140-2.","example":true,"type":"boolean"},"footer_text":{"description":"Block page footer text.","example":"--footer--","type":"string"},"header_text":{"description":"Block page header text.","example":"--header--","type":"string"},"logo_path":{"description":"Full URL to the logo file.","example":"https://logos.com/a.png","type":"string"},"mailto_address":{"description":"Admin email for users to contact.","example":"admin@example.com","type":"string"},"mailto_subject":{"description":"Subject line for emails created from block page.","example":"Blocked User Inquiry","type":"string"},"name":{"description":"Block page title.","example":"Cloudflare","type":"string"},"suppress_footer":{"description":"Suppress detailed info at the bottom of the block page.","example":false,"type":"boolean"}},"type":"object"},"body":{"description":"The response body to return. The value must conform to the configured content type.","example":"\u003cerror\u003eThis request has been rate-limited.\u003c/error\u003e","maxLength":10240,"type":"string"},"body-scanning-settings":{"description":"DLP body scanning setting","properties":{"inspection_mode":{"description":"Inspection mode. One of deep or shallow","example":"deep","type":"string"}},"type":"object"},"bookmark_props":{"properties":{"app_launcher_visible":{"default":true},"domain":{"description":"The URL or domain of the bookmark.","example":"https://mybookmark.com"},"logo_url":{"$ref":"#/components/schemas/logo_url"},"name":{"$ref":"#/components/schemas/apps_components-schemas-name"},"type":{"description":"The application type.","example":"bookmark","type":"string"}},"title":"Bookmark application","type":"object"},"bookmarks":{"properties":{"app_launcher_visible":{"$ref":"#/components/schemas/schemas-app_launcher_visible"},"created_at":{"$ref":"#/components/schemas/timestamp"},"domain":{"$ref":"#/components/schemas/schemas-domain"},"id":{"description":"The unique identifier for the Bookmark application."},"logo_url":{"$ref":"#/components/schemas/logo_url"},"name":{"$ref":"#/components/schemas/bookmarks_components-schemas-name"},"updated_at":{"$ref":"#/components/schemas/timestamp"}},"type":"object"},"bookmarks-XgcqmQIm":{"properties":{"app_launcher_visible":{"$ref":"#/components/schemas/schemas-app_launcher_visible"},"created_at":{"$ref":"#/components/schemas/timestamp"},"domain":{"$ref":"#/components/schemas/components-schemas-domain"},"id":{"description":"The unique identifier for the Bookmark application."},"logo_url":{"$ref":"#/components/schemas/logo_url"},"name":{"$ref":"#/components/schemas/bookmarks_components-schemas-name"},"updated_at":{"$ref":"#/components/schemas/timestamp"}},"type":"object"},"bookmarks_components-schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/uuid-s0SXln0q"}},"type":"object"}}}]},"bookmarks_components-schemas-name":{"description":"The name of the Bookmark application.","example":"My Website","type":"string"},"bookmarks_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/bookmarks-XgcqmQIm"},"type":"array"}}}]},"bookmarks_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/bookmarks-XgcqmQIm"}}}]},"brand_check":{"description":"Certificate Authority is manually reviewing the order.","example":false,"type":"boolean"},"brotli":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["brotli"],"example":"brotli"},"value":{"$ref":"#/components/schemas/brotli_value"}}}],"description":"When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset.","title":"Brotli Compression"},"brotli_value":{"default":"off","description":"Value of the zone setting.","enum":["off","on"],"type":"string"},"browser-isolation-settings":{"description":"Browser isolation settings.","properties":{"url_browser_isolation_enabled":{"description":"Enable Browser Isolation.","example":true,"type":"boolean"}},"type":"object"},"browser_cache_ttl":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["browser_cache_ttl"],"example":"browser_cache_ttl"},"value":{"$ref":"#/components/schemas/browser_cache_ttl_value"}}}],"description":"Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources will remain on your visitors' computers. Cloudflare will honor any larger times specified by your server. (https://support.cloudflare.com/hc/en-us/articles/200168276).","title":"Browser Cache TTL"},"browser_cache_ttl_value":{"default":14400,"description":"Value of the zone setting.\nNotes: Setting a TTL of 0 is equivalent to selecting `Respect Existing Headers`","enum":[0,30,60,120,300,1200,1800,3600,7200,10800,14400,18000,28800,43200,57600,72000,86400,172800,259200,345600,432000,691200,1382400,2073600,2678400,5356800,16070400,31536000],"type":"number"},"browser_check":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["browser_check"],"example":"browser_check"},"value":{"$ref":"#/components/schemas/browser_check_value"}}}],"description":"Browser Integrity Check is similar to Bad Behavior and looks for common HTTP headers abused most commonly by spammers and denies access to your page. It will also challenge visitors that do not have a user agent or a non standard user agent (also commonly used by abuse bots, crawlers or visitors). (https://support.cloudflare.com/hc/en-us/articles/200170086).","title":"Browser Check"},"browser_check_value":{"default":"on","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"bucket_name":{"description":"Name of the bucket. The name must be greater than 2 and less than 64 characters.","example":"example-bucket","pattern":"^[a-z0-9][a-z0-9-]*[a-z0-9]","type":"string"},"build":{"description":"The build identifier for the Railgun receiver.","example":"b1234","readOnly":true,"type":"string"},"build_config":{"description":"Configs for the project build process.","properties":{"build_command":{"description":"Command used to build project.","example":"npm run build","nullable":true,"type":"string"},"destination_dir":{"description":"Output directory of the build.","example":"build","nullable":true,"type":"string"},"root_dir":{"description":"Directory to run the command.","example":"/","nullable":true,"type":"string"},"web_analytics_tag":{"description":"The classifying tag for analytics.","example":"cee1c73f6e4743d0b5e6bb1a0bcaabcc","nullable":true,"type":"string"},"web_analytics_token":{"description":"The auth token for analytics.","example":"021e1057c18547eca7b79f2516f06o7x","nullable":true,"type":"string"}},"type":"object"},"bulk-operation-response-collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/schemas-operation"}},"type":"object"}]},"bulk_delete":{"items":{"$ref":"#/components/schemas/key_name_bulk"},"type":"array"},"bulk_write":{"items":{"properties":{"base64":{"default":false,"description":"Whether or not the server should base64 decode the value before storing it. Useful for writing values that wouldn't otherwise be valid JSON strings, such as images.","type":"boolean"},"expiration":{"$ref":"#/components/schemas/expiration"},"expiration_ttl":{"$ref":"#/components/schemas/expiration_ttl"},"key":{"$ref":"#/components/schemas/key_name_bulk"},"metadata":{"$ref":"#/components/schemas/list_metadata"},"value":{"description":"A UTF-8 encoded string to be stored, up to 10 MB in length.","example":"Some string","maxLength":10485760,"type":"string"}},"type":"object"},"required":["key","value"],"type":"array"},"bundle_method":{"default":"ubiquitous","description":"A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it.","enum":["ubiquitous","optimal","force"],"example":"ubiquitous","type":"string"},"bypass":{"description":"Criteria specifying when the current rate limit should be bypassed. You can specify that the rate limit should not apply to one or more URLs.","items":{"properties":{"name":{"enum":["url"],"example":"url","type":"string"},"value":{"description":"The URL to bypass.","example":"api.example.com/*","type":"string"}},"type":"object"},"type":"array"},"ca":{"description":"Indicates whether the certificate is a CA or leaf certificate.","example":true,"type":"boolean"},"ca-kzNNh4FQ":{"properties":{"aud":{"$ref":"#/components/schemas/aud"},"id":{"$ref":"#/components/schemas/id-e2D1eWah"},"public_key":{"$ref":"#/components/schemas/public_key-Qrh0Mu1M"}},"type":"object"},"ca_components-schemas-id":{"description":"The ID of the CA.","example":"7eddae4619b50ab1361ba8ae9bd72269a432fea041529ed9","maxLength":48,"readOnly":true,"type":"string"},"ca_components-schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/ca_components-schemas-id"}},"type":"object"}}}]},"ca_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/ca-kzNNh4FQ"},"type":"array"}}}]},"ca_components-schemas-response_collection-PJ4wkR9R":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/schemas-ca"},"type":"array"}}}]},"ca_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"cache-rules_components-schemas-action_parameters":{"description":"The parameters configuring the action.","oneOf":[{"$ref":"#/components/schemas/action_parameters_set_cache_settings"}],"type":"object"},"cache-rules_components-schemas-rule":{"properties":{"action":{"example":"set_cache_settings"},"action_parameters":{"$ref":"#/components/schemas/cache-rules_components-schemas-action_parameters"},"description":{"example":"use the cache settings"},"expression":{"example":"http.cookie contains \"something\""},"id":{"example":"3a03d665bac047339bb530ecb439a90d"},"version":{"example":"1"}}},"cache-rules_components-schemas-ruleset":{"properties":{"description":{"example":""},"id":{"example":"2f2feab2026849078ba485f918791bdc"},"kind":{"example":"zone"},"name":{"example":"default"},"phase":{"example":"http_request_cache_settings"},"rules":{"description":"The rules in the ruleset.","items":{"$ref":"#/components/schemas/cache-rules_components-schemas-rule"},"type":"array"}}},"cache_level":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["cache_level"],"example":"cache_level"},"value":{"$ref":"#/components/schemas/cache_level_value"}}}],"description":"Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). The simplified setting will ignore the query string when delivering a cached resource. The aggressive setting will cache all static resources, including ones with a query string. (https://support.cloudflare.com/hc/en-us/articles/200168256).","title":"Cloudflare Cache Level"},"cache_level_value":{"default":"aggressive","description":"Value of the zone setting.","enum":["aggressive","basic","simplified"],"type":"string"},"cache_reserve":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["cache_reserve"],"example":"cache_reserve"}}}],"description":"Increase cache lifetimes by automatically storing all cacheable files into Cloudflare's persistent object storage buckets. Requires Cache Reserve subscription. Note: using Tiered Cache with Cache Reserve is highly recommended to reduce Reserve operations costs. See the [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve) for more information.","title":"Cache Reserve"},"cache_reserve_response_value":{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/cache_reserve"},{"properties":{"value":{"$ref":"#/components/schemas/cache_reserve_value"}},"required":["value"]}]}}},"cache_reserve_value":{"default":"off","description":"Value of the Cache Reserve zone setting.","enum":["on","off"],"type":"string"},"can_delete":{"description":"If set to false, then the Address Map cannot be deleted via API. This is true for Cloudflare-managed maps.","example":true,"readOnly":true,"type":"boolean"},"can_modify_ips":{"description":"If set to false, then the IPs on the Address Map cannot be modified via the API. This is true for Cloudflare-managed maps.","example":true,"readOnly":true,"type":"boolean"},"can_register":{"description":"Indicates if the domain can be registered as a new domain.","example":false,"type":"boolean"},"can_subscribe":{"default":false,"description":"Indicates whether you can subscribe to this plan.","example":true,"type":"boolean"},"caption_basic_upload":{"properties":{"file":{"description":"The WebVTT file containing the caption or subtitle content.","example":"@/Users/kyle/Desktop/tr.vtt","type":"string"}},"required":["file"],"type":"object"},"captions":{"properties":{"label":{"$ref":"#/components/schemas/label"},"language":{"$ref":"#/components/schemas/language"}},"type":"object"},"captive_portal":{"description":"Turn on the captive portal after the specified amount of time.","example":180,"type":"number"},"catch_all_rule":{"properties":{"actions":{"$ref":"#/components/schemas/rule_catchall-actions"},"enabled":{"$ref":"#/components/schemas/rule_enabled-VMnvyEOL"},"matchers":{"$ref":"#/components/schemas/rule_catchall-matchers"},"name":{"$ref":"#/components/schemas/rule_name"},"tag":{"$ref":"#/components/schemas/rule_identifier-wpFBeqHF"}},"type":"object"},"catch_all_rule_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/catch_all_rule"}}}]},"categories":{"properties":{"beta":{"$ref":"#/components/schemas/beta"},"class":{"$ref":"#/components/schemas/class"},"description":{"$ref":"#/components/schemas/components-schemas-description"},"id":{"$ref":"#/components/schemas/id"},"name":{"$ref":"#/components/schemas/categories_components-schemas-name"},"subcategories":{"description":"All subcategories for this category.","items":{"$ref":"#/components/schemas/subcategory"},"type":"array"}},"readOnly":true,"type":"object"},"categories-YFgu3d0j":{"description":"The categories of the rule.","example":["directory-traversal","header"],"items":{"$ref":"#/components/schemas/category"},"type":"array"},"categories_components-schemas-name":{"description":"The name of the category.","example":"Education","type":"string"},"categories_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/categories"},"type":"array"}}}]},"category":{"description":"A category of the rule.","example":"directory-traversal","type":"string"},"centrify":{"allOf":[{"$ref":"#/components/schemas/identity-provider"},{"properties":{"config":{"allOf":[{"$ref":"#/components/schemas/generic-oauth-config"},{"properties":{"centrify_account":{"description":"Your centrify account url","example":"https://abc123.my.centrify.com/","type":"string"},"centrify_app_id":{"description":"Your centrify app id","example":"exampleapp","type":"string"}},"type":"object"}]}},"type":"object"}],"title":"Centrify","type":"object"},"cert_id":{"description":"Certificate identifier tag.","example":"2458ce5a-0c35-4c7f-82c7-8e9487d3ff60","maxLength":36,"type":"string"},"cert_pack_uuid":{"description":"Certificate Pack UUID.","example":"a77f8bd7-3b47-46b4-a6f1-75cf98109948","type":"string"},"certificate":{"description":"The zone's SSL certificate or certificate and the intermediate(s).","example":"-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n","type":"string"},"certificate-packs_components-schemas-identifier":{"description":"The unique identifier for a certificate_pack.","example":"3822ff90-ea29-44df-9e55-21300bb9419b","readOnly":true,"type":"string"},"certificate-packs_components-schemas-status":{"description":"Status of certificate pack.","enum":["initializing","pending_validation","deleted","pending_issuance","pending_deployment","pending_deletion","pending_expiration","expired","active","initializing_timed_out","validation_timed_out","issuance_timed_out","deployment_timed_out","deletion_timed_out","pending_cleanup","staging_deployment","staging_active","deactivating","inactive","backup_issued","holding_deployment"],"example":"initializing","type":"string"},"certificateObject":{"properties":{"certificate":{"$ref":"#/components/schemas/zone-authenticated-origin-pull_components-schemas-certificate"},"expires_on":{"$ref":"#/components/schemas/components-schemas-expires_on"},"id":{"$ref":"#/components/schemas/identifier-tZwYoMuc"},"issuer":{"$ref":"#/components/schemas/issuer"},"signature":{"$ref":"#/components/schemas/signature"},"status":{"$ref":"#/components/schemas/zone-authenticated-origin-pull_components-schemas-status"},"uploaded_on":{"$ref":"#/components/schemas/schemas-uploaded_on"}}},"certificateObject-ymFm5Oiv":{"properties":{"certificate":{"$ref":"#/components/schemas/zone-authenticated-origin-pull_components-schemas-certificate"},"expires_on":{"$ref":"#/components/schemas/zone-authenticated-origin-pull_components-schemas-expires_on"},"id":{"$ref":"#/components/schemas/zone-authenticated-origin-pull_components-schemas-identifier"},"issuer":{"$ref":"#/components/schemas/issuer"},"signature":{"$ref":"#/components/schemas/signature"},"status":{"$ref":"#/components/schemas/zone-authenticated-origin-pull_components-schemas-status"},"uploaded_on":{"$ref":"#/components/schemas/schemas-uploaded_on"}}},"certificateObjectPost":{"properties":{"ca":{"$ref":"#/components/schemas/ca"},"certificates":{"$ref":"#/components/schemas/schemas-certificates"},"expires_on":{"$ref":"#/components/schemas/mtls-management_components-schemas-expires_on"},"id":{"$ref":"#/components/schemas/identifier-tZwYoMuc"},"issuer":{"$ref":"#/components/schemas/schemas-issuer"},"name":{"$ref":"#/components/schemas/schemas-name-F4rYvN2r"},"serial_number":{"$ref":"#/components/schemas/schemas-serial_number"},"signature":{"$ref":"#/components/schemas/signature"},"updated_at":{"$ref":"#/components/schemas/schemas-updated_at"},"uploaded_on":{"$ref":"#/components/schemas/mtls-management_components-schemas-uploaded_on"}}},"certificateObjectPost-vGa6WWep":{"properties":{"ca":{"$ref":"#/components/schemas/ca"},"certificates":{"$ref":"#/components/schemas/schemas-certificates"},"expires_on":{"$ref":"#/components/schemas/mtls-management_components-schemas-expires_on"},"id":{"$ref":"#/components/schemas/mtls-management_components-schemas-identifier"},"issuer":{"$ref":"#/components/schemas/schemas-issuer"},"name":{"$ref":"#/components/schemas/mtls-management_components-schemas-name"},"serial_number":{"$ref":"#/components/schemas/schemas-serial_number"},"signature":{"$ref":"#/components/schemas/signature"},"updated_at":{"$ref":"#/components/schemas/schemas-updated_at"},"uploaded_on":{"$ref":"#/components/schemas/mtls-management_components-schemas-uploaded_on"}}},"certificate_analyze_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"certificate_authority":{"description":"The Certificate Authority that will issue the certificate","enum":["digicert","google","lets_encrypt"],"example":"google","type":"string"},"certificate_authority-VxFhhbhi":{"description":"Certificate Authority selected for the order. Selecting Let's Encrypt will reduce customization of other fields: validation_method must be 'txt', validity_days must be 90, cloudflare_branding must be omitted, and hosts must contain only 2 entries, one for the zone name and one for the subdomain wildcard of the zone name (e.g. example.com, *.example.com).","enum":["digicert","google","lets_encrypt"],"example":"digicert","type":"string"},"certificate_pack_quota_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"advanced":{"$ref":"#/components/schemas/quota"}},"type":"object"}},"type":"object"}]},"certificate_pack_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"type":"object"},"type":"array"}}}]},"certificate_pack_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}},"type":"object"}]},"certificate_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/custom-certificate-CaAadyYf"},"type":"array"}}}]},"certificate_response_id_only":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/identifier-tZwYoMuc"}},"type":"object"}}}]},"certificate_response_id_only-e7wXd3xw":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/custom-certificate_components-schemas-identifier"}},"type":"object"}}}]},"certificate_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"certificate_response_single_id":{"allOf":[{"$ref":"#/components/schemas/schemas-certificate_response_single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/identifier-tZwYoMuc"}}}}}]},"certificate_response_single_id-NbTd4zHr":{"allOf":[{"$ref":"#/components/schemas/schemas-certificate_response_single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/certificates_components-schemas-identifier"}}}}}]},"certificate_response_single_post":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/certificateObjectPost-vGa6WWep"}],"type":"object"}}}]},"certificate_rule":{"description":"Matches any valid client certificate.","example":{"certificate":{}},"properties":{"certificate":{"example":{},"type":"object"}},"required":["certificate"],"title":"Valid certificate","type":"object"},"certificate_status":{"description":"Current status of certificate.","enum":["initializing","authorizing","active","expired","issuing","timing_out","pending_deployment"],"example":"active","type":"string"},"certificates":{"properties":{"certificate":{"$ref":"#/components/schemas/components-schemas-certificate"},"csr":{"$ref":"#/components/schemas/csr"},"expires_on":{"$ref":"#/components/schemas/schemas-expires_on"},"hostnames":{"$ref":"#/components/schemas/hostnames"},"id":{"$ref":"#/components/schemas/identifier-tZwYoMuc"},"request_type":{"$ref":"#/components/schemas/request_type"},"requested_validity":{"$ref":"#/components/schemas/requested_validity"}},"required":["hostnames","csr","requested_validity","request_type"],"type":"object"},"certificates-M6ivZ4vU":{"properties":{"certificate":{"$ref":"#/components/schemas/components-schemas-certificate"},"csr":{"$ref":"#/components/schemas/csr"},"expires_on":{"$ref":"#/components/schemas/certificates_components-schemas-expires_on"},"hostnames":{"$ref":"#/components/schemas/hostnames"},"id":{"$ref":"#/components/schemas/certificates_components-schemas-identifier"},"request_type":{"$ref":"#/components/schemas/request_type"},"requested_validity":{"$ref":"#/components/schemas/requested_validity"}},"required":["hostnames","csr","requested_validity","request_type"],"type":"object"},"certificates-rM299pCu":{"properties":{"associated_hostnames":{"$ref":"#/components/schemas/associated_hostnames"},"created_at":{"$ref":"#/components/schemas/timestamp"},"expires_on":{"$ref":"#/components/schemas/timestamp"},"fingerprint":{"$ref":"#/components/schemas/fingerprint"},"id":{"description":"The ID of the application that will use this certificate."},"name":{"$ref":"#/components/schemas/certificates_components-schemas-name"},"updated_at":{"$ref":"#/components/schemas/timestamp"}},"type":"object"},"certificates_components-schemas-expires_on":{"description":"When the certificate will expire.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string"},"certificates_components-schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/uuid-s0SXln0q"}},"type":"object"}}}]},"certificates_components-schemas-identifier":{"description":"The x509 serial number of the Origin CA certificate.","example":"328578533902268680212849205732770752308931942346","readOnly":true,"type":"string"},"certificates_components-schemas-name":{"description":"The name of the certificate.","example":"Allow devs","type":"string"},"certificates_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/certificates-rM299pCu"},"type":"array"}}}]},"certificates_components-schemas-response_collection-DJiYywE0":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/components-schemas-certificates"},"type":"array"}}}]},"certificates_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/certificates-rM299pCu"}}}]},"certificates_components-schemas-single_response-XBeTLvbA":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/components-schemas-certificates"}}}]},"cf_account_id":{"description":"Cloudflare account ID","example":"699d98642c564d2e855e9661899b7252","maxLength":32,"type":"string"},"challenge_ttl":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["challenge_ttl"],"example":"challenge_ttl"},"value":{"$ref":"#/components/schemas/challenge_ttl_value"}}}],"description":"Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136).","title":"Challenge Page TTL"},"challenge_ttl_value":{"default":1800,"description":"Value of the zone setting.","enum":[300,900,1800,2700,3600,7200,10800,14400,28800,57600,86400,604800,2592000,31536000],"type":"number"},"characteristics":{"items":{"properties":{"name":{"$ref":"#/components/schemas/characteristics_components-schemas-name"},"type":{"$ref":"#/components/schemas/schemas-type"}},"required":["type","name"],"type":"object"},"maxItems":10,"type":"array","uniqueItems":true},"characteristics_components-schemas-name":{"description":"The name of the characteristic field, i.e., the header or cookie name.","example":"authorization","maxLength":128,"type":"string"},"checkDisks":{"description":"List of volume names to be checked for encryption.","example":["C","D","G"],"items":{"type":"string"},"type":"array"},"check_regions":{"description":"A list of regions from which to run health checks. Null means Cloudflare will pick a default region.","example":["WEU","ENAM"],"items":{"description":"WNAM: Western North America, ENAM: Eastern North America, WEU: Western Europe, EEU: Eastern Europe, NSAM: Northern South America, SSAM: Southern South America, OC: Oceania, ME: Middle East, NAF: North Africa, SAF: South Africa, IN: India, SEAS: South East Asia, NEAS: North East Asia, ALL_REGIONS: all regions (BUSINESS and ENTERPRISE customers only).","enum":["WNAM","ENAM","WEU","EEU","NSAM","SSAM","OC","ME","NAF","SAF","IN","SEAS","NEAS","ALL_REGIONS"],"type":"string"},"nullable":true,"type":"array"},"check_regions-fqlLEr38":{"description":"A list of regions from which to run health checks. Null means every Cloudflare data center.","example":["WEU","ENAM"],"items":{"description":"WNAM: Western North America, ENAM: Eastern North America, WEU: Western Europe, EEU: Eastern Europe, NSAM: Northern South America, SSAM: Southern South America, OC: Oceania, ME: Middle East, NAF: North Africa, SAF: South Africa, SAS: Southern Asia, SEAS: South East Asia, NEAS: North East Asia, ALL_REGIONS: all regions (ENTERPRISE customers only).","enum":["WNAM","ENAM","WEU","EEU","NSAM","SSAM","OC","ME","NAF","SAF","SAS","SEAS","NEAS","ALL_REGIONS"],"type":"string"},"nullable":true,"type":"array"},"check_regions-q46IR1gk":{"description":"A list of regions from which to run health checks. Null means every Cloudflare data center.","example":["WEU","ENAM"],"items":{"description":"WNAM: Western North America, ENAM: Eastern North America, WEU: Western Europe, EEU: Eastern Europe, NSAM: Northern South America, SSAM: Southern South America, OC: Oceania, ME: Middle East, NAF: North Africa, SAF: South Africa, SAS: Southern Asia, SEAS: South East Asia, NEAS: North East Asia, ALL_REGIONS: all regions (ENTERPRISE customers only).","enum":["WNAM","ENAM","WEU","EEU","NSAM","SSAM","OC","ME","NAF","SAF","SAS","SEAS","NEAS","ALL_REGIONS"],"type":"string"},"nullable":true,"type":"array"},"cidr":{"description":"IP Prefix in Classless Inter-Domain Routing format.","example":"192.0.2.0/24","type":"string"},"cidr_configuration":{"properties":{"target":{"description":"The configuration target. You must set the target to `ip_range` when specifying an IP address range in the rule.","enum":["ip_range"],"example":"ip_range"},"value":{"description":"The IP address range to match. You can only use prefix lengths `/16` and `/24` for IPv4 ranges, and prefix lengths `/32`, `/48`, and `/64` for IPv6 ranges.","example":"198.51.100.4/16","type":"string"}},"title":"An IP address range configuration."},"cidr_list":{"description":"List of IPv4/IPv6 CIDR addresses.","example":["199.27.128.0/21","2400:cb00::/32"],"items":{"description":"IPv4/IPv6 CIDR.","example":"199.27.128.0/21","type":"string"},"type":"array"},"ciphers":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["ciphers"],"example":"ciphers"},"value":{"$ref":"#/components/schemas/ciphers_value"}}}],"default":[],"description":"An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format.","title":"Zone ciphers allowed for TLS termination"},"ciphers_value":{"default":[],"description":"Value of the zone setting.","example":["ECDHE-RSA-AES128-GCM-SHA256","AES128-SHA"],"items":{"type":"string"},"type":"array","uniqueItems":true},"city":{"description":"City.","example":"Austin","type":"string"},"class":{"description":"Which account types are allowed to create policies based on this categories. `blocked` categories are blocked unconditionally for all accounts. `removalPending` categories can be removed from policies but not added. `noBlock` categories cannot be blocked.","enum":["free","premium","blocked","removalPending","noBlock"],"example":"premium","type":"string"},"client-certificates_components-schemas-certificate":{"description":"The Client Certificate PEM","example":"-----BEGIN CERTIFICATE-----\\nMIIDmDCCAoC...dhDDE\\n-----END CERTIFICATE-----","readOnly":true,"type":"string"},"client-certificates_components-schemas-certificate_authority":{"description":"Certificate Authority used to issue the Client Certificate","properties":{"id":{"example":"568b6b74-7b0c-4755-8840-4e3b8c24adeb","type":"string"},"name":{"example":"Cloudflare Managed CA for account","type":"string"}},"type":"object"},"client-certificates_components-schemas-status":{"description":"Client Certificates may be active or revoked, and the pending_reactivation or pending_revocation represent in-progress asynchronous transitions","enum":["active","pending_reactivation","pending_revocation","revoked"],"example":"active"},"client-default":{"description":"Set if the location is the default one.","example":false,"type":"boolean"},"client_certificate":{"properties":{"certificate":{"$ref":"#/components/schemas/client-certificates_components-schemas-certificate"},"certificate_authority":{"$ref":"#/components/schemas/client-certificates_components-schemas-certificate_authority"},"common_name":{"$ref":"#/components/schemas/common_name"},"country":{"$ref":"#/components/schemas/country"},"csr":{"$ref":"#/components/schemas/schemas-csr"},"expires_on":{"$ref":"#/components/schemas/expired_on"},"fingerprint_sha256":{"$ref":"#/components/schemas/fingerprint_sha256"},"id":{"$ref":"#/components/schemas/identifier-tZwYoMuc"},"issued_on":{"$ref":"#/components/schemas/issued_on"},"location":{"$ref":"#/components/schemas/location"},"organization":{"$ref":"#/components/schemas/organization"},"organizational_unit":{"$ref":"#/components/schemas/organizational_unit"},"serial_number":{"$ref":"#/components/schemas/components-schemas-serial_number"},"signature":{"$ref":"#/components/schemas/components-schemas-signature"},"ski":{"$ref":"#/components/schemas/ski"},"state":{"$ref":"#/components/schemas/state"},"status":{"$ref":"#/components/schemas/client-certificates_components-schemas-status"},"validity_days":{"$ref":"#/components/schemas/components-schemas-validity_days"}}},"client_certificate_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/client_certificate"},"type":"array"}}}]},"client_certificate_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/client_certificate"}}}]},"client_id":{"description":"The Client ID for the service token. Access will check for this value in the `CF-Access-Client-ID` request header.","example":"88bf3b6d86161464f6509f7219099e57.access.example.com","type":"string"},"client_secret":{"description":"The Client Secret for the service token. Access will check for this value in the `CF-Access-Client-Secret` request header.","example":"bdd31cbc4dec990953e39163fbbb194c93313ca9f0a6e420346af9d326b1d2a5","type":"string"},"clipResponseSingle":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/clipping"}}}]},"clipped_from_video_uid":{"description":"The unique video identifier (UID).","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"clipping":{"properties":{"allowedOrigins":{"$ref":"#/components/schemas/allowedOrigins"},"clippedFromVideoUID":{"$ref":"#/components/schemas/clipped_from_video_uid"},"created":{"$ref":"#/components/schemas/clipping_created"},"creator":{"$ref":"#/components/schemas/creator"},"endTimeSeconds":{"$ref":"#/components/schemas/end_time_seconds"},"maxDurationSeconds":{"$ref":"#/components/schemas/maxDurationSeconds"},"meta":{"$ref":"#/components/schemas/media_metadata"},"modified":{"$ref":"#/components/schemas/live_input_modified"},"playback":{"$ref":"#/components/schemas/playback"},"preview":{"$ref":"#/components/schemas/preview"},"requireSignedURLs":{"$ref":"#/components/schemas/requireSignedURLs-9DKWYMwu"},"startTimeSeconds":{"$ref":"#/components/schemas/start_time_seconds"},"status":{"$ref":"#/components/schemas/media_state"},"thumbnailTimestampPct":{"$ref":"#/components/schemas/thumbnailTimestampPct"},"watermark":{"$ref":"#/components/schemas/watermarkAtUpload"}}},"clipping_created":{"description":"The date and time the clip was created.","example":"2014-01-02T02:20:00Z","format":"date-time","readOnly":true,"type":"string"},"cloudflare-tunnel_components-schemas-connection":{"properties":{"client_id":{"description":"UUID of the cloudflared instance."},"client_version":{"$ref":"#/components/schemas/cloudflare-tunnel_components-schemas-version"},"colo_name":{"$ref":"#/components/schemas/schemas-colo_name"},"id":{"$ref":"#/components/schemas/connection_id"},"is_pending_reconnect":{"$ref":"#/components/schemas/is_pending_reconnect"},"opened_at":{"description":"Timestamp of when the connection was established.","example":"2021-01-25T18:22:34.317854Z","format":"date-time","type":"string"},"origin_ip":{"description":"The public IP address of the host running cloudflared.","example":"85.12.78.6","type":"string"},"uuid":{"$ref":"#/components/schemas/connection_id"}}},"cloudflare-tunnel_components-schemas-created_at":{"description":"Timestamp of when the tunnel was created.","example":"2021-01-25T18:22:34.317854Z","format":"date-time","type":"string"},"cloudflare-tunnel_components-schemas-metadata":{"description":"Metadata associated with the tunnel.","example":{},"type":"object"},"cloudflare-tunnel_components-schemas-status":{"description":"The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).","example":"healthy","type":"string"},"cloudflare-tunnel_components-schemas-version":{"description":"The cloudflared version used to establish this connection.","example":"2022.7.1","type":"string"},"cloudflare_branding":{"description":"Whether or not to add Cloudflare Branding for the order. This will add sni.cloudflaressl.com as the Common Name if set true.","example":false,"type":"boolean"},"cloudflare_gre_endpoint":{"description":"The IP address assigned to the Cloudflare side of the GRE tunnel.","example":"203.0.113.1","type":"string"},"cloudflare_ipsec_endpoint":{"description":"The IP address assigned to the Cloudflare side of the IPsec tunnel.","example":"203.0.113.1","type":"string"},"cmb_config":{"nullable":true,"properties":{"regions":{"$ref":"#/components/schemas/regions"}},"type":"object"},"cmb_config_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/cmb_config"}}}]},"cname_flattening":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"How to flatten the cname destination.","enum":["cname_flattening"],"example":"flatten_at_root"},"value":{"$ref":"#/components/schemas/cname_flattening_value"}}}],"description":"Whether or not cname flattening is on.","title":"Cloudflare CNAME Flattening"},"cname_flattening_value":{"default":"flatten_at_root","description":"Value of the cname flattening setting.","enum":["flatten_at_root","flatten_all"],"type":"string"},"code":{"description":"The unique activation code for the account membership.","example":"05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0","maxLength":64,"readOnly":true,"type":"string"},"collection_invite_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/invite"},"type":"array"}},"type":"object"}]},"collection_member_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/components-schemas-member"},"type":"array"}},"type":"object"}]},"collection_membership_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/membership"},"type":"array"}},"type":"object"}]},"collection_organization_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/organization-8ZC4Qebn"},"type":"array"}},"type":"object"}]},"collection_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"allOf":[{"$ref":"#/components/schemas/api-shield"},{"properties":{"features":{}}}]},"type":"array"}}}]},"collection_response_paginated":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/collection_response"},{"properties":{"result_info":{"properties":{"count":{"description":"Total results returned based on your search parameters.","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters.","example":500,"type":"number"}},"type":"object"}}},{"properties":{"result":{"items":{"$ref":"#/components/schemas/api-shield"},"type":"array"}}}]},{"$ref":"#/components/schemas/collection_response"}]},"collection_role_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/schemas-role"},"type":"array"}},"type":"object"}]},"colo":{"properties":{"city":{"$ref":"#/components/schemas/colo_city"},"name":{"$ref":"#/components/schemas/colo_name-SO9lmxhl"}},"type":"object"},"colo_city":{"description":"Source colo city.","example":"Denver, CO, US","type":"string"},"colo_name":{"description":"Scope colo name.","example":"den01","type":"string"},"colo_name-SO9lmxhl":{"description":"Source colo name.","example":"den01","type":"string"},"colo_names":{"description":"List of colo names for the ECMP scope.","items":{"$ref":"#/components/schemas/colo_name"},"type":"array"},"colo_region":{"description":"Scope colo region.","example":"APAC","type":"string"},"colo_regions":{"description":"List of colo regions for the ECMP scope.","items":{"$ref":"#/components/schemas/colo_region"},"type":"array"},"colo_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"query":{"$ref":"#/components/schemas/query_response"},"result":{"$ref":"#/components/schemas/datacenters"}}}]},"colo_result":{"properties":{"colo":{"$ref":"#/components/schemas/colo"},"error":{"$ref":"#/components/schemas/error"},"hops":{"items":{"$ref":"#/components/schemas/hop_result"},"type":"array"},"target_summary":{"$ref":"#/components/schemas/target_summary"},"traceroute_time_ms":{"$ref":"#/components/schemas/traceroute_time_ms"}},"type":"object"},"colos":{"description":"If no source colo names specified, all colos will be used. China colos are unavailable for traceroutes.","example":["den","sin"],"items":{"description":"Source colo name.","type":"string"},"type":"array"},"comment":{"description":"Comments or notes about the DNS record. This field has no effect on DNS responses.","example":"Domain verification record","type":"string"},"comment-ZBQ7qz21":{"description":"Optional remark describing the route.","example":"Example comment for this route.","type":"string"},"common_components-schemas-identifier":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"common_components-schemas-ip":{"anyOf":[{"$ref":"#/components/schemas/ipv4"},{"$ref":"#/components/schemas/ipv6-KrBmBy6R"}]},"common_name":{"description":"Common Name of the Client Certificate","example":"Cloudflare","readOnly":true,"type":"string"},"component-value":{"properties":{"default":{"$ref":"#/components/schemas/default"},"name":{"$ref":"#/components/schemas/component-value_components-schemas-name"},"unit_price":{"$ref":"#/components/schemas/unit_price"}},"type":"object"},"component-value_components-schemas-name":{"description":"The unique component.","enum":["zones","page_rules","dedicated_certificates","dedicated_certificates_custom"],"example":"page_rules"},"component_value":{"description":"A component value for a subscription.","properties":{"default":{"description":"The default amount assigned.","example":5,"type":"number"},"name":{"description":"The name of the component value.","example":"page_rules","type":"string"},"price":{"description":"The unit price for the component value.","example":5,"type":"number"},"value":{"description":"The amount of the component value assigned.","example":20,"type":"number"}},"type":"object"},"component_values":{"description":"The list of add-ons subscribed to.","items":{"$ref":"#/components/schemas/component_value"},"type":"array"},"components-schemas-account":{"allOf":[{"$ref":"#/components/schemas/account"}]},"components-schemas-account_identifier":{"example":"9a7806061c88ada191ed06f989cc3dac"},"components-schemas-action":{"description":"The action to apply to a matched request. The `log` action is only available on an Enterprise plan.","enum":["block","challenge","js_challenge","managed_challenge","allow","log","bypass"],"example":"block","type":"string"},"components-schemas-action_parameters":{"description":"The parameters configuring the action.","oneOf":[{"$ref":"#/components/schemas/action_parameters_redirect"}],"type":"object"},"components-schemas-asn":{"type":"integer"},"components-schemas-base":{"properties":{"created_on":{"description":"When the Keyless SSL was created.","example":"2014-01-01T05:20:00Z","format":"date-time","readOnly":true,"type":"string"},"enabled":{"$ref":"#/components/schemas/enabled-mOUbjYfQ"},"host":{"$ref":"#/components/schemas/schemas-host"},"id":{"$ref":"#/components/schemas/keyless-certificate_components-schemas-identifier"},"modified_on":{"description":"When the Keyless SSL was last modified.","example":"2014-01-01T05:20:00Z","format":"date-time","readOnly":true,"type":"string"},"name":{"$ref":"#/components/schemas/keyless-certificate_components-schemas-name"},"permissions":{"description":"Available permissions for the Keyless SSL for the current user requesting the item.","example":["#ssl:read","#ssl:edit"],"items":{},"readOnly":true,"type":"array"},"port":{"$ref":"#/components/schemas/port-0Rcq4sy6"},"status":{"$ref":"#/components/schemas/keyless-certificate_components-schemas-status"}},"required":["id","name","host","port","status","enabled","permissions","created_on","modified_on"],"type":"object"},"components-schemas-certificate":{"description":"The Origin CA certificate. Will be newline-encoded.","example":"-----BEGIN CERTIFICATE-----\nMIICvDCCAaQCAQAwdzELMAkGA1UEBhMCVVMxDTALBgNVBAgMBFV0YWgxDzANBgNV\nBAcMBkxpbmRvbjEWMBQGA1UECgwNRGlnaUNlcnQgSW5jLjERMA8GA1UECwwIRGln\naUNlcnQxHTAbBgNVBAMMFGV4YW1wbGUuZGlnaWNlcnQuY29tMIIBIjANBgkqhkiG\n9w0BAQEFAAOCAQ8AMIIBCgKCAQEA8+To7d+2kPWeBv/orU3LVbJwDrSQbeKamCmo\nwp5bqDxIwV20zqRb7APUOKYoVEFFOEQs6T6gImnIolhbiH6m4zgZ/CPvWBOkZc+c\n1Po2EmvBz+AD5sBdT5kzGQA6NbWyZGldxRthNLOs1efOhdnWFuhI162qmcflgpiI\nWDuwq4C9f+YkeJhNn9dF5+owm8cOQmDrV8NNdiTqin8q3qYAHHJRW28glJUCZkTZ\nwIaSR6crBQ8TbYNE0dc+Caa3DOIkz1EOsHWzTx+n0zKfqcbgXi4DJx+C1bjptYPR\nBPZL8DAeWuA8ebudVT44yEp82G96/Ggcf7F33xMxe0yc+Xa6owIDAQABoAAwDQYJ\nKoZIhvcNAQEFBQADggEBAB0kcrFccSmFDmxox0Ne01UIqSsDqHgL+XmHTXJwre6D\nhJSZwbvEtOK0G3+dr4Fs11WuUNt5qcLsx5a8uk4G6AKHMzuhLsJ7XZjgmQXGECpY\nQ4mC3yT3ZoCGpIXbw+iP3lmEEXgaQL0Tx5LFl/okKbKYwIqNiyKWOMj7ZR/wxWg/\nZDGRs55xuoeLDJ/ZRFf9bI+IaCUd1YrfYcHIl3G87Av+r49YVwqRDT0VDV7uLgqn\n29XI1PpVUNCPQGn9p/eX6Qo7vpDaPybRtA2R7XLKjQaF9oXWeCUqy1hvJac9QFO2\n97Ob1alpHPoZ7mWiEuJwjBPii6a9M9G30nUo39lBi1w=\n-----END CERTIFICATE-----","readOnly":true,"type":"string"},"components-schemas-certificateObject":{"properties":{"ca":{"$ref":"#/components/schemas/ca"},"certificates":{"$ref":"#/components/schemas/schemas-certificates"},"expires_on":{"$ref":"#/components/schemas/mtls-management_components-schemas-expires_on"},"id":{"$ref":"#/components/schemas/identifier-tZwYoMuc"},"issuer":{"$ref":"#/components/schemas/schemas-issuer"},"name":{"$ref":"#/components/schemas/schemas-name-F4rYvN2r"},"serial_number":{"$ref":"#/components/schemas/schemas-serial_number"},"signature":{"$ref":"#/components/schemas/signature"},"uploaded_on":{"$ref":"#/components/schemas/mtls-management_components-schemas-uploaded_on"}}},"components-schemas-certificateObject-Eyk3On6c":{"properties":{"ca":{"$ref":"#/components/schemas/ca"},"certificates":{"$ref":"#/components/schemas/schemas-certificates"},"expires_on":{"$ref":"#/components/schemas/mtls-management_components-schemas-expires_on"},"id":{"$ref":"#/components/schemas/mtls-management_components-schemas-identifier"},"issuer":{"$ref":"#/components/schemas/schemas-issuer"},"name":{"$ref":"#/components/schemas/mtls-management_components-schemas-name"},"serial_number":{"$ref":"#/components/schemas/schemas-serial_number"},"signature":{"$ref":"#/components/schemas/signature"},"uploaded_on":{"$ref":"#/components/schemas/mtls-management_components-schemas-uploaded_on"}}},"components-schemas-certificate_authority":{"description":"The Certificate Authority that Total TLS certificates will be issued through.","enum":["google","lets_encrypt"],"example":"google","type":"string"},"components-schemas-certificate_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/zone-authenticated-origin-pull-aLOWlDXy"},"type":"array"}}}]},"components-schemas-certificate_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/schemas-certificateObject-otmSOZma"}}}]},"components-schemas-certificates":{"properties":{"associated_hostnames":{"$ref":"#/components/schemas/associated_hostnames"},"created_at":{"$ref":"#/components/schemas/timestamp"},"expires_on":{"$ref":"#/components/schemas/timestamp"},"fingerprint":{"$ref":"#/components/schemas/fingerprint"},"id":{"description":"The ID of the application that will use this certificate."},"name":{"$ref":"#/components/schemas/certificates_components-schemas-name"},"updated_at":{"$ref":"#/components/schemas/timestamp"}},"type":"object"},"components-schemas-collection_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/web3-hostname"},"type":"array"}}}]},"components-schemas-config":{"description":"The tunnel configuration and ingress rules in JSON format. For syntax and parameters, refer to the [configuration file documentation](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-and-setup/tunnel-guide/local/local-management/configuration-file/#file-structure).","type":"object"},"components-schemas-configuration":{"description":"The configuration object for the current rule.","properties":{"target":{"description":"The configuration target for this rule. You must set the target to `ua` for User Agent Blocking rules.","example":"ua","type":"string"},"value":{"description":"The exact user agent string to match. This value will be compared to the received `User-Agent` HTTP header value.","example":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4","type":"string"}},"type":"object"},"components-schemas-connection":{"properties":{"colo_name":{"$ref":"#/components/schemas/schemas-colo_name"},"is_pending_reconnect":{"$ref":"#/components/schemas/is_pending_reconnect"},"uuid":{"$ref":"#/components/schemas/connection_id"}}},"components-schemas-created_at":{"description":"Shows time of creation.","example":"2018-08-28T17:26:26Z","format":"date-time","type":"string"},"components-schemas-created_on":{"description":"When the Railgun was created.","example":"2014-01-01T05:20:00Z","format":"date-time","readOnly":true,"type":"string"},"components-schemas-description":{"description":"A short summary of domains in the category.","example":"Sites related to educational content that are not included in other categories like Science, Technology or Educational institutions.","type":"string"},"components-schemas-description-EJnoLTyB":{"description":"An optional description forthe IPsec tunnel.","example":"Tunnel for ISP X","type":"string"},"components-schemas-description-Po1ZMHYz":{"description":"An informative summary of the rate limit. This value is sanitized and any tags will be removed.","example":"Prevent multiple login failures to mitigate brute force attacks","maxLength":1024,"type":"string"},"components-schemas-description-UH5FN4sh":{"description":"Object description.","example":"Load Balancer for www.example.com","type":"string"},"components-schemas-domain":{"description":"The domain of the Bookmark application.","example":"example.com","type":"string"},"components-schemas-email":{"description":"The email of the user.","example":"jdoe@example.com","format":"email","type":"string"},"components-schemas-empty_response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"type":"object"}},"type":"object"}]},"components-schemas-enabled":{"description":"If enabled, Total TLS will order a hostname specific TLS certificate for any proxied A, AAAA, or CNAME record in your zone.","example":true,"type":"boolean"},"components-schemas-enabled-tktxdyPy":{"default":true,"description":"Whether to enable (the default) this load balancer.","example":true,"type":"boolean"},"components-schemas-exclude":{"items":{"$ref":"#/components/schemas/split_tunnel"},"type":"array"},"components-schemas-expires_on":{"description":"When the certificate from the authority expires.","example":"2100-01-01T05:20:00Z","format":"date-time","readOnly":true,"type":"string"},"components-schemas-expires_on-KIWqadEQ":{"description":"When the certificate from the authority expires.","example":"2016-01-01T05:20:00Z","format":"date-time","readOnly":true,"type":"string"},"components-schemas-filters":{"additionalProperties":{"description":"Optional filters that allow you to be alerted only on a subset of events for that alert type based on some criteria. This is only available for select alert types. See alert type documentation for more details.","items":{},"type":"array"},"example":{"slo":["99.9"]},"type":"object"},"components-schemas-hostname":{"description":"Hostname of the Worker Domain.","example":"foo.example.com","type":"string"},"components-schemas-id":{"description":"ID of the namespace.","example":"5fd1cafff895419c8bcc647fc64ab8f0","type":"string"},"components-schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/components-schemas-identifier"}},"type":"object"}}}]},"components-schemas-id_response-Ujz7iPfP":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/load-balancer_components-schemas-identifier"}},"type":"object"}}}]},"components-schemas-id_response-XcbFiwuE":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/load-balancer_components-schemas-identifier"}},"type":"object"}}}]},"components-schemas-id_response-th0exOPu":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"}},"type":"object"}}}]},"components-schemas-identifier":{"example":"23ff594956f20c2a721606e94745a8aa","readOnly":true},"components-schemas-identifier-454QZaBH":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"components-schemas-identifier-vS0Y8rdw":{"description":"Token identifier tag.","example":"ed17574386854bf78a67040be0a770b0","maxLength":32,"readOnly":true,"type":"string"},"components-schemas-ip":{"description":"IPv4 or IPv6 address.","example":"1.1.1.1","type":"string"},"components-schemas-kind":{"description":"The type of the membership.","enum":["zone","account"],"example":"zone","type":"string"},"components-schemas-match":{"description":"The wirefilter expression to match devices.","example":"user.identity == \"test@cloudflare.com\"","maxLength":500,"type":"string"},"components-schemas-member":{"properties":{"email":{"$ref":"#/components/schemas/email-sNyq81Xd"},"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"name":{"$ref":"#/components/schemas/member_components-schemas-name"},"roles":{"description":"Roles assigned to this Member.","items":{"$ref":"#/components/schemas/schemas-role"},"type":"array"},"status":{"description":"A member's status in the organization.","enum":["accepted","invited"],"example":"accepted"}},"required":["id","name","email","status","roles"],"type":"object"},"components-schemas-metadata":{"description":"Arbitrary JSON to be associated with a key/value pair.","example":"{\"someMetadataKey\": \"someMetadataValue\"}","type":"string"},"components-schemas-mode":{"default":"on","description":"The state of the rules contained in the rule group. When `on`, the rules in the group are configurable/usable.","enum":["on","off"],"type":"string"},"components-schemas-modified_on":{"description":"The timestamp of when the rule was last modified.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string"},"components-schemas-modified_tunnels_collection_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"modified":{"example":true,"type":"boolean"},"modified_interconnects":{"items":{"$ref":"#/components/schemas/interconnect"},"type":"array"}}}}}]},"components-schemas-monitor":{"properties":{"allow_insecure":{"$ref":"#/components/schemas/allow_insecure"},"consecutive_down":{"$ref":"#/components/schemas/consecutive_down"},"consecutive_up":{"$ref":"#/components/schemas/consecutive_up"},"created_on":{"$ref":"#/components/schemas/timestamp"},"description":{"$ref":"#/components/schemas/monitor_components-schemas-description"},"expected_body":{"$ref":"#/components/schemas/expected_body"},"expected_codes":{"$ref":"#/components/schemas/schemas-expected_codes"},"follow_redirects":{"$ref":"#/components/schemas/follow_redirects"},"header":{"$ref":"#/components/schemas/header"},"id":{"$ref":"#/components/schemas/monitor_components-schemas-identifier"},"interval":{"$ref":"#/components/schemas/interval-IFpdxmAf"},"method":{"$ref":"#/components/schemas/schemas-method"},"modified_on":{"$ref":"#/components/schemas/timestamp"},"path":{"$ref":"#/components/schemas/path-N56b8ntG"},"port":{"$ref":"#/components/schemas/components-schemas-port"},"probe_zone":{"$ref":"#/components/schemas/probe_zone"},"retries":{"$ref":"#/components/schemas/retries"},"timeout":{"$ref":"#/components/schemas/schemas-timeout"},"type":{"$ref":"#/components/schemas/monitor_components-schemas-type"}},"type":"object"},"components-schemas-monitor-vfiRsl5D":{"properties":{"allow_insecure":{"$ref":"#/components/schemas/allow_insecure"},"consecutive_down":{"$ref":"#/components/schemas/consecutive_down"},"consecutive_up":{"$ref":"#/components/schemas/consecutive_up"},"created_on":{"$ref":"#/components/schemas/timestamp"},"description":{"$ref":"#/components/schemas/description-Jd6AMFjR"},"expected_body":{"$ref":"#/components/schemas/expected_body"},"expected_codes":{"$ref":"#/components/schemas/schemas-expected_codes"},"follow_redirects":{"$ref":"#/components/schemas/follow_redirects"},"header":{"$ref":"#/components/schemas/header"},"id":{"$ref":"#/components/schemas/identifier-FZThz4k7"},"interval":{"$ref":"#/components/schemas/interval-hA6swy38"},"method":{"$ref":"#/components/schemas/method-guvmKTdR"},"modified_on":{"$ref":"#/components/schemas/timestamp"},"path":{"$ref":"#/components/schemas/path-I0p9X4oI"},"port":{"$ref":"#/components/schemas/schemas-port-uAxZ6zJW"},"probe_zone":{"$ref":"#/components/schemas/probe_zone"},"retries":{"$ref":"#/components/schemas/retries"},"timeout":{"$ref":"#/components/schemas/timeout"},"type":{"$ref":"#/components/schemas/type-gTI6cLgq"}},"type":"object"},"components-schemas-name":{"description":"The name of the Rule.","example":"block bad websites","type":"string"},"components-schemas-name-0v75iZSQ":{"description":"The name of the peer.","example":"my-peer-1","type":"string"},"components-schemas-name-4G3Rlgj8":{"description":"The name of the Access group.","example":"Allow devs","type":"string"},"components-schemas-name-4QGVxQIe":{"description":"The name of the Device Posture Integration.","example":"My Workspace One Integration","type":"string"},"components-schemas-name-MuyCBGYr":{"description":"The name of the interconnect. The name cannot share a name with other tunnels.","example":"pni_ord","type":"string"},"components-schemas-name-h5gI0ndx":{"description":"The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will not be used.","example":"www.example.com","type":"string"},"components-schemas-name-l3W5RvJP":{"description":"Role Name.","example":"Organization Admin","maxLength":120,"readOnly":true,"type":"string"},"components-schemas-patch":{"description":"Update enablement of Smart Tiered Cache","properties":{"value":{"$ref":"#/components/schemas/tiered-cache-smart-topology-api_components-schemas-value"}},"required":["value"],"type":"object"},"components-schemas-pattern":{"description":"A pattern that matches an entry","properties":{"regex":{"description":"The regex pattern.","example":"^4[0-9]{6,14}$","type":"string"},"validation":{"description":"Validation algorithm for the pattern. This algorithm will get run on potential matches, and if it returns false, the entry will not be matched.","enum":["luhn"],"example":"luhn","type":"string"}},"required":["regex"],"title":"Pattern","type":"object"},"components-schemas-paused":{"description":"When true, indicates that the firewall rule is currently paused.","example":false,"type":"boolean"},"components-schemas-per_page":{"description":"Number of results per page of results.","example":20,"type":"number"},"components-schemas-policies":{"properties":{"alert_type":{"$ref":"#/components/schemas/alert_type"},"created":{"$ref":"#/components/schemas/timestamp"},"description":{"$ref":"#/components/schemas/policies_components-schemas-description"},"enabled":{"$ref":"#/components/schemas/policies_components-schemas-enabled"},"filters":{"$ref":"#/components/schemas/components-schemas-filters"},"id":{"$ref":"#/components/schemas/uuid-s0SXln0q"},"mechanisms":{"$ref":"#/components/schemas/mechanisms"},"modified":{"$ref":"#/components/schemas/timestamp"},"name":{"$ref":"#/components/schemas/policies_components-schemas-name-2"}},"type":"object"},"components-schemas-port":{"default":0,"description":"The port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).","type":"integer"},"components-schemas-priority":{"description":"The relative priority of the current URI-based WAF override when multiple overrides match a single URL. A lower number indicates higher priority. Higher priority overrides may overwrite values set by lower priority overrides.","example":1,"maximum":1000000000,"minimum":-1000000000,"type":"number"},"components-schemas-private_key":{"description":"The private key for the certificate","example":"-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDEXDkcICRU3XBv9hiiPnBWIjgTQyowmVFxDr11mONgZB/cMYjE/OvQjvnpwNcOaSK16MOpAjNbELKRx2lZiVJaLRDCccqCxXwP/CrdRChcqGzo7mbNksMlcidrErb0LlEBKLFC2QjRmRKqB+YOs4TD8WsZu2S667A2fZmjRlaqOxFi1h62ee0P+TLU628UC/nl41JifSt5Evt7hMDHakemdwZblNYr2p6T3NQjdhjYXTtP4UmOGJBhJ7i7Kicg3d3CIgdTMbggSeGWqjndr4ldVnD96FN3cVT5uDFsn2CJXTFgdeBWoUnMS4VnUZzPWGf4vSBXC8qV7Ls+w46yT7T1AgMBAAECggEAQZnp/oqCeNPOR6l5S2L+1tfx0gWjZ78hJVteUpZ0iHSK7F6kKeOxyOird7vUXV0kmo+cJq+0hp0Ke4eam640FCpwKfYoSQ4/R3vgujGWJnaihCN5tv5sMet0XeJPuz5qE7ALoKCvwI6aXLHs20aAeZIDTQJ9QbGSGnJVzOWn+JDTidIgZpN57RpXfSAwnJPTQK/PN8i5z108hsaDOdEgGmxYZ7kYqMqzX20KXmth58LDfPixs5JGtS60iiKC/wOcGzkB2/AdTSojR76oEU77cANP/3zO25NG//whUdYlW0t0d7PgXxIeJe+xgYnamDQJx3qonVyt4H77ha0ObRAj9QKBgQDicZr+VTwFMnELP3a+FXGnjehRiuS1i7MXGKxNweCD+dFlML0FplSQS8Ro2n+d8lu8BBXGx0qm6VXu8Rhn7TAUL6q+PCgfarzxfIhacb/TZCqfieIHsMlVBfhV5HCXnk+kis0tuC/PRArcWTwDHJUJXkBhvkUsNswvQzavDPI7KwKBgQDd/WgLkj7A3X5fgIHZH/GbDSBiXwzKb+rF4ZCT2XFgG/OAW7vapfcX/w+v+5lBLyrocmOAS3PGGAhM5T3HLnUCQfnK4qgps1Lqibkc9Tmnsn60LanUjuUMsYv/zSw70tozbzhJ0pioEpWfRxRZBztO2Rr8Ntm7h6Fk701EXGNAXwKBgQCD1xsjy2J3sCerIdcz0u5qXLAPkeuZW+34m4/ucdwTWwc0gEz9lhsULFj9p4G351zLuiEnq+7mAWLcDJlmIO3mQt6JhiLiL9Y0T4pgBmxmWqKKYtAsJB0EmMY+1BNN44mBRqMxZFTJu1cLdhT/xstrOeoIPqytknYNanfTMZlzIwKBgHrLXe5oq0XMP8dcMneEcAUwsaU4pr6kQd3L9EmUkl5zl7J9C+DaxWAEuwzBw/iGutlxzRB+rD/7szu14wJ29EqXbDGKRzMp+se5/yfBjm7xEZ1hVPw7PwBShfqt57X/4Ktq7lwHnmH6RcGhc+P7WBc5iO/S94YAdIp8xOT3pf9JAoGAE0QkqJUY+5Mgr+fBO0VNV72ZoPveGpW+De59uhKAOnu1zljQCUtk59m6+DXfm0tNYKtawa5n8iN71Zh+s62xXSt3pYi1Y5CCCmv8Y4BhwIcPwXKk3zEvLgSHVTpC0bayA9aSO4bbZgVXa5w+Z0w/vvfp9DWo1IS3EnQRrz6WMYA=\n-----END PRIVATE KEY-----","type":"string"},"components-schemas-ref":{"description":"The reference of the rule (the rule ID by default).","example":"my_ref","type":"string"},"components-schemas-response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/ip-list"},"type":"array"}}}]},"components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/rules"},"type":"array"}}}]},"components-schemas-response_collection-6gfWBAmq":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/device-managed-networks-FH3V2phW"},"type":"array"}}}]},"components-schemas-response_collection-7Rg5C3fo":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"type":"object"},"type":"array"}}}]},"components-schemas-response_collection-Np6QDZ3m":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/acl"},"type":"array"}}}]},"components-schemas-response_collection-Qou49Scv":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/service-tokens"},"type":"array"}}}]},"components-schemas-response_collection-Qwy7OnW5":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/analytics"},"type":"array"}}}]},"components-schemas-response_collection-R3Nbn4ml":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/address-maps"},"type":"array"}}}]},"components-schemas-result":{"allOf":[{"$ref":"#/components/schemas/result-iSgQlUWZ"},{"properties":{"data":{"example":[{"metrics":[[2,4],[16,32]]}]},"max":{"example":{"storedBytes":32,"storedKeys":4}},"min":{"example":{"storedBytes":16,"storedKeys":2}},"query":{"$ref":"#/components/schemas/query-ju6G02HL"},"totals":{"example":{"storedBytes":48,"storedKeys":6}}}}]},"components-schemas-rule":{"oneOf":[{"$ref":"#/components/schemas/anomaly_rule"},{"$ref":"#/components/schemas/traditional_deny_rule"},{"$ref":"#/components/schemas/traditional_allow_rule"}],"type":"object"},"components-schemas-rules":{"description":"BETA Field Not General Access: A list of rules for this load balancer to execute.","items":{"additionalProperties":false,"description":"A rule object containing conditions and overrides for this load balancer to evaluate.","properties":{"condition":{"description":"The condition expressions to evaluate. If the condition evaluates to true, the overrides or fixed_response in this rule will be applied. An empty condition is always true. For more details on condition expressions, please see https://developers.cloudflare.com/load-balancing/understand-basics/load-balancing-rules/expressions.","example":"http.request.uri.path contains \"/testing\"","type":"string"},"disabled":{"default":false,"description":"Disable this specific rule. It will no longer be evaluated by this load balancer.","type":"boolean"},"fixed_response":{"description":"A collection of fields used to directly respond to the eyeball instead of routing to a pool. If a fixed_response is supplied the rule will be marked as terminates.","properties":{"content_type":{"description":"The http 'Content-Type' header to include in the response.","example":"application/json","maxLength":32,"type":"string"},"location":{"description":"The http 'Location' header to include in the response.","example":"www.example.com","maxLength":2048,"type":"string"},"message_body":{"description":"Text to include as the http body.","example":"Testing Hello","maxLength":1024,"type":"string"},"status_code":{"description":"The http status code to respond with.","type":"integer"}},"type":"object"},"name":{"description":"Name of this rule. Only used for human readability.","example":"route the path /testing to testing datacenter.","maxLength":200,"type":"string"},"overrides":{"description":"A collection of overrides to apply to the load balancer when this rule's condition is true. All fields are optional.","properties":{"adaptive_routing":{"$ref":"#/components/schemas/adaptive_routing"},"country_pools":{"$ref":"#/components/schemas/country_pools"},"default_pools":{"$ref":"#/components/schemas/default_pools"},"fallback_pool":{"$ref":"#/components/schemas/fallback_pool"},"location_strategy":{"$ref":"#/components/schemas/location_strategy"},"pop_pools":{"$ref":"#/components/schemas/pop_pools"},"random_steering":{"$ref":"#/components/schemas/random_steering"},"region_pools":{"$ref":"#/components/schemas/region_pools"},"session_affinity":{"$ref":"#/components/schemas/session_affinity"},"session_affinity_attributes":{"$ref":"#/components/schemas/session_affinity_attributes"},"session_affinity_ttl":{"$ref":"#/components/schemas/session_affinity_ttl"},"steering_policy":{"$ref":"#/components/schemas/steering_policy"},"ttl":{"$ref":"#/components/schemas/ttl-vFKh1wOV"}},"type":"object"},"priority":{"default":0,"description":"The order in which rules should be executed in relation to each other. Lower values are executed first. Values do not need to be sequential. If no value is provided for any rule the array order of the rules field will be used to assign a priority.","type":"integer"},"terminates":{"default":false,"description":"If this rule's condition is true, this causes rule evaluation to stop after processing this rule.","type":"boolean"}},"type":"object"},"type":"array"},"components-schemas-ruleset":{"properties":{"description":{"example":""},"id":{"example":"2f2feab2026849078ba485f918791bdc"},"kind":{"example":"zone"},"name":{"example":"default"},"phase":{"example":"http_request_dynamic_redirect"},"rules":{"description":"The rules in the ruleset.","items":{"$ref":"#/components/schemas/dynamic-redirect-rules_components-schemas-rule"},"type":"array"}}},"components-schemas-serial_number":{"description":"The serial number on the created Client Certificate.","example":"3bb94ff144ac567b9f75ad664b6c55f8d5e48182","readOnly":true,"type":"string"},"components-schemas-serial_number-AUVcZzty":{"description":"The device serial number.","example":"EXAMPLEHMD6R","type":"string"},"components-schemas-signature":{"description":"The type of hash used for the Client Certificate..","example":"SHA256WithRSA","readOnly":true,"type":"string"},"components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/rules"}}}]},"components-schemas-single_response-1u3sjtw5":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/monitor"}}}]},"components-schemas-single_response-AhobaCUU":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"description":"A list of countries and subdivisions mapped to a region.","example":{"iso_standard":"Country and subdivision codes follow ISO 3166-1 alpha-2 and ISO 3166-2","regions":[{"countries":[{"country_code_a2":"CA","country_name":"Canada","country_subdivisions":[{"subdivision_code_a2":"AB","subdivision_name":"Alberta"},{"subdivision_code_a2":"BC","subdivision_name":"British Columbia"}]},{"country_code_a2":"HT","country_name":"Haiti"},{"country_code_a2":"MX","country_name":"Mexico"},{"country_code_a2":"US","country_name":"United States","country_subdivisions":[{"subdivision_code_a2":"AZ","subdivision_name":"Arizona"},{"subdivision_code_a2":"CA","subdivision_name":"California"},{"subdivision_code_a2":"CO","subdivision_name":"Colorado"},{"subdivision_code_a2":"HI","subdivision_name":"Hawaii"},{"subdivision_code_a2":"MN","subdivision_name":"Minnesota"},{"subdivision_code_a2":"MO","subdivision_name":"Missouri"},{"subdivision_code_a2":"NV","subdivision_name":"Nevada"},{"subdivision_code_a2":"OR","subdivision_name":"Oregon"},{"subdivision_code_a2":"TX","subdivision_name":"Texas"},{"subdivision_code_a2":"UT","subdivision_name":"Utah"},{"subdivision_code_a2":"WA","subdivision_name":"Washington"}]}],"region_code":"WNAM"}]},"type":"object"}}}]},"components-schemas-single_response-UrWzkhyF":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/acl"}}}]},"components-schemas-single_response-ar7Y7q7I":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/device-managed-networks-FH3V2phW"}}}]},"components-schemas-single_response-gP2O4PI2":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/groups"}}}]},"components-schemas-single_response-plUIZwft":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/address-maps"}}}]},"components-schemas-state":{"description":"The custom page state.","enum":["default","customized"],"example":"default"},"components-schemas-status":{"description":"Status of the hostname's activation.","enum":["active","pending","active_redeploying","moved","pending_deletion","deleted","pending_blocked","pending_migration","pending_provisioned","test_pending","test_active","test_active_apex","test_blocked","test_failed","provisioned","blocked"],"example":"pending"},"components-schemas-status-bVKpIIc1":{"description":"Whether the user is a member of the organization or has an inivitation pending.","enum":["member","invited"],"example":"member","type":"string"},"components-schemas-tunnel_modified_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"modified":{"example":true,"type":"boolean"},"modified_interconnect":{"type":"object"}}}}}]},"components-schemas-tunnel_single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"interconnect":{"type":"object"}}}}}]},"components-schemas-tunnel_update_request":{"properties":{"description":{"$ref":"#/components/schemas/interconnect_components-schemas-description"},"gre":{"$ref":"#/components/schemas/gre"},"health_check":{"$ref":"#/components/schemas/schemas-health_check"},"interface_address":{"$ref":"#/components/schemas/interface_address"},"mtu":{"$ref":"#/components/schemas/schemas-mtu"}},"type":"object"},"components-schemas-tunnels_collection_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"interconnects":{"items":{"$ref":"#/components/schemas/interconnect"},"type":"array"}}}}}]},"components-schemas-type":{"default":"legacy_custom","description":"The type 'legacy_custom' enables support for legacy clients which do not include SNI in the TLS handshake.","enum":["legacy_custom","sni_custom"],"example":"sni_custom","type":"string"},"components-schemas-type-KlrF1JPW":{"description":"The type of Device Managed Network.","enum":["tls"],"example":"tls","type":"string"},"components-schemas-until":{"description":"End date and time of requesting data period in the ISO8601 format.","example":"2016-11-11T13:00:00Z","format":"date-time","type":"string"},"components-schemas-updated_at":{"description":"Last updated.","example":"2018-08-28T17:26:26Z","format":"date-time","type":"string"},"components-schemas-uploaded_on":{"description":"The time when the certificate was uploaded.","example":"2019-10-28T18:11:23.37411Z","format":"date-time","type":"string"},"components-schemas-url":{"description":"URL(s) to filter submissions results by","example":"https://www.cloudflare.com","format":"uri","type":"string"},"components-schemas-uuid":{"description":"The policy ID.","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36,"type":"string"},"components-schemas-uuid-nWj9wBDf":{"description":"UUID","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36,"readOnly":true,"type":"string"},"components-schemas-validation_method":{"properties":{"validation_method":{"$ref":"#/components/schemas/validation_method_definition"}},"required":["validation_method"],"type":"object"},"components-schemas-validity_days":{"description":"The number of days the Client Certificate will be valid after the issued_on date","example":3650,"type":"integer"},"components-schemas-value":{"description":"Enables Tiered Caching.","enum":["on","off"],"example":"on","type":"string"},"components-schemas-version":{"description":"The version of the Railgun receiver.","example":"2.1","readOnly":true,"type":"string"},"components-schemas-zone":{"properties":{"activated_on":{"description":"The last time proof of ownership was detected and the zone was made\nactive","example":"2014-01-02T00:01:00.12345Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"created_on":{"description":"When the zone was created","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string"},"development_mode":{"description":"The interval (in seconds) from when development mode expires\n(positive integer) or last expired (negative integer) for the\ndomain. If development mode has never been enabled, this value is 0.","example":7200,"readOnly":true,"type":"number"},"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"modified_on":{"description":"When the zone was last modified","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string"},"name":{"description":"The domain name","example":"example.com","maxLength":253,"pattern":"^([a-zA-Z0-9][\\-a-zA-Z0-9]*\\.)+[\\-a-zA-Z0-9]{2,20}$","readOnly":true,"type":"string"},"original_dnshost":{"description":"DNS host at the time of switching to Cloudflare","example":"NameCheap","maxLength":50,"nullable":true,"readOnly":true,"type":"string"},"original_name_servers":{"description":"Original name servers before moving to Cloudflare\nNotes: Is this only available for full zones?","example":["ns1.originaldnshost.com","ns2.originaldnshost.com"],"items":{"format":"hostname","type":"string"},"nullable":true,"readOnly":true,"type":"array"},"original_registrar":{"description":"Registrar for the domain at the time of switching to Cloudflare","example":"GoDaddy","nullable":true,"readOnly":true,"type":"string"}},"required":["id","name","development_mode","owner","account","meta","original_name_servers","original_registrar","original_dnshost","created_on","modified_on","activated_on"],"type":"object"},"condition":{"properties":{"request.ip":{"$ref":"#/components/schemas/request.ip"}},"type":"object"},"config":{"items":{"$ref":"#/components/schemas/hostname_certid_input-CNETqmIk"},"type":"array"},"config-rules_components-schemas-action_parameters":{"description":"The parameters configuring the action.","oneOf":[{"$ref":"#/components/schemas/action_parameters_set_config"}],"type":"object"},"config-rules_components-schemas-rule":{"properties":{"action":{"example":"set_config"},"action_parameters":{"$ref":"#/components/schemas/config-rules_components-schemas-action_parameters"},"description":{"example":"enable Email Obfuscation"},"expression":{"example":"http.cookie contains \"something\""},"id":{"example":"3a03d665bac047339bb530ecb439a90d"},"version":{"example":"1"}}},"config-rules_components-schemas-ruleset":{"properties":{"description":{"example":""},"id":{"example":"2f2feab2026849078ba485f918791bdc"},"kind":{"example":"zone"},"name":{"example":"default"},"phase":{"example":"http_config_settings"},"rules":{"description":"The rules in the ruleset.","items":{"$ref":"#/components/schemas/config-rules_components-schemas-rule"},"type":"array"}}},"config_components-schemas-account_identifier":{"example":"6f91088a406011ed95aed352566e8d4c"},"config_request":{"description":"The configuration object containing third party integration information.","example":{"api_url":"https://as123.awmdm.com/API","auth_url":"https://na.uemauth.vmwservices.com/connect/token","client_id":"example client id","client_secret":"example client secret"},"oneOf":[{"$ref":"#/components/schemas/workspace_one_config_request"},{"$ref":"#/components/schemas/crowdstrike_config_request"},{"$ref":"#/components/schemas/uptycs_config_request"},{"$ref":"#/components/schemas/intune_config_request"}],"type":"object"},"config_request-dR6XwB2B":{"description":"The configuration object containing third party integration information.","example":{"api_url":"https://as123.awmdm.com/API","auth_url":"https://na.uemauth.vmwservices.com/connect/token","client_id":"example client id","client_secret":"example client secret"},"oneOf":[{"$ref":"#/components/schemas/workspace_one_config_request"},{"$ref":"#/components/schemas/crowdstrike_config_request"},{"$ref":"#/components/schemas/uptycs_config_request"},{"$ref":"#/components/schemas/intune_config_request"},{"$ref":"#/components/schemas/kolide_config_request"}],"type":"object"},"config_response":{"description":"The configuration object containing third party integration information.","example":{"api_url":"https://as123.awmdm.com/API","auth_url":"https://na.uemauth.vmwservices.com/connect/token","client_id":"example client id"},"oneOf":[{"$ref":"#/components/schemas/workspace_one_config_response"}],"type":"object"},"config_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}},"type":"object"}]},"config_src":{"default":"local","description":"Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel on the Zero Trust dashboard or using the [Cloudflare Tunnel configuration](https://api.cloudflare.com/#cloudflare-tunnel-configuration-properties) endpoint.","enum":["local","cloudflare"],"example":"cloudflare","type":"string"},"config_version":{"description":"The version of the remote tunnel configuration. Used internally to sync cloudflared with the Zero Trust dashboard.","type":"integer"},"configuration":{"properties":{"auth_id_characteristics":{"$ref":"#/components/schemas/characteristics"}},"type":"object"},"configurations":{"anyOf":[{"$ref":"#/components/schemas/schemas-ip_configuration"},{"$ref":"#/components/schemas/schemas-cidr_configuration"}],"description":"A list of IP addresses or CIDR ranges that will be allowed to access the URLs specified in the Zone Lockdown rule. You can include any number of `ip` or `ip_range` configurations.","items":{"anyOf":[{"$ref":"#/components/schemas/schemas-ip_configuration"},{"$ref":"#/components/schemas/schemas-cidr_configuration"}]},"type":"array"},"connected":{"default":false,"description":"A flag indicating whether the given zone is connected to the Railgun.","example":true,"type":"boolean"},"connection":{"properties":{"added_at":{"example":"2021-08-18T10:51:10.09615Z"},"domain_reported_malicious":{"example":false},"first_page_url":{"example":"blog.cloudflare.com/page"},"first_seen_at":{"example":"2021-08-18T10:51:08Z"},"host":{"example":"blog.cloudflare.com"},"id":{"example":"c9ef84a6bf5e47138c75d95e2f933e8f"},"last_seen_at":{"example":"2021-09-02T09:57:54Z"},"page_urls":{"example":["blog.cloudflare.com/page1","blog.cloudflare.com/page2"]},"url":{"example":"https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.0/js/bootstrap.min.js"},"url_contains_cdn_cgi_path":{"example":false}}},"connection-CprJdVPV":{"description":"The IdP used to authenticate.","example":"saml","type":"string"},"connection-Xm0br0wV":{"properties":{"created_on":{"$ref":"#/components/schemas/connection_components-schemas-created_on"},"enabled":{"$ref":"#/components/schemas/connection_components-schemas-enabled"},"id":{"$ref":"#/components/schemas/connection_components-schemas-identifier"},"modified_on":{"$ref":"#/components/schemas/connection_components-schemas-modified_on"},"zone":{"$ref":"#/components/schemas/connection_components-schemas-zone"}},"required":["id","zone","enabled"],"type":"object"},"connection_collection_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/connection-Xm0br0wV"},"type":"array"}}}]},"connection_components-schemas-created_on":{"description":"When the connection was created.","example":"2017-06-14T00:00:00Z","format":"date-time","readOnly":true,"type":"string"},"connection_components-schemas-enabled":{"default":false,"description":"A value indicating whether the connection is enabled or not.","example":true,"type":"boolean"},"connection_components-schemas-identifier":{"description":"Connection identifier tag.","example":"c4a7362d577a6c3019a474fd6f485821","maxLength":32,"readOnly":true,"type":"string"},"connection_components-schemas-modified_on":{"description":"When the connection was last modified.","example":"2017-06-14T05:20:00Z","format":"date-time","readOnly":true,"type":"string"},"connection_components-schemas-zone":{"properties":{"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"name":{"$ref":"#/components/schemas/zone-properties-name"}},"type":"object"},"connection_id":{"description":"UUID of the Cloudflare Tunnel connection.","example":"1bedc50d-42b3-473c-b108-ff3d10c0d925","maxLength":36,"readOnly":true,"type":"string"},"connection_single_id_response":{"allOf":[{"$ref":"#/components/schemas/connection_single_response"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/connection_components-schemas-identifier"}}}}}]},"connection_single_request":{"properties":{"enabled":{"$ref":"#/components/schemas/connection_components-schemas-enabled"},"zone":{"properties":{"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}}},"required":["zone"],"type":"object"},"connection_single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"connections":{"description":"The Cloudflare Tunnel connections between your origin and Cloudflare's edge.","items":{"$ref":"#/components/schemas/cloudflare-tunnel_components-schemas-connection"},"type":"array"},"conns_active_at":{"description":"Timestamp of when the tunnel established at least one connection to Cloudflare's edge. If `null`, the tunnel is inactive.","example":"2009-11-10T23:00:00Z","format":"date-time","nullable":true,"type":"string"},"conns_inactive_at":{"description":"Timestamp of when the tunnel became inactive (no connections to Cloudflare's edge). If `null`, the tunnel is active.","example":"2009-11-10T23:00:00Z","format":"date-time","nullable":true,"type":"string"},"consecutive_down":{"default":0,"description":"To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times.","type":"integer"},"consecutive_fails":{"default":1,"description":"The number of consecutive fails required from a health check before changing the health to unhealthy.","type":"integer"},"consecutive_successes":{"default":1,"description":"The number of consecutive successes required from a health check before changing the health to healthy.","type":"integer"},"consecutive_up":{"default":0,"description":"To be marked healthy the monitored origin must pass this healthcheck N consecutive times.","type":"integer"},"consumer":{"properties":{"created_on":{"readOnly":true},"environment":{"readOnly":true},"queue_name":{"readOnly":true},"service":{"readOnly":true},"settings":{"properties":{"batch_size":{"$ref":"#/components/schemas/batch_size"},"max_retries":{"$ref":"#/components/schemas/max_retries"},"max_wait_time_ms":{"$ref":"#/components/schemas/max_wait_time_ms"}},"type":"object"}},"type":"object"},"consumer_created":{"properties":{"created_on":{"readOnly":true},"dead_letter_queue":{"$ref":"#/components/schemas/dlq_name"},"environment":{"readOnly":true},"queue_name":{"readOnly":true},"script_name":{"readOnly":true},"settings":{"properties":{"batch_size":{"$ref":"#/components/schemas/batch_size"},"max_retries":{"$ref":"#/components/schemas/max_retries"},"max_wait_time_ms":{"$ref":"#/components/schemas/max_wait_time_ms"}},"type":"object"}},"type":"object"},"consumer_name":{"example":"example-consumer","type":"string"},"consumer_updated":{"properties":{"created_on":{"readOnly":true},"dead_letter_queue":{"example":"updated-example-dlq"},"environment":{"readOnly":true},"queue_name":{"readOnly":true},"script_name":{"readOnly":true},"settings":{"properties":{"batch_size":{"example":100,"type":"number"},"max_retries":{"$ref":"#/components/schemas/max_retries"},"max_wait_time_ms":{"$ref":"#/components/schemas/max_wait_time_ms"}},"type":"object"}},"type":"object"},"contact_identifier":{"description":"Contact Identifier.","example":"ea95132c15732412d22c1476fa83f27a","maxLength":32,"readOnly":true,"type":"string"},"contact_properties":{"properties":{"address":{"$ref":"#/components/schemas/schemas-address"},"address2":{"$ref":"#/components/schemas/address2"},"city":{"$ref":"#/components/schemas/city"},"country":{"$ref":"#/components/schemas/country-DyJUDEcJ"},"email":{"$ref":"#/components/schemas/email-sNyq81Xd"},"fax":{"$ref":"#/components/schemas/fax"},"first_name":{"$ref":"#/components/schemas/first_name"},"id":{"$ref":"#/components/schemas/contact_identifier"},"last_name":{"$ref":"#/components/schemas/last_name"},"organization":{"$ref":"#/components/schemas/schemas-organization"},"phone":{"$ref":"#/components/schemas/telephone"},"state":{"$ref":"#/components/schemas/contacts_components-schemas-state"},"zip":{"$ref":"#/components/schemas/zipcode"}},"required":["first_name","last_name","address","city","state","zip","country","phone","organization"],"type":"object"},"contacts":{"allOf":[{"$ref":"#/components/schemas/contact_properties"}],"type":"object"},"contacts_components-schemas-state":{"description":"State.","example":"TX","type":"string"},"content_categories":{"description":"Current content categories.","example":[{"id":155,"name":"Technology","super_category_id":26}]},"content_list_action":{"description":"Behavior of the content list.","enum":["block"],"example":"block","type":"string"},"content_list_details":{"properties":{"action":{"$ref":"#/components/schemas/content_list_action"}},"type":"object"},"content_list_details_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/content_list_details"}}}]},"content_list_entries":{"description":"Content list entries.","items":{"$ref":"#/components/schemas/content_list_entry"},"type":"array"},"content_list_entry":{"description":"Content list entry to be blocked.","properties":{"content":{"$ref":"#/components/schemas/content_list_entry_content"},"created_on":{"$ref":"#/components/schemas/timestamp"},"description":{"$ref":"#/components/schemas/content_list_entry_description"},"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"modified_on":{"$ref":"#/components/schemas/timestamp"},"type":{"$ref":"#/components/schemas/content_list_entry_type"}},"type":"object"},"content_list_entry_collection_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"properties":{"entries":{"$ref":"#/components/schemas/content_list_entries"}},"type":"object"}}}]},"content_list_entry_content":{"description":"CID or content path of content to block.","example":"QmPZ9gcCEpqKTo6aq61g2nXGUhM4iCL3ewB6LDXZCtioEB","maxLength":500,"type":"string"},"content_list_entry_create_request":{"properties":{"content":{"$ref":"#/components/schemas/content_list_entry_content"},"description":{"$ref":"#/components/schemas/content_list_entry_description"},"type":{"$ref":"#/components/schemas/content_list_entry_type"}},"required":["type","content"],"type":"object"},"content_list_entry_description":{"description":"An optional description of the content list entry.","example":"this is my content list entry","maxLength":500,"type":"string"},"content_list_entry_single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/content_list_entry"}}}]},"content_list_entry_type":{"description":"Type of content list entry to block.","enum":["cid","content_path"],"example":"cid","type":"string"},"content_list_update_request":{"properties":{"action":{"$ref":"#/components/schemas/content_list_action"},"entries":{"$ref":"#/components/schemas/content_list_entries"}},"required":["action","entries"],"type":"object"},"content_type":{"description":"The content type of the body. Must be one of the following: `text/plain`, `text/xml`, or `application/json`.","example":"text/xml","maxLength":50,"type":"string"},"cookie_attributes":{"description":"Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user's status in the waiting room, such as queue position.","properties":{"samesite":{"default":"auto","description":"Configures the SameSite attribute on the waiting room cookie. Value `auto` will be translated to `lax` or `none` depending if **Always Use HTTPS** is enabled. Note that when using value `none`, the secure attribute cannot be set to `never`.","enum":["auto","lax","none","strict"],"example":"auto","type":"string"},"secure":{"default":"auto","description":"Configures the Secure attribute on the waiting room cookie. Value `always` indicates that the Secure attribute will be set in the Set-Cookie header, `never` indicates that the Secure attribute will not be set, and `auto` will set the Secure attribute depending if **Always Use HTTPS** is enabled.","enum":["auto","always","never"],"example":"auto","type":"string"}},"type":"object"},"cors_headers":{"properties":{"allow_all_headers":{"$ref":"#/components/schemas/allow_all_headers"},"allow_all_methods":{"$ref":"#/components/schemas/allow_all_methods"},"allow_all_origins":{"$ref":"#/components/schemas/allow_all_origins"},"allow_credentials":{"$ref":"#/components/schemas/allow_credentials"},"allowed_headers":{"$ref":"#/components/schemas/allowed_headers"},"allowed_methods":{"$ref":"#/components/schemas/allowed_methods"},"allowed_origins":{"$ref":"#/components/schemas/allowed_origins"},"max_age":{"$ref":"#/components/schemas/max_age"}},"type":"object"},"count":{"description":"The number of items in the List.","example":20,"readOnly":true,"type":"number"},"count-IxGc2iY9":{"description":"Total results returned based on your search parameters.","example":1,"type":"number"},"country":{"description":"Country, provided by the CSR","example":"US","readOnly":true,"type":"string"},"country-DyJUDEcJ":{"description":"The country in which the user lives.","example":"US","maxLength":30,"nullable":true,"type":"string"},"country_configuration":{"properties":{"target":{"description":"The configuration target. You must set the target to `country` when specifying a country code in the rule.","enum":["country"],"example":"country"},"value":{"description":"The two-letter ISO-3166-1 alpha-2 code to match. For more information, refer to [IP Access rules: Parameters](https://developers.cloudflare.com/waf/tools/ip-access-rules/parameters/#country).","example":"US","type":"string"}},"title":"A country configuration."},"country_pools":{"description":"A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding region_pool mapping if it exists else to default_pools.","example":{"GB":["abd90f38ced07c2e2f4df50b1f61d4194"],"US":["de90f38ced07c2e2f4df50b1f61d4194","00920f38ce07c2e2f4df50b1f61d4194"]},"type":"object"},"create":{"properties":{"email":{"$ref":"#/components/schemas/email-sNyq81Xd"},"roles":{"description":"Array of roles associated with this member.","items":{"$ref":"#/components/schemas/role_components-schemas-identifier"},"type":"array"},"status":{"default":"pending","enum":["accepted","pending"]}},"required":["email","roles"],"type":"object"},"create_custom_profile_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/custom_profile"},"type":"array"}}}]},"create_custom_profiles":{"properties":{"profiles":{"items":{"$ref":"#/components/schemas/new_custom_profile"},"required":["name","entries"],"type":"array"}},"required":["profiles"]},"create_destination_address_properties":{"properties":{"email":{"$ref":"#/components/schemas/email-xwlVNguu"}},"required":["email"],"type":"object"},"create_input_request":{"properties":{"defaultCreator":{"$ref":"#/components/schemas/live_input_default_creator"},"meta":{"$ref":"#/components/schemas/live_input_metadata"},"recording":{"$ref":"#/components/schemas/live_input_recording_settings"}}},"create_output_request":{"properties":{"enabled":{"$ref":"#/components/schemas/output_enabled"},"streamKey":{"$ref":"#/components/schemas/output_streamKey"},"url":{"$ref":"#/components/schemas/output_url"}},"required":["url","streamKey"]},"create_payload":{"properties":{"condition":{"$ref":"#/components/schemas/condition"},"expires_on":{"$ref":"#/components/schemas/expires_on-dkbMDCaD"},"name":{"$ref":"#/components/schemas/name-pG4STmz5"},"not_before":{"$ref":"#/components/schemas/not_before"},"policies":{"$ref":"#/components/schemas/policies-iecjppBc"}},"required":["name","policies"],"type":"object"},"create_rename_namespace_body":{"properties":{"title":{"$ref":"#/components/schemas/namespace_title"}},"required":["title"],"type":"object"},"create_request":{"properties":{"description":{"$ref":"#/components/schemas/web3-hostname_components-schemas-description"},"dnslink":{"$ref":"#/components/schemas/dnslink"},"name":{"$ref":"#/components/schemas/web3-hostname_components-schemas-name"},"target":{"$ref":"#/components/schemas/schemas-target"}},"required":["name","target"],"type":"object"},"create_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"client_id":{"$ref":"#/components/schemas/client_id"},"client_secret":{"$ref":"#/components/schemas/client_secret"},"created_at":{"$ref":"#/components/schemas/timestamp"},"id":{"description":"The ID of the service token."},"name":{"$ref":"#/components/schemas/service-tokens_components-schemas-name"},"updated_at":{"$ref":"#/components/schemas/timestamp"}}}}}]},"create_rule":{"properties":{"action":{"$ref":"#/components/schemas/rule_action"},"description":{"$ref":"#/components/schemas/rule_description"},"enabled":{"$ref":"#/components/schemas/rule_enabled"},"expression":{"$ref":"#/components/schemas/rule_expression"}},"required":["action","expression"]},"create_rule_properties":{"properties":{"actions":{"$ref":"#/components/schemas/rule_actions"},"enabled":{"$ref":"#/components/schemas/rule_enabled-VMnvyEOL"},"matchers":{"$ref":"#/components/schemas/rule_matchers"},"name":{"$ref":"#/components/schemas/rule_name"},"priority":{"$ref":"#/components/schemas/rule_priority"}},"required":["actions","matchers"],"type":"object"},"create_ruleset":{"description":"A ruleset object.","properties":{"description":{"$ref":"#/components/schemas/rulesets_components-schemas-description"},"kind":{"$ref":"#/components/schemas/schemas-kind"},"name":{"$ref":"#/components/schemas/rulesets_components-schemas-name"},"phase":{"$ref":"#/components/schemas/phase"},"rules":{"$ref":"#/components/schemas/create_update_rules"}},"required":["name","kind","phase","rules"],"type":"object"},"create_update_rule":{"description":"A rule object.","properties":{"action":{"$ref":"#/components/schemas/rules_components-schemas-action"},"action_parameters":{"$ref":"#/components/schemas/action_parameters"},"description":{"$ref":"#/components/schemas/rules_components-schemas-description"},"enabled":{"$ref":"#/components/schemas/rules_components-schemas-enabled"},"expression":{"$ref":"#/components/schemas/schemas-expression"},"logging":{"$ref":"#/components/schemas/logging"},"ref":{"$ref":"#/components/schemas/components-schemas-ref"}},"required":["expression","action"],"type":"object"},"create_update_rules":{"description":"The list of rules in the ruleset.","items":{"anyOf":[{"$ref":"#/components/schemas/create_update_rule"},{"description":"The unique ID of a rule."}]},"type":"array"},"created":{"description":"When the Application was created.","example":"2014-01-02T02:20:00Z","format":"date-time","readOnly":true,"type":"string"},"created-GBc463rN":{"description":"The date and time the media item was created.","example":"2014-01-02T02:20:00Z","format":"date-time","readOnly":true,"type":"string"},"created-UVGJEhhU":{"description":"The date and time the destination address has been created.","example":"2014-01-02T02:20:00Z","format":"date-time","readOnly":true,"type":"string"},"created-lduEKfk7":{"description":"When the device was created.","example":"2017-06-14T00:00:00Z","format":"date-time","type":"string"},"created-on":{"example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string"},"created_at":{"description":"This is the time the hostname was created.","example":"2020-02-06T18:11:23.531995Z","format":"date-time","type":"string"},"created_on":{"description":"When the route was created.","example":"2017-06-14T00:00:00Z","format":"date-time","readOnly":true,"type":"string"},"created_on-k2n1y7eG":{"description":"The timestamp of when the rule was created.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string"},"created_on-kB9fypz8":{"description":"The timestamp of when the Page Rule was created.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string"},"created_on-tz4RTlxL":{"description":"When the script was created.","example":"2017-01-01T00:00:00Z","format":"date-time","readOnly":true,"type":"string"},"creator":{"description":"A user-defined identifier for the media creator.","example":"creator-id_abcde12345","maxLength":64,"type":"string"},"cron-trigger-response-collection":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"properties":{"schedules":{"items":{"properties":{"created_on":{"readOnly":true},"cron":{"readOnly":true},"modified_on":{"readOnly":true}}},"type":"array"}},"type":"object"}}}]},"crowdstrike_config_request":{"properties":{"api_url":{"description":"The Crowdstrike API URL.","example":"https://api.us-2.crowdstrike.com","type":"string"},"client_id":{"description":"The Crowdstrike client ID.","example":"example client id","type":"string"},"client_secret":{"description":"The Crowdstrike client secret.","example":"example client secret","type":"string"},"customer_id":{"description":"The Crowdstrike customer ID.","example":"example customer id","type":"string"}},"required":["api_url","customer_id","client_id","client_secret"],"type":"object"},"csr":{"description":"The Certificate Signing Request (CSR). Must be newline-encoded.","example":"-----BEGIN CERTIFICATE REQUEST-----\nMIICxzCCAa8CAQAwSDELMAkGA1UEBhMCVVMxFjAUBgNVBAgTDVNhbiBGcmFuY2lz\nY28xCzAJBgNVBAcTAkNBMRQwEgYDVQQDEwtleGFtcGxlLm5ldDCCASIwDQYJKoZI\nhvcNAQEBBQADggEPADCCAQoCggEBALxejtu4b+jPdFeFi6OUsye8TYJQBm3WfCvL\nHu5EvijMO/4Z2TImwASbwUF7Ir8OLgH+mGlQZeqyNvGoSOMEaZVXcYfpR1hlVak8\n4GGVr+04IGfOCqaBokaBFIwzclGZbzKmLGwIQioNxGfqFm6RGYGA3be2Je2iseBc\nN8GV1wYmvYE0RR+yWweJCTJ157exyRzu7sVxaEW9F87zBQLyOnwXc64rflXslRqi\ng7F7w5IaQYOl8yvmk/jEPCAha7fkiUfEpj4N12+oPRiMvleJF98chxjD4MH39c5I\nuOslULhrWunfh7GB1jwWNA9y44H0snrf+xvoy2TcHmxvma9Eln8CAwEAAaA6MDgG\nCSqGSIb3DQEJDjErMCkwJwYDVR0RBCAwHoILZXhhbXBsZS5uZXSCD3d3dy5leGFt\ncGxlLm5ldDANBgkqhkiG9w0BAQsFAAOCAQEAcBaX6dOnI8ncARrI9ZSF2AJX+8mx\npTHY2+Y2C0VvrVDGMtbBRH8R9yMbqWtlxeeNGf//LeMkSKSFa4kbpdx226lfui8/\nauRDBTJGx2R1ccUxmLZXx4my0W5iIMxunu+kez+BDlu7bTT2io0uXMRHue4i6quH\nyc5ibxvbJMjR7dqbcanVE10/34oprzXQsJ/VmSuZNXtjbtSKDlmcpw6To/eeAJ+J\nhXykcUihvHyG4A1m2R6qpANBjnA0pHexfwM/SgfzvpbvUg0T1ubmer8BgTwCKIWs\ndcWYTthM51JIqRBfNqy4QcBnX+GY05yltEEswQI55wdiS3CjTTA67sdbcQ==\n-----END CERTIFICATE REQUEST-----","type":"string"},"currency":{"description":"The monetary unit in which pricing information is displayed.","example":"USD","readOnly":true,"type":"string"},"current":{"description":"Cloudflare Images current usage.","example":1000,"readOnly":true,"type":"number"},"current_period_end":{"description":"The end of the current period and also when the next billing is due.","example":"2014-03-31T12:20:00Z","format":"date-time","readOnly":true,"type":"string"},"current_period_start":{"description":"When the current billing period started. May match initial_period_start if this is the first period.","example":"2014-05-11T12:20:00Z","format":"date-time","readOnly":true,"type":"string"},"current_registrar":{"description":"Shows name of current registrar.","example":"Cloudflare","type":"string"},"cursor":{"description":"Opaque token indicating the position from which to continue when requesting the next set of records if the amount of list results was limited by the limit parameter. A valid value for the cursor can be obtained from the cursors object in the result_info structure.","example":"6Ck1la0VxJ0djhidm1MdX2FyDGxLKVeeHZZmORS_8XeSuhz9SjIJRaSa2lnsF01tQOHrfTGAP3R5X1Kv5iVUuMbNKhWNAXHOl6ePB0TUL8nw","type":"string"},"custom-certificate":{"properties":{"bundle_method":{"$ref":"#/components/schemas/bundle_method"},"expires_on":{"$ref":"#/components/schemas/expires_on"},"geo_restrictions":{"$ref":"#/components/schemas/geo_restrictions"},"hosts":{"$ref":"#/components/schemas/hosts"},"id":{"$ref":"#/components/schemas/identifier-tZwYoMuc"},"issuer":{"$ref":"#/components/schemas/issuer"},"keyless_server":{"$ref":"#/components/schemas/keyless-certificate"},"modified_on":{"$ref":"#/components/schemas/modified_on-t5RPC3jV"},"policy":{"$ref":"#/components/schemas/policy"},"priority":{"$ref":"#/components/schemas/priority-Cl6RAKfI"},"signature":{"$ref":"#/components/schemas/signature"},"status":{"$ref":"#/components/schemas/status-dMauZcAv"},"uploaded_on":{"$ref":"#/components/schemas/uploaded_on"},"zone_id":{"$ref":"#/components/schemas/identifier-tZwYoMuc"}},"required":["id","hosts","issuer","signature","status","bundle_method","zone_id","uploaded_on","modified_on","expires_on","priority"],"type":"object"},"custom-certificate-CaAadyYf":{"properties":{"bundle_method":{"$ref":"#/components/schemas/bundle_method"},"expires_on":{"$ref":"#/components/schemas/components-schemas-expires_on-KIWqadEQ"},"geo_restrictions":{"$ref":"#/components/schemas/geo_restrictions"},"hosts":{"$ref":"#/components/schemas/hosts"},"id":{"$ref":"#/components/schemas/custom-certificate_components-schemas-identifier"},"issuer":{"$ref":"#/components/schemas/issuer"},"keyless_server":{"$ref":"#/components/schemas/keyless-certificate-1A90AEZs"},"modified_on":{"$ref":"#/components/schemas/schemas-modified_on-lfwlFlJl"},"policy":{"$ref":"#/components/schemas/policy"},"priority":{"$ref":"#/components/schemas/priority-eLZLlpCp"},"signature":{"$ref":"#/components/schemas/signature"},"status":{"$ref":"#/components/schemas/custom-certificate_components-schemas-status"},"uploaded_on":{"$ref":"#/components/schemas/uploaded_on"},"zone_id":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},"required":["id","hosts","issuer","signature","status","bundle_method","zone_id","uploaded_on","modified_on","expires_on","priority"],"type":"object"},"custom-certificate-settings":{"description":"Custom certificate settings for BYO-PKI.","properties":{"binding_status":{"description":"Certificate status (internal)","example":"pending_deployment","readOnly":true,"type":"string"},"enabled":{"description":"Enable use of custom certificate authority for signing Gateway traffic","example":true,"type":"boolean"},"id":{"description":"UUID of certificate (ID from MTLS certificate store)","example":"d1b364c5-1311-466e-a194-f0e943e0799f","type":"string"},"updated_at":{"format":"date-time","readOnly":true,"type":"string"}},"required":["enabled"],"type":"object"},"custom-certificate_components-schemas-identifier":{"description":"Custom certificate identifier tag.","example":"2458ce5a-0c35-4c7f-82c7-8e9487d3ff60","maxLength":36,"readOnly":true,"type":"string"},"custom-certificate_components-schemas-status":{"description":"Status of the zone's custom SSL.","enum":["active","expired","deleted","pending","initializing"],"example":"active","readOnly":true},"custom-error-responses_components-schemas-rule":{"properties":{"action":{"example":"serve_error"},"action_parameters":{"$ref":"#/components/schemas/action_parameters_serve_error"},"description":{"example":"Change error response based on geolocation"},"expression":{"example":"ip.geoip.country eq \"AL\""},"id":{"example":"3a03d665bac047339bb530ecb439a90d"},"version":{"example":"1"}}},"custom-error-responses_components-schemas-ruleset":{"properties":{"description":{"example":""},"id":{"example":"2f2feab2026849078ba485f918791bdc"},"kind":{"example":"zone"},"name":{"example":"default"},"phase":{"example":"http_custom_errors"},"rules":{"description":"The rules in the ruleset.","items":{"$ref":"#/components/schemas/custom-error-responses_components-schemas-rule"},"type":"array"}}},"custom-hostname":{"allOf":[{"$ref":"#/components/schemas/customhostname"}],"properties":{"hostname":{"$ref":"#/components/schemas/hostname"},"id":{"$ref":"#/components/schemas/identifier-tZwYoMuc"},"ssl":{"$ref":"#/components/schemas/ssl-EYx9hEKp"}},"required":["id","hostname","ssl"],"type":"object"},"custom-hostname-uOayu9cz":{"allOf":[{"$ref":"#/components/schemas/customhostname-lyk2K3mE"}],"properties":{"hostname":{"$ref":"#/components/schemas/hostname"},"id":{"$ref":"#/components/schemas/custom-hostname_components-schemas-identifier"},"ssl":{"$ref":"#/components/schemas/ssl-UwTUGHGu"}},"required":["id","hostname","ssl"],"type":"object"},"custom-hostname_components-schemas-identifier":{"description":"Custom hostname identifier tag.","example":"0d89c70d-ad9f-4843-b99f-6cc0252067e9","maxLength":36,"minLength":36,"readOnly":true,"type":"string"},"custom-hostname_components-schemas-status":{"description":"Status of the hostname's activation.","enum":["active","pending","active_redeploying","moved","pending_deletion","deleted","pending_blocked","pending_migration","pending_provisioned","test_pending","test_active","test_active_apex","test_blocked","test_failed","provisioned","blocked"],"example":"pending"},"custom-pages_components-schemas-identifier":{"description":"The name of the custom page type.","enum":["basic_challenge","managed_challenge","waf_block","ratelimit_block","country_challenge","ip_block","under_attack","500_errors","1000_errors"],"example":"basic_challenge","readOnly":true},"custom-pages_components-schemas-identifier-2":{"description":"The name of the custom page type.","enum":["basic_challenge","managed_challenge","waf_block","country_challenge","ip_block","under_attack","ratelimit_block","500_errors","1000_errors"],"example":"basic_challenge","readOnly":true},"custom_deny_message":{"description":"The custom error message shown to a user when they are denied access to the application.","type":"string"},"custom_deny_url":{"description":"The custom URL a user is redirected to when they are denied access to the application.","type":"string"},"custom_entry":{"description":"A custom entry that matches a profile","properties":{"created_at":{"$ref":"#/components/schemas/timestamp"},"enabled":{"description":"Whether the entry is enabled or not.","example":true,"type":"boolean"},"id":{"$ref":"#/components/schemas/entry_id"},"name":{"description":"The name of the entry.","example":"Credit card (Visa)","type":"string"},"pattern":{"$ref":"#/components/schemas/pattern"},"profile_id":{"description":"ID of the parent profile"},"updated_at":{"$ref":"#/components/schemas/timestamp"}},"title":"Custom entry","type":"object"},"custom_entry-jOfsrCYH":{"description":"A custom entry that matches a profile","properties":{"created_at":{"$ref":"#/components/schemas/timestamp"},"enabled":{"description":"Whether the entry is enabled or not.","example":true,"type":"boolean"},"id":{"$ref":"#/components/schemas/entry_id-A2p6ZYit"},"name":{"description":"The name of the entry.","example":"Credit card (Visa)","type":"string"},"pattern":{"$ref":"#/components/schemas/components-schemas-pattern"},"profile_id":{"description":"ID of the parent profile"},"updated_at":{"$ref":"#/components/schemas/timestamp"}},"title":"Custom entry","type":"object"},"custom_hostname_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/custom-hostname-uOayu9cz"},"type":"array"}}}]},"custom_hostname_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/custom-hostname"}],"type":"object"}}}]},"custom_hostname_response_single-sVpYaC2x":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"custom_metadata":{"anyOf":[{"properties":{"key":{"description":"Unique metadata for this hostname.","example":"value","type":"string"}},"type":"object"}],"description":"These are per-hostname (customer) settings.","type":"object"},"custom_origin_server":{"description":"a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME record.","example":"origin2.example.com","type":"string"},"custom_origin_sni":{"description":"A hostname that will be sent to your custom origin server as SNI for TLS handshake. This can be a valid subdomain of the zone or custom origin server name or the string ':request_host_header:' which will cause the host header in the request to be used as SNI. Not configurable with default/fallback origin server.","example":"sni.example.com","type":"string"},"custom_page_html":{"default":"","description":"Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custom_page_html is provided, the default waiting room will be used. The template is based on mustache ( https://mustache.github.io/ ). There are several variables that are evaluated by the Cloudflare edge:\n1. {{`waitTimeKnown`}} Acts like a boolean value that indicates the behavior to take when wait time is not available, for instance when queue_all is **true**. \n2. {{`waitTimeFormatted`}} Estimated wait time for the user. For example, five minutes. Alternatively, you can use: \n3. {{`waitTime`}} Number of minutes of estimated wait for a user.\n4. {{`waitTimeHours`}} Number of hours of estimated wait for a user (`Math.floor(waitTime/60)`). \n5. {{`waitTimeHourMinutes`}} Number of minutes above the `waitTimeHours` value (`waitTime%60`). \n6. {{`queueIsFull`}} Changes to **true** when no more people can be added to the queue.\n\nTo view the full list of variables, look at the `cfWaitingRoom` object described under the `json_response_enabled` property in other Waiting Room API calls.","example":"{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Queue all enabled {{/waitTimeKnown}}","type":"string"},"custom_pages_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"type":"object"},"type":"array"}}}]},"custom_pages_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"custom_profile":{"properties":{"allowed_match_count":{"$ref":"#/components/schemas/allowed_match_count"},"created_at":{"$ref":"#/components/schemas/timestamp"},"description":{"description":"The description of the profile.","example":"A standard CVV card number","type":"string"},"entries":{"description":"The entries for this profile.","items":{"$ref":"#/components/schemas/custom_entry-jOfsrCYH"},"type":"array"},"id":{"$ref":"#/components/schemas/profile_id-JwqwymCp"},"name":{"description":"The name of the profile.","example":"Generic CVV Card Number","type":"string"},"type":{"description":"The type of the profile.","enum":["custom"],"example":"custom","type":"string"},"updated_at":{"$ref":"#/components/schemas/timestamp"}},"title":"Custom profile","type":"object"},"custom_profile_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/custom_profile"}]}}}]},"custom_response":{"anyOf":[{"properties":{"body":{"$ref":"#/components/schemas/body"},"content_type":{"$ref":"#/components/schemas/content_type"}},"type":"object"}],"description":"A custom content type and reponse to return when the threshold is exceeded. The custom response configured in this object will override the custom error for the zone. This object is optional.\nNotes: If you omit this object, Cloudflare will use the default HTML error page. If \"mode\" is \"challenge\", \"managed_challenge\", or \"js_challenge\", Cloudflare will use the zone challenge pages and you should not provide the \"response\" object.","type":"object"},"customer_gre_endpoint":{"description":"The IP address assigned to the customer side of the GRE tunnel.","example":"203.0.113.1","type":"string"},"customer_ipsec_endpoint":{"description":"The IP address assigned to the customer side of the IPsec tunnel.","example":"203.0.113.1","type":"string"},"customhostname":{"properties":{"created_at":{"$ref":"#/components/schemas/created_at"},"custom_metadata":{"$ref":"#/components/schemas/custom_metadata"},"custom_origin_server":{"$ref":"#/components/schemas/custom_origin_server"},"custom_origin_sni":{"$ref":"#/components/schemas/custom_origin_sni"},"hostname":{"$ref":"#/components/schemas/hostname"},"id":{"$ref":"#/components/schemas/identifier-tZwYoMuc"},"ownership_verification":{"$ref":"#/components/schemas/ownership_verification"},"ownership_verification_http":{"$ref":"#/components/schemas/ownership_verification_http"},"ssl":{"$ref":"#/components/schemas/ssl-EYx9hEKp"},"status":{"$ref":"#/components/schemas/components-schemas-status"},"verification_errors":{"$ref":"#/components/schemas/verification_errors"}}},"customhostname-lyk2K3mE":{"properties":{"created_at":{"$ref":"#/components/schemas/created_at"},"custom_metadata":{"$ref":"#/components/schemas/custom_metadata"},"custom_origin_server":{"$ref":"#/components/schemas/custom_origin_server"},"custom_origin_sni":{"$ref":"#/components/schemas/custom_origin_sni"},"hostname":{"$ref":"#/components/schemas/hostname"},"id":{"$ref":"#/components/schemas/custom-hostname_components-schemas-identifier"},"ownership_verification":{"$ref":"#/components/schemas/ownership_verification"},"ownership_verification_http":{"$ref":"#/components/schemas/ownership_verification_http"},"ssl":{"$ref":"#/components/schemas/ssl-UwTUGHGu"},"status":{"$ref":"#/components/schemas/custom-hostname_components-schemas-status"},"verification_errors":{"$ref":"#/components/schemas/verification_errors"}}},"dashboard":{"description":"Totals and timeseries data.","properties":{"timeseries":{"$ref":"#/components/schemas/timeseries"},"totals":{"$ref":"#/components/schemas/totals"}},"title":"Dashboard response","type":"object"},"dashboard_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"query":{"$ref":"#/components/schemas/query_response"},"result":{"$ref":"#/components/schemas/dashboard"}}}]},"data":{"description":"Array with one row per combination of dimension values.","items":{"properties":{"dimensions":{"description":"Array of dimension values, representing the combination of dimension values corresponding to this row.","items":{"description":"Dimension value.","example":"NODATA","type":"string"},"type":"array"}},"required":["dimensions"],"type":"object"},"type":"array"},"data_points":{"description":"The number of data points used for the threshold suggestion calculation.","readOnly":true,"type":"integer"},"datacenters":{"description":"A breakdown of all dashboard analytics data by co-locations. This is limited to Enterprise zones only.","items":{"properties":{"colo_id":{"description":"The airport code identifer for the co-location.","example":"SFO","type":"string"},"timeseries":{"$ref":"#/components/schemas/timeseries_by_colo"},"totals":{"$ref":"#/components/schemas/totals_by_colo"}},"type":"object"},"title":"Analytics data by datacenter","type":"array"},"dataset":{"description":"Name of the dataset.","example":"http_requests","maxLength":256,"nullable":true,"pattern":"^[a-zA-Z0-9_\\-]*$","type":"string"},"days_until_next_rotation":{"description":"The number of days until the next key rotation.","example":1,"readOnly":true,"type":"number"},"decision":{"description":"The action Access will take if a user matches this policy.","enum":["allow","deny","non_identity","bypass"],"example":"allow","type":"string"},"default":{"description":"The default amount allocated.","example":5,"type":"number"},"default-VASQNGRU":{"description":"Whether the policy is the default policy for an account.","example":false,"type":"boolean"},"default_device_settings_policy":{"properties":{"allow_mode_switch":{"$ref":"#/components/schemas/allow_mode_switch"},"allow_updates":{"$ref":"#/components/schemas/allow_updates"},"allowed_to_leave":{"$ref":"#/components/schemas/allowed_to_leave"},"auto_connect":{"$ref":"#/components/schemas/auto_connect"},"captive_portal":{"$ref":"#/components/schemas/captive_portal"},"default":{"description":"Whether the policy will be applied to matching devices.","example":true,"type":"boolean"},"disable_auto_fallback":{"$ref":"#/components/schemas/disable_auto_fallback"},"enabled":{"description":"Whether the policy will be applied to matching devices.","example":true,"type":"boolean"},"exclude":{"$ref":"#/components/schemas/components-schemas-exclude"},"exclude_office_ips":{"$ref":"#/components/schemas/exclude_office_ips"},"fallback_domains":{"$ref":"#/components/schemas/fallback_domains"},"gateway_unique_id":{"$ref":"#/components/schemas/gateway_unique_id"},"include":{"$ref":"#/components/schemas/schemas-include"},"service_mode_v2":{"$ref":"#/components/schemas/service_mode_v2"},"support_url":{"$ref":"#/components/schemas/support_url"},"switch_locked":{"$ref":"#/components/schemas/switch_locked"}},"type":"object"},"default_device_settings_policy-kZzKyPpc":{"properties":{"allow_mode_switch":{"$ref":"#/components/schemas/allow_mode_switch"},"allow_updates":{"$ref":"#/components/schemas/allow_updates"},"allowed_to_leave":{"$ref":"#/components/schemas/allowed_to_leave"},"auto_connect":{"$ref":"#/components/schemas/auto_connect"},"captive_portal":{"$ref":"#/components/schemas/captive_portal"},"default":{"description":"Whether the policy will be applied to matching devices.","example":true,"type":"boolean"},"disable_auto_fallback":{"$ref":"#/components/schemas/disable_auto_fallback"},"enabled":{"description":"Whether the policy will be applied to matching devices.","example":true,"type":"boolean"},"exclude":{"$ref":"#/components/schemas/exclude-tYW3UmZW"},"exclude_office_ips":{"$ref":"#/components/schemas/exclude_office_ips"},"fallback_domains":{"$ref":"#/components/schemas/fallback_domains"},"gateway_unique_id":{"$ref":"#/components/schemas/gateway_unique_id"},"include":{"$ref":"#/components/schemas/include-9GPmbbUN"},"service_mode_v2":{"$ref":"#/components/schemas/service_mode_v2"},"support_url":{"$ref":"#/components/schemas/support_url"},"switch_locked":{"$ref":"#/components/schemas/switch_locked"}},"type":"object"},"default_device_settings_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/default_device_settings_policy-kZzKyPpc"}}}]},"default_mode":{"description":"The default action/mode of a rule.","enum":["disable","simulate","block","challenge"],"example":"block","readOnly":true},"default_pools":{"description":"A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.","example":["17b5962d775c646f3f9725cbc7a53df4","9290f38c5d07c2e2f4df57b1f61d4196","00920f38ce07c2e2f4df50b1f61d4194"],"items":{"description":"A pool ID.","type":"string"},"type":"array"},"default_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"}]},"default_sni":{"description":"If you have legacy TLS clients which do not send the TLS server name indicator, then you can specify one default SNI on the map. If Cloudflare receives a TLS handshake from a client without an SNI, it will respond with the default SNI on those IPs. The default SNI can be any valid zone or subdomain owned by the account.","example":"*.example.com","nullable":true,"type":"string"},"default_template_language":{"default":"en-US","description":"The language of the default page template. If no default_template_language is provided, then `en-US` (English) will be used.","enum":["en-US","es-ES","de-DE","fr-FR","it-IT","ja-JP","ko-KR","pt-BR","zh-CN","zh-TW","nl-NL","pl-PL","id-ID","tr-TR","ar-EG","ru-RU","fa-IR"],"example":"es-ES","type":"string"},"delegated_account_identifier":{"description":"Account identifier for the account to which prefix is being delegated.","example":"b1946ac92492d2347c6235b4d2611184","maxLength":32,"type":"string"},"delegated_account_identifier-hmTz3KXe":{"description":"Account identifier for the account to which prefix is being delegated.","example":"b1946ac92492d2347c6235b4d2611184","maxLength":32,"readOnly":true,"type":"string"},"delegation_identifier":{"description":"Delegation identifier tag.","example":"d933b1530bc56c9953cf8ce166da8004","maxLength":32,"readOnly":true,"type":"string"},"delete_advanced_certificate_pack_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/identifier-tZwYoMuc"}},"type":"object"}},"type":"object"}]},"delete_advanced_certificate_pack_response_single-AepvbdfN":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/certificate-packs_components-schemas-identifier"}},"type":"object"}},"type":"object"}]},"delete_dnssec_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"example":"","type":"string"}}}]},"delete_filter_if_unused":{"description":"When true, indicates that Cloudflare should also delete the associated filter if there are no other firewall rules referencing the filter.","type":"boolean"},"deleted":{"description":"When true, indicates that the firewall rule was deleted.","example":true,"type":"boolean"},"deleted-filter":{"additionalProperties":false,"properties":{"deleted":{"$ref":"#/components/schemas/deleted"},"id":{"$ref":"#/components/schemas/filters_components-schemas-id"}},"required":["id","deleted"]},"deleted-gN7SICJB":{"description":"True if the device was deleted.","example":true,"type":"boolean"},"deleted_at":{"description":"Date of deletion, if any.","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"deleted_at-5nLnuPfs":{"description":"Timestamp of when the tunnel was deleted. If `null`, the tunnel has not been deleted.","example":"2009-11-10T23:00:00Z","format":"date-time","nullable":true,"type":"string"},"deleted_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"example":{},"type":"object"}}}]},"deleted_response-7kko7sFR":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"example":"ok","type":"string"}}}]},"deployment-list-response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result_info":{"properties":{"count":{"example":1},"page":{"example":1},"per_page":{"example":100},"total_count":{"example":1}},"type":"object"}}},{"properties":{"result":{"items":{"$ref":"#/components/schemas/deployments"},"type":"array"}}}]},"deployment-new-deployment":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/deployments"}}}]},"deployment-response-details":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/deployments"}}}]},"deployment-response-logs":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"example":{"data":[{"line":"Cloning repository...","ts":"2021-04-20T19:35:29.0749819Z"},{"line":"From https://github.com/cloudflare/example","ts":"2021-04-20T19:35:30.0749819Z"},{"line":" * branch 209c5bb11d89533f426b2f8469bcae12fdccf71b -\u003e FETCH_HEAD","ts":"2021-04-20T19:35:30.0749819Z"},{"line":"","ts":"2021-04-20T19:35:30.0749819Z"},{"line":"HEAD is now at 209c5bb Update index.html","ts":"2021-04-20T19:35:30.0749819Z"},{"line":"","ts":"2021-04-20T19:35:30.0749819Z"},{"line":"","ts":"2021-04-20T19:35:30.0749819Z"},{"line":"Success: Finished cloning repository files","ts":"2021-04-20T19:35:30.0749819Z"},{"line":"Installing dependencies","ts":"2021-04-20T19:35:59.0749819Z"},{"line":"Python version set to 2.7","ts":"2021-04-20T19:35:59.0931208Z"},{"line":"v12.18.0 is already installed.","ts":"2021-04-20T19:36:02.2369501Z"},{"line":"Now using node v12.18.0 (npm v6.14.4)","ts":"2021-04-20T19:36:02.6028886Z"},{"line":"Started restoring cached build plugins","ts":"2021-04-20T19:36:02.624555Z"},{"line":"Finished restoring cached build plugins","ts":"2021-04-20T19:36:02.6340688Z"},{"line":"Attempting ruby version 2.7.1, read from environment","ts":"2021-04-20T19:36:02.963095Z"},{"line":"Using ruby version 2.7.1","ts":"2021-04-20T19:36:04.2236084Z"},{"line":"Using PHP version 5.6","ts":"2021-04-20T19:36:04.5450152Z"},{"line":"5.2 is already installed.","ts":"2021-04-20T19:36:04.5740509Z"},{"line":"Using Swift version 5.2","ts":"2021-04-20T19:36:04.577035Z"},{"line":"Installing Hugo 0.54.0","ts":"2021-04-20T19:36:04.5771615Z"},{"line":"Hugo Static Site Generator v0.54.0-B1A82C61A/extended linux/amd64 BuildDate: 2019-02-01T10:04:38Z","ts":"2021-04-20T19:36:05.4786868Z"},{"line":"Started restoring cached go cache","ts":"2021-04-20T19:36:05.4794366Z"},{"line":"Finished restoring cached go cache","ts":"2021-04-20T19:36:05.481977Z"},{"line":"go version go1.14.4 linux/amd64","ts":"2021-04-20T19:36:05.9049776Z"},{"line":"go version go1.14.4 linux/amd64","ts":"2021-04-20T19:36:05.9086053Z"},{"line":"Installing missing commands","ts":"2021-04-20T19:36:05.9163568Z"},{"line":"Verify run directory","ts":"2021-04-20T19:36:05.9163934Z"},{"line":"Executing user command: echo \"skipping build step: no build command specified\"","ts":"2021-04-20T19:36:05.9164636Z"},{"line":"skipping build step: no build command specified","ts":"2021-04-20T19:36:05.9165087Z"},{"line":"Finished","ts":"2021-04-20T19:36:05.917412Z"}],"includes_container_logs":true,"total":30},"type":"object"}}}]},"deployment-response-stage-logs":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"example":{"data":[{"id":15,"message":"Installing dependencies","timestamp":"2021-04-20T19:35:59.0749819Z"},{"id":16,"message":"Python version set to 2.7","timestamp":"2021-04-20T19:35:59.0931208Z"},{"id":17,"message":"v12.18.0 is already installed.","timestamp":"2021-04-20T19:36:02.2369501Z"},{"id":18,"message":"Now using node v12.18.0 (npm v6.14.4)","timestamp":"2021-04-20T19:36:02.6028886Z"},{"id":19,"message":"Started restoring cached build plugins","timestamp":"2021-04-20T19:36:02.624555Z"},{"id":20,"message":"Finished restoring cached build plugins","timestamp":"2021-04-20T19:36:02.6340688Z"},{"id":21,"message":"Attempting ruby version 2.7.1, read from environment","timestamp":"2021-04-20T19:36:02.963095Z"},{"id":22,"message":"Using ruby version 2.7.1","timestamp":"2021-04-20T19:36:04.2236084Z"},{"id":23,"message":"Using PHP version 5.6","timestamp":"2021-04-20T19:36:04.5450152Z"},{"id":24,"message":"5.2 is already installed.","timestamp":"2021-04-20T19:36:04.5740509Z"},{"id":25,"message":"Using Swift version 5.2","timestamp":"2021-04-20T19:36:04.577035Z"},{"id":26,"message":"Installing Hugo 0.54.0","timestamp":"2021-04-20T19:36:04.5771615Z"},{"id":27,"message":"Hugo Static Site Generator v0.54.0-B1A82C61A/extended linux/amd64 BuildDate: 2019-02-01T10:04:38Z","timestamp":"2021-04-20T19:36:05.4786868Z"},{"id":28,"message":"Started restoring cached go cache","timestamp":"2021-04-20T19:36:05.4794366Z"},{"id":29,"message":"Finished restoring cached go cache","timestamp":"2021-04-20T19:36:05.481977Z"},{"id":30,"message":"go version go1.14.4 linux/amd64","timestamp":"2021-04-20T19:36:05.9049776Z"},{"id":31,"message":"go version go1.14.4 linux/amd64","timestamp":"2021-04-20T19:36:05.9086053Z"},{"id":32,"message":"Installing missing commands","timestamp":"2021-04-20T19:36:05.9163568Z"},{"id":33,"message":"Verify run directory","timestamp":"2021-04-20T19:36:05.9163934Z"},{"id":34,"message":"Executing user command: echo \"skipping build step: no build command specified\"","timestamp":"2021-04-20T19:36:05.9164636Z"},{"id":35,"message":"skipping build step: no build command specified","timestamp":"2021-04-20T19:36:05.9165087Z"},{"id":36,"message":"Finished","timestamp":"2021-04-20T19:36:05.917412Z"}],"end":37,"ended_on":"2021-04-20T19:36:06.38889Z","name":"build","start":0,"started_on":"2021-04-20T19:35:58.238757Z","status":"success","total":37},"type":"object"}}}]},"deployment_configs":{"description":"Configs for deployments in a project.","properties":{"preview":{"anyOf":[{"$ref":"#/components/schemas/deployment_configs_values"}],"description":"Configs for preview deploys.","type":"object"},"production":{"anyOf":[{"$ref":"#/components/schemas/deployment_configs_values"}],"description":"Configs for production deploys.","type":"object"}},"type":"object"},"deployment_configs_values":{"properties":{"compatibility_date":{"description":"Compatibility date used for Pages Functions.","example":"2022-01-01","type":"string"},"compatibility_flags":{"description":"Compatibility flags used for Pages Functions.","example":["url_standard"],"type":"array"},"d1_databases":{"description":"D1 databases used for Pages Functions.","nullable":true,"properties":{"D1_BINDING":{"description":"D1 binding.","example":{"id":"445e2955-951a-43f8-a35b-a4d0c8138f63"},"properties":{"id":{"description":"UUID of the D1 database.","example":"445e2955-951a-43f8-a35b-a4d0c8138f63","type":"string"}},"type":"object"}},"type":"object"},"durable_object_namespaces":{"description":"Durabble Object namespaces used for Pages Functions.","nullable":true,"properties":{"DO_BINDING":{"description":"Durabble Object binding.","example":{"namespace_id":"5eb63bbbe01eeed093cb22bb8f5acdc3"},"properties":{"namespace_id":{"description":"ID of the Durabble Object namespace.","example":"5eb63bbbe01eeed093cb22bb8f5acdc3","type":"string"}},"type":"object"}},"type":"object"},"env_vars":{"description":"Environment variables for build configs.","nullable":true,"properties":{"ENVIRONMENT_VARIABLE":{"description":"Environment variable.","example":{"type":"plain_text","value":"hello world"},"properties":{"type":{"description":"The type of environment variable (plain text or secret)","enum":["plain_text","secret_text"],"type":"string"},"value":{"description":"Environment variable value.","type":"string"}},"type":"object"}},"type":"object"},"kv_namespaces":{"description":"KV namespaces used for Pages Functions.","properties":{"KV_BINDING":{"description":"KV binding.","example":{"namespace_id":"5eb63bbbe01eeed093cb22bb8f5acdc3"},"properties":{"namespace_id":{"description":"ID of the KV namespace.","example":"5eb63bbbe01eeed093cb22bb8f5acdc3","type":"string"}},"type":"object"}},"type":"object"},"queue_producers":{"description":"Queue Producer bindings used for Pages Functions.","nullable":true,"properties":{"QUEUE_PRODUCER_BINDING":{"description":"Queue Producer binding.","example":{"name":"some-queue"},"properties":{"name":{"description":"Name of the Queue.","example":"some-queue","type":"string"}},"type":"object"}},"type":"object"},"r2_buckets":{"description":"R2 buckets used for Pages Functions.","nullable":true,"properties":{"R2_BINDING":{"description":"R2 binding.","example":{"name":"some-bucket"},"properties":{"name":{"description":"Name of the R2 bucket.","example":"some-bucket","type":"string"}},"type":"object"}},"type":"object"},"service_bindings":{"description":"Services used for Pages Functions.","nullable":true,"properties":{"SERVICE_BINDING":{"description":"Service binding.","example":{"environment":"production","service":"example-worker"},"properties":{"environment":{"description":"The Service environment.","type":"string"},"service":{"description":"The Service name.","type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"deployment_identifier":{"example":"bcf48806-b317-4351-9ee7-36e7d557d4de","maxLength":36,"readOnly":true,"type":"string"},"deployment_stage_name":{"description":"Deployment stage name.","example":"deploy","pattern":"queued|initialize|clone_repo|build|deploy","type":"string"},"deployments":{"properties":{"aliases":{"description":"A list of alias URLs pointing to this deployment.","example":["https://branchname.projectname.pages.dev"],"items":{},"nullable":true,"readOnly":true,"type":"array"},"build_config":{"readOnly":true},"created_on":{"description":"When the deployment was created.","example":"2021-03-09T00:55:03.923456Z","format":"date-time","readOnly":true,"type":"string"},"deployment_trigger":{"description":"Info about what caused the deployment.","properties":{"metadata":{"description":"Additional info about the trigger.","properties":{"branch":{"description":"Where the trigger happened.","example":"main","readOnly":true,"type":"string"},"commit_hash":{"description":"Hash of the deployment trigger commit.","example":"ad9ccd918a81025731e10e40267e11273a263421","readOnly":true,"type":"string"},"commit_message":{"description":"Message of the deployment trigger commit.","example":"Update index.html","readOnly":true,"type":"string"}},"type":"object"},"type":{"description":"What caused the deployment.","example":"ad_hoc","pattern":"push|ad_hoc","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"},"env_vars":{"description":"A dict of env variables to build this deploy.","example":{"BUILD_VERSION":{"value":"3.3"},"ENV":{"value":"STAGING"}},"readOnly":true,"type":"object"},"environment":{"description":"Type of deploy.","example":"preview","pattern":"preview|production","readOnly":true,"type":"string"},"id":{"description":"Id of the deployment.","example":"f64788e9-fccd-4d4a-a28a-cb84f88f6","readOnly":true,"type":"string"},"is_skipped":{"description":"If the deployment has been skipped.","example":true,"readOnly":true,"type":"boolean"},"latest_stage":{"readOnly":true},"modified_on":{"description":"When the deployment was last modified.","example":"2021-03-09T00:58:59.045655","format":"date-time","readOnly":true,"type":"string"},"project_id":{"description":"Id of the project.","example":"7b162ea7-7367-4d67-bcde-1160995d5","readOnly":true,"type":"string"},"project_name":{"description":"Name of the project.","example":"ninjakittens","readOnly":true,"type":"string"},"short_id":{"description":"Short Id (8 character) of the deployment.","example":"f64788e9","readOnly":true,"type":"string"},"source":{"readOnly":true},"stages":{"description":"List of past stages.","example":[{"ended_on":"2021-06-03T15:39:03.134378Z","name":"queued","started_on":"2021-06-03T15:38:15.608194Z","status":"active"},{"ended_on":null,"name":"initialize","started_on":null,"status":"idle"},{"ended_on":null,"name":"clone_repo","started_on":null,"status":"idle"},{"ended_on":null,"name":"build","started_on":null,"status":"idle"},{"ended_on":null,"name":"deploy","started_on":null,"status":"idle"}],"items":{"$ref":"#/components/schemas/stage"},"readOnly":true,"type":"array"},"url":{"description":"The live URL to view this deployment.","example":"https://f64788e9.ninjakittens.pages.dev","readOnly":true,"type":"string"}},"type":"object"},"deployments-list-response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"items":{"example":[{"id":"bcf48806-b317-4351-9ee7-36e7d557d4de","metadata":{"author_email":"user@example.com","author_id":"408cbcdfd4dda4617efef40b04d168a1","created_on":"2022-11-15T18:25:44.442097Z","modified_on":"2022-11-15T18:25:44.442097Z","source":"api"},"number":2},{"id":"18f97339-c287-4872-9bdd-e2135c07ec12","metadata":{"author_email":"user@example.com","author_id":"408cbcdfd4dda4617efef40b04d168a1","created_on":"2022-11-08T17:30:56.968096Z","modified_on":"2022-11-08T17:30:56.968096Z","source":"api"},"number":1}],"items":{},"type":"array"},"latest":{"example":{"id":"bcf48806-b317-4351-9ee7-36e7d557d4de","metadata":{"author_email":"user@example.com","author_id":"408cbcdfd4dda4617efef40b04d168a1","created_on":"2022-11-15T18:25:44.442097Z","modified_on":"2022-11-15T18:25:44.442097Z","source":"api"},"number":2,"resources":{"bindings":[{"json":"example_binding","name":"JSON_VAR","type":"json"}],"script":{"etag":"13a3240e8fb414561b0366813b0b8f42b3e6cfa0d9e70e99835dae83d0d8a794","handlers":["fetch"],"last_deployed_from":"api"},"script_runtime":{"usage_model":"bundled"}}},"type":"object"}}}]},"deployments-single-response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"id":{"example":"18f97339-c287-4872-9bdd-e2135c07ec12","type":"string"},"metadata":{"example":{"author_email":"user@example.com","author_id":"408cbcdfd4dda4617efef40b04d168a1","created_on":"2022-11-08T17:19:29.176266Z","modified_on":"2022-11-08T17:19:29.176266Z","source":"api"},"type":"object"},"number":{"example":1,"type":"number"},"resources":{"example":{"bindings":[{"json":"example_binding","name":"JSON_VAR","type":"json"}],"script":{"etag":"13a3240e8fb414561b0366813b0b8f42b3e6cfa0d9e70e99835dae83d0d8a794","handlers":["fetch"],"last_deployed_from":"api"},"script_runtime":{"usage_model":"bundled"}},"type":"object"}}}]},"deprecate_any_requests":{"description":"Deprecate the response to ANY requests.","example":true,"type":"boolean"},"description":{"description":"The description of the List.","example":"The serial numbers for administrators","type":"string"},"description-AqNwNwjr":{"description":"Description of the prefix.","example":"Internal test prefix","maxLength":1000,"type":"string"},"description-DIf6mz41":{"default":"","description":"A note that you can use to add more details about the waiting room.","example":"Production - DO NOT MODIFY","type":"string"},"description-HWZDzyev":{"description":"The description of the Device Posture Rule.","example":"The rule for admin serial numbers","type":"string"},"description-Jd6AMFjR":{"description":"Object description.","example":"Login page monitor","type":"string"},"description-dSE9ExYP":{"description":"An optional human provided description of the static route.","example":"New route for new prefix 203.0.113.1","type":"string"},"description-gV3mXO2g":{"description":"Description of role's permissions.","example":"Administrative access to the entire Organization","readOnly":true,"type":"string"},"description-hRvlp2wh":{"description":"A human-readable description of the health check.","example":"Health check for www.example.com","type":"string"},"description_search":{"description":"A string to search for in the description of existing rules.","example":"abusive","type":"string"},"destination_address_identifier":{"description":"Destination address identifier.","example":"ea95132c15732412d22c1476fa83f27a","maxLength":32,"readOnly":true,"type":"string"},"destination_address_properties":{"properties":{"created":{"$ref":"#/components/schemas/created-UVGJEhhU"},"email":{"$ref":"#/components/schemas/email-xwlVNguu"},"modified":{"$ref":"#/components/schemas/modified-Hq0wyeit"},"tag":{"$ref":"#/components/schemas/destination_address_identifier"},"verified":{"$ref":"#/components/schemas/verified"}},"type":"object"},"destination_address_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/addresses"}}}]},"destination_addresses_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/addresses"},"type":"array"},"result_info":{"properties":{"count":{"example":1},"page":{"example":1},"per_page":{"example":20},"total_count":{"example":1}},"type":"object"}}}]},"destination_conf":{"description":"Uniquely identifies a resource (such as an s3 bucket) where data will be pushed. Additional configuration parameters supported by the destination may be included.","example":"s3://mybucket/logs?region=us-west-2","format":"uri","maxLength":4096,"type":"string"},"destination_exists_response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"nullable":true,"properties":{"exists":{"example":false,"type":"boolean"}},"type":"object"}}}]},"detection_mode":{"description":"The mode that defines how rules within the package are evaluated during the course of a request. When a package uses anomaly detection mode (`anomaly` value), each rule is given a score when triggered. If the total score of all triggered rules exceeds the sensitivity defined in the WAF package, the action configured in the package will be performed. Traditional detection mode (`traditional` value) will decide the action to take when it is triggered by the request. If multiple rules are triggered, the action providing the highest protection will be applied (for example, a 'block' action will win over a 'challenge' action).","enum":["anomaly","traditional"],"example":"traditional","readOnly":true,"type":"string"},"development_mode":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["development_mode"],"example":"development_mode"},"time_remaining":{"description":"Value of the zone setting.\nNotes: The interval (in seconds) from when development mode expires (positive integer) or last expired (negative integer) for the domain. If development mode has never been enabled, this value is false.","example":3600,"readOnly":true,"type":"number"},"value":{"$ref":"#/components/schemas/development_mode_value"}}}],"description":"Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare's accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off.","title":"Development Mode"},"development_mode_value":{"default":"off","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"device-dex-test-schemas-data":{"description":"The configuration object which contains the details for the WARP client to conduct the test.","example":{"host":"https://dash.cloudflare.com","kind":"http","method":"GET"},"properties":{"host":{"description":"The desired endpoint to test.","example":"https://dash.cloudflare.com","type":"string"},"kind":{"description":"The type of test.","example":"http","type":"string"},"method":{"description":"The HTTP request method type.","example":"GET","type":"string"}},"type":"object"},"device-dex-test-schemas-description":{"description":"Additional details about the test.","example":"Checks the dash endpoint every 30 minutes","type":"string"},"device-dex-test-schemas-enabled":{"description":"Determines whether or not the test is active.","example":true,"type":"boolean"},"device-dex-test-schemas-http":{"properties":{"data":{"$ref":"#/components/schemas/device-dex-test-schemas-data"},"description":{"$ref":"#/components/schemas/device-dex-test-schemas-description"},"enabled":{"$ref":"#/components/schemas/device-dex-test-schemas-enabled"},"interval":{"$ref":"#/components/schemas/device-dex-test-schemas-interval"},"name":{"$ref":"#/components/schemas/device-dex-test-schemas-name"}},"required":["name","interval","enabled","data"],"type":"object"},"device-dex-test-schemas-interval":{"description":"How often the test will run.","example":"30m","type":"string"},"device-dex-test-schemas-name":{"description":"The name of the DEX test. Must be unique.","example":"HTTP dash health check","type":"string"},"device-managed-networks":{"properties":{"config":{"$ref":"#/components/schemas/schemas-config_response"},"name":{"$ref":"#/components/schemas/device-managed-networks_components-schemas-name"},"network_id":{"$ref":"#/components/schemas/device-managed-networks_components-schemas-uuid"},"type":{"$ref":"#/components/schemas/device-managed-networks_components-schemas-type"}},"type":"object"},"device-managed-networks-FH3V2phW":{"properties":{"config":{"$ref":"#/components/schemas/schemas-config_response"},"name":{"$ref":"#/components/schemas/device-managed-networks_components-schemas-name"},"network_id":{"$ref":"#/components/schemas/uuid-l20MFQPz"},"type":{"$ref":"#/components/schemas/components-schemas-type-KlrF1JPW"}},"type":"object"},"device-managed-networks_components-schemas-identifier":{"example":"699d98642c564d2e855e9661899b7252"},"device-managed-networks_components-schemas-name":{"description":"The name of the Device Managed Network. Must be unique.","example":"managed-network-1","type":"string"},"device-managed-networks_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/device-managed-networks"},"type":"array"}}}]},"device-managed-networks_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/device-managed-networks"}}}]},"device-managed-networks_components-schemas-type":{"description":"The type of Device Managed Network.","enum":["tls"],"example":"tls","type":"string"},"device-managed-networks_components-schemas-uuid":{"description":"API uuid tag.","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36,"type":"string"},"device-posture-integrations":{"properties":{"config":{"$ref":"#/components/schemas/config_response"},"id":{"$ref":"#/components/schemas/device-posture-integrations_components-schemas-uuid"},"interval":{"$ref":"#/components/schemas/schemas-interval"},"name":{"$ref":"#/components/schemas/device-posture-integrations_components-schemas-name"},"type":{"$ref":"#/components/schemas/device-posture-integrations_components-schemas-type"}},"type":"object"},"device-posture-integrations-Xb3lCexZ":{"properties":{"config":{"$ref":"#/components/schemas/config_response"},"id":{"$ref":"#/components/schemas/uuid-l20MFQPz"},"interval":{"$ref":"#/components/schemas/interval-FAyugCvL"},"name":{"$ref":"#/components/schemas/components-schemas-name-4QGVxQIe"},"type":{"$ref":"#/components/schemas/schemas-type-BQBcyQpN"}},"type":"object"},"device-posture-integrations_components-schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"nullable":true}}}]},"device-posture-integrations_components-schemas-identifier":{"example":"699d98642c564d2e855e9661899b7252"},"device-posture-integrations_components-schemas-name":{"description":"The name of the Device Posture Integration.","example":"My Workspace One Integration","type":"string"},"device-posture-integrations_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/device-posture-integrations"},"type":"array"}}}]},"device-posture-integrations_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/device-posture-integrations"}}}]},"device-posture-integrations_components-schemas-type":{"description":"The type of Device Posture Integration.","enum":["workspace_one","crowdstrike_s2s","uptycs","intune"],"example":"workspace_one","type":"string"},"device-posture-integrations_components-schemas-uuid":{"description":"API uuid tag.","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36,"type":"string"},"device-posture-rules":{"properties":{"description":{"$ref":"#/components/schemas/device-posture-rules_components-schemas-description"},"expiration":{"$ref":"#/components/schemas/schemas-expiration"},"id":{"$ref":"#/components/schemas/device-posture-rules_components-schemas-uuid"},"input":{"$ref":"#/components/schemas/input"},"match":{"$ref":"#/components/schemas/schemas-match"},"name":{"$ref":"#/components/schemas/device-posture-rules_components-schemas-name"},"schedule":{"$ref":"#/components/schemas/schedule-6SyTxxBD"},"type":{"$ref":"#/components/schemas/device-posture-rules_components-schemas-type"}},"type":"object"},"device-posture-rules-gduy4mTZ":{"properties":{"description":{"$ref":"#/components/schemas/description-HWZDzyev"},"expiration":{"$ref":"#/components/schemas/expiration-9DsFtGHX"},"id":{"$ref":"#/components/schemas/uuid-l20MFQPz"},"input":{"$ref":"#/components/schemas/input-NaZjecAw"},"match":{"$ref":"#/components/schemas/match-gWGZ7MOw"},"name":{"$ref":"#/components/schemas/name-wyyCMADI"},"schedule":{"$ref":"#/components/schemas/schedule-kOC57cA0"},"type":{"$ref":"#/components/schemas/type-tb4QXpPC"}},"type":"object"},"device-posture-rules_components-schemas-description":{"description":"The description of the Device Posture Rule.","example":"The rule for admin serial numbers","type":"string"},"device-posture-rules_components-schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/device-posture-rules_components-schemas-uuid"}},"type":"object"}}}]},"device-posture-rules_components-schemas-identifier":{"example":"699d98642c564d2e855e9661899b7252"},"device-posture-rules_components-schemas-name":{"description":"The name of the Device Posture Rule.","example":"Admin Serial Numbers","type":"string"},"device-posture-rules_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/device-posture-rules"},"type":"array"}}}]},"device-posture-rules_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/device-posture-rules"}}}]},"device-posture-rules_components-schemas-type":{"description":"The type of Device Posture Rule.","enum":["file","application","serial_number","tanium","gateway","warp"],"example":"file","type":"string"},"device-posture-rules_components-schemas-uuid":{"description":"API uuid tag.","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36,"type":"string"},"device_posture":{"description":"The wirefilter expression to be used for device posture check matching.","example":"any(device_posture.checks.passed[*] in {\"1308749e-fcfb-4ebc-b051-fe022b632644\"})","type":"string"},"device_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"device_settings_policy":{"properties":{"allow_mode_switch":{"$ref":"#/components/schemas/allow_mode_switch"},"allow_updates":{"$ref":"#/components/schemas/allow_updates"},"allowed_to_leave":{"$ref":"#/components/schemas/allowed_to_leave"},"auto_connect":{"$ref":"#/components/schemas/auto_connect"},"captive_portal":{"$ref":"#/components/schemas/captive_portal"},"default":{"$ref":"#/components/schemas/schemas-default"},"description":{"$ref":"#/components/schemas/devices_components-schemas-description"},"disable_auto_fallback":{"$ref":"#/components/schemas/disable_auto_fallback"},"enabled":{"description":"Whether the policy will be applied to matching devices.","example":true,"type":"boolean"},"exclude":{"$ref":"#/components/schemas/components-schemas-exclude"},"exclude_office_ips":{"$ref":"#/components/schemas/exclude_office_ips"},"fallback_domains":{"$ref":"#/components/schemas/fallback_domains"},"gateway_unique_id":{"$ref":"#/components/schemas/gateway_unique_id"},"include":{"$ref":"#/components/schemas/schemas-include"},"match":{"$ref":"#/components/schemas/components-schemas-match"},"name":{"description":"The name of the device settings policy.","example":"Allow Developers","maxLength":100,"type":"string"},"policy_id":{"$ref":"#/components/schemas/uuid-s0SXln0q"},"precedence":{"$ref":"#/components/schemas/schemas-precedence"},"service_mode_v2":{"$ref":"#/components/schemas/service_mode_v2"},"support_url":{"$ref":"#/components/schemas/support_url"},"switch_locked":{"$ref":"#/components/schemas/switch_locked"}},"type":"object"},"device_settings_policy-ZinBC9X3":{"properties":{"allow_mode_switch":{"$ref":"#/components/schemas/allow_mode_switch"},"allow_updates":{"$ref":"#/components/schemas/allow_updates"},"allowed_to_leave":{"$ref":"#/components/schemas/allowed_to_leave"},"auto_connect":{"$ref":"#/components/schemas/auto_connect"},"captive_portal":{"$ref":"#/components/schemas/captive_portal"},"default":{"$ref":"#/components/schemas/default-VASQNGRU"},"description":{"$ref":"#/components/schemas/schemas-description-jdg4o19i"},"disable_auto_fallback":{"$ref":"#/components/schemas/disable_auto_fallback"},"enabled":{"description":"Whether the policy will be applied to matching devices.","example":true,"type":"boolean"},"exclude":{"$ref":"#/components/schemas/exclude-tYW3UmZW"},"exclude_office_ips":{"$ref":"#/components/schemas/exclude_office_ips"},"fallback_domains":{"$ref":"#/components/schemas/fallback_domains"},"gateway_unique_id":{"$ref":"#/components/schemas/gateway_unique_id"},"include":{"$ref":"#/components/schemas/include-9GPmbbUN"},"match":{"$ref":"#/components/schemas/schemas-match-ImQchlrH"},"name":{"description":"The name of the device settings policy.","example":"Allow Developers","maxLength":100,"type":"string"},"policy_id":{"$ref":"#/components/schemas/schemas-uuid-lt6l49Ob"},"precedence":{"$ref":"#/components/schemas/precedence-HZLvpi3q"},"service_mode_v2":{"$ref":"#/components/schemas/service_mode_v2"},"support_url":{"$ref":"#/components/schemas/support_url"},"switch_locked":{"$ref":"#/components/schemas/switch_locked"}},"type":"object"},"device_settings_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/device_settings_policy-ZinBC9X3"}}}]},"device_settings_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/device_settings_policy-ZinBC9X3"},"type":"array"}}}]},"devices":{"properties":{"created":{"$ref":"#/components/schemas/schemas-created"},"deleted":{"$ref":"#/components/schemas/schemas-deleted"},"device_type":{"$ref":"#/components/schemas/platform"},"id":{"$ref":"#/components/schemas/devices_components-schemas-uuid"},"ip":{"$ref":"#/components/schemas/components-schemas-ip"},"key":{"$ref":"#/components/schemas/schemas-key"},"last_seen":{"$ref":"#/components/schemas/last_seen"},"mac_address":{"$ref":"#/components/schemas/mac_address"},"manufacturer":{"$ref":"#/components/schemas/manufacturer"},"model":{"$ref":"#/components/schemas/model"},"name":{"$ref":"#/components/schemas/devices_components-schemas-name"},"os_distro_name":{"$ref":"#/components/schemas/os_distro_name"},"os_distro_revision":{"$ref":"#/components/schemas/os_distro_revision"},"os_version":{"$ref":"#/components/schemas/os_version"},"revoked_at":{"$ref":"#/components/schemas/revoked_at"},"serial_number":{"$ref":"#/components/schemas/components-schemas-serial_number-AUVcZzty"},"updated":{"$ref":"#/components/schemas/updated"},"user":{"$ref":"#/components/schemas/user"},"version":{"$ref":"#/components/schemas/devices_components-schemas-version"}},"type":"object"},"devices-NWwWHmPO":{"properties":{"created":{"$ref":"#/components/schemas/created-lduEKfk7"},"deleted":{"$ref":"#/components/schemas/deleted-gN7SICJB"},"device_type":{"$ref":"#/components/schemas/platform"},"id":{"$ref":"#/components/schemas/schemas-uuid-lt6l49Ob"},"ip":{"$ref":"#/components/schemas/ip-idMl3BYW"},"key":{"$ref":"#/components/schemas/key-sOXCdDRQ"},"last_seen":{"$ref":"#/components/schemas/last_seen"},"mac_address":{"$ref":"#/components/schemas/mac_address"},"manufacturer":{"$ref":"#/components/schemas/manufacturer"},"model":{"$ref":"#/components/schemas/model"},"name":{"$ref":"#/components/schemas/schemas-name-1UDkXCXq"},"os_distro_name":{"$ref":"#/components/schemas/os_distro_name"},"os_distro_revision":{"$ref":"#/components/schemas/os_distro_revision"},"os_version":{"$ref":"#/components/schemas/os_version"},"revoked_at":{"$ref":"#/components/schemas/revoked_at"},"serial_number":{"$ref":"#/components/schemas/serial_number-8kzQvaWX"},"updated":{"$ref":"#/components/schemas/updated"},"user":{"$ref":"#/components/schemas/user-L6j8gcON"},"version":{"$ref":"#/components/schemas/version-SGF9qNGE"}},"type":"object"},"devices_components-schemas-description":{"description":"A description of the policy.","example":"Policy for test teams.","maxLength":500,"type":"string"},"devices_components-schemas-identifier":{"example":"699d98642c564d2e855e9661899b7252"},"devices_components-schemas-name":{"description":"The device name.","example":"My mobile device","type":"string"},"devices_components-schemas-uuid":{"description":"Device ID.","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36,"type":"string"},"devices_components-schemas-version":{"description":"The WARP client version.","example":"1.0.0","type":"string"},"devices_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/devices-NWwWHmPO"},"type":"array"}}}]},"dex-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/device-dex-test-schemas-http"},"type":"array"}}}]},"dex-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/device-dex-test-schemas-http"}}}]},"digest":{"description":"Digest hash.","example":"48E939042E82C22542CB377B580DFDC52A361CEFDC72E7F9107E2B6BD9306A45","nullable":true,"readOnly":true,"type":"string"},"digest_algorithm":{"description":"Type of digest algorithm.","example":"SHA256","nullable":true,"readOnly":true,"type":"string"},"digest_type":{"description":"Coded type for digest algorithm.","example":"2","nullable":true,"readOnly":true,"type":"string"},"dimensions":{"description":"A comma-separated list of dimensions to group results by.","example":"queryType","type":"string"},"dimensions-ICwErPf5":{"description":"Can be used to break down the data by given attributes. Options are: \n\nDimension | Name | Example\n--------------------------|---------------------------------|--------------------------\nevent | Connection Event | connect, progress, disconnect, originError, clientFiltered\nappID | Application ID | 40d67c87c6cd4b889a4fd57805225e85\ncoloName | Colo Name | SFO\nipVersion | IP version used by the client | 4, 6.","example":["event","appID"],"items":{"enum":["event","appID","coloName","ipVersion"],"type":"string"},"type":"array"},"direct_upload_request":{"properties":{"allowedOrigins":{"$ref":"#/components/schemas/allowedOrigins"},"creator":{"$ref":"#/components/schemas/creator"},"expiry":{"default":"Now + 30 minutes","description":"The date and time after upload when videos will not be accepted.","example":"2021-01-02T02:20:00Z","format":"date-time","type":"string"},"maxDurationSeconds":{"$ref":"#/components/schemas/maxDurationSeconds"},"requireSignedURLs":{"$ref":"#/components/schemas/requireSignedURLs-9DKWYMwu"},"thumbnailTimestampPct":{"$ref":"#/components/schemas/thumbnailTimestampPct"},"watermark":{"$ref":"#/components/schemas/watermark_at_upload"}},"required":["maxDurationSeconds"],"type":"object"},"direct_upload_request_v2":{"properties":{"expiry":{"default":"Now + 30 minutes","description":"The date after which the upload will not be accepted. Minimum: Now + 2 minutes. Maximum: Now + 6 hours.","example":"2021-01-02T02:20:00Z","format":"date-time","type":"string"},"id":{"description":"Optional Image Custom ID. Up to 1024 chars. Can include any number of subpaths, and utf8 characters. Cannot start nor end with a / (forward slash). Cannot be a UUID.","example":"this/is/my-customid","maxLength":1024,"readOnly":true,"type":"string"},"metadata":{"description":"User modifiable key-value store. Can be used for keeping references to another system of record, for managing images.","type":"object"},"requireSignedURLs":{"default":false,"description":"Indicates whether the image requires a signature token to be accessed.","example":true,"type":"boolean"}},"type":"object"},"direct_upload_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"uid":{"$ref":"#/components/schemas/identifier-XSj9HnWY"},"uploadURL":{"description":"The URL an unauthenticated upload can use for a single `HTTP POST multipart/form-data` request.","example":"www.example.com/samplepath","type":"string"},"watermark":{"$ref":"#/components/schemas/watermarks"}}}}}]},"direct_upload_response_v2":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"description":"Image unique identifier.","example":"e22e9e6b-c02b-42fd-c405-6c32af5fe600","maxLength":32,"readOnly":true,"type":"string"},"uploadURL":{"description":"The URL the unauthenticated upload can be performed to using a single HTTP POST (multipart/form-data) request.","example":"https://upload.imagedelivery.net/FxUufywByo0m2v3xhKSiU8/e22e9e6b-c02b-42fd-c405-6c32af5fe600","type":"string"}}}}}]},"disable_auto_fallback":{"description":"If the dns_server field of a fallback domain is not present, the client will fall back to a best guess of the default/system DNS resolvers, unless this policy option is set.","example":true,"type":"boolean"},"disable_for_time":{"properties":{"1":{"description":"Override code that is valid for 1 hour.","example":"9106681"},"12":{"description":"Override code that is valid for 12 hour2.","example":"3424359"},"24":{"description":"Override code that is valid for 24 hour.2.","example":"2887634"},"3":{"description":"Override code that is valid for 3 hours.","example":"5356247"},"6":{"description":"Override code that is valid for 6 hours.","example":"9478972"}},"type":"object"},"disable_session_renewal":{"default":false,"description":"Only available for the Waiting Room Advanced subscription. Disables automatic renewal of session cookies. If `true`, an accepted user will have session_duration minutes to browse the site. After that, they will have to go through the waiting room again. If `false`, a user's session cookie will be automatically renewed on every request.","example":false,"type":"boolean"},"disable_transfer_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/disable_transfer_result"}}}]},"disable_transfer_result":{"description":"The zone transfer status of a primary zone","example":"Disabled","type":"string"},"disabled":{"description":"When true, indicates that the rate limit is currently disabled.","example":false,"type":"boolean"},"disabled_at":{"description":"This field shows up only if the origin is disabled. This field is set with the time the origin was disabled.","format":"date-time","readOnly":true,"type":"string"},"display_name":{"description":"Alert type name.","example":"Origin Error Rate Alert","type":"string"},"dlq_name":{"example":"example-dlq","type":"string"},"dns":{"description":"The name and type of DNS record for the Spectrum application.","properties":{"name":{"$ref":"#/components/schemas/dns_name"},"type":{"$ref":"#/components/schemas/dns_type"}},"type":"object"},"dns-firewall":{"properties":{"attack_mitigation":{"$ref":"#/components/schemas/attack_mitigation"},"deprecate_any_requests":{"$ref":"#/components/schemas/deprecate_any_requests"},"dns_firewall_ips":{"$ref":"#/components/schemas/dns_firewall_ips"},"ecs_fallback":{"$ref":"#/components/schemas/ecs_fallback"},"id":{"$ref":"#/components/schemas/identifier-b3jdvVAb"},"maximum_cache_ttl":{"$ref":"#/components/schemas/maximum_cache_ttl"},"minimum_cache_ttl":{"$ref":"#/components/schemas/minimum_cache_ttl"},"modified_on":{"$ref":"#/components/schemas/modified_on-uPCC7iXw"},"name":{"$ref":"#/components/schemas/name-SScjQrIN"},"negative_cache_ttl":{"$ref":"#/components/schemas/negative_cache_ttl"},"origin_ips":{"$ref":"#/components/schemas/origin_ips"},"ratelimit":{"$ref":"#/components/schemas/ratelimit"},"retries":{"$ref":"#/components/schemas/retries-w39sVXcQ"}},"required":["id","name","origin_ips","dns_firewall_ips","minimum_cache_ttl","maximum_cache_ttl","deprecate_any_requests","ecs_fallback","modified_on"],"type":"object"},"dns-record":{"oneOf":[{"$ref":"#/components/schemas/ARecord"},{"$ref":"#/components/schemas/AAAARecord"},{"$ref":"#/components/schemas/CAARecord"},{"$ref":"#/components/schemas/CERTRecord"},{"$ref":"#/components/schemas/CNAMERecord"},{"$ref":"#/components/schemas/DNSKEYRecord"},{"$ref":"#/components/schemas/DSRecord"},{"$ref":"#/components/schemas/HTTPSRecord"},{"$ref":"#/components/schemas/LOCRecord"},{"$ref":"#/components/schemas/MXRecord"},{"$ref":"#/components/schemas/NAPTRRecord"},{"$ref":"#/components/schemas/NSRecord"},{"$ref":"#/components/schemas/PTRRecord"},{"$ref":"#/components/schemas/SMIMEARecord"},{"$ref":"#/components/schemas/SRVRecord"},{"$ref":"#/components/schemas/SSHFPRecord"},{"$ref":"#/components/schemas/SVCBRecord"},{"$ref":"#/components/schemas/TLSARecord"},{"$ref":"#/components/schemas/TXTRecord"},{"$ref":"#/components/schemas/URIRecord"}],"required":["id","type","name","content","proxiable","locked","zone_name","created_on","modified_on"],"type":"object"},"dns-record-c3EG7MiH":{"description":"List of records needed to enable an Email Routing zone.","properties":{"content":{"description":"DNS record content.","example":"route1.mx.cloudflare.net","type":"string"},"name":{"description":"DNS record name (or @ for the zone apex).","example":"example.com","maxLength":255,"type":"string"},"priority":{"description":"Required for MX, SRV and URI records. Unused by other record types. Records with lower priorities are preferred.","example":12,"maximum":65535,"minimum":0,"type":"number"},"ttl":{"anyOf":[{"example":3600,"maximum":86400,"minimum":1,"type":"number"},{"enum":[1],"type":"number"}],"description":"Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1 for 'automatic'.","example":1,"type":"number"},"type":{"description":"DNS record type.","enum":["A","AAAA","CNAME","HTTPS","TXT","SRV","LOC","MX","NS","CERT","DNSKEY","DS","NAPTR","SMIMEA","SSHFP","SVCB","TLSA","URI"],"example":"NS","readOnly":true,"type":"string"}},"type":"object"},"dns-secondary-secondary-zone":{"properties":{"auto_refresh_seconds":{"$ref":"#/components/schemas/auto_refresh_seconds"},"id":{"$ref":"#/components/schemas/identifier-ahBjrSIO"},"name":{"$ref":"#/components/schemas/name-YGUm4gr7"},"peers":{"$ref":"#/components/schemas/peers"}},"required":["id","name","peers","auto_refresh_seconds"],"type":"object"},"dns-settings_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/dns-record-c3EG7MiH"},"type":"array"}}}]},"dns_firewall_ips":{"example":["203.0.113.1","203.0.113.254","2001:DB8:AB::CF","2001:DB8:CD::CF"],"items":{"anyOf":[{"description":"Origin DNS Server IPv4 Address.","example":"203.0.113.1","format":"ipv4","type":"string"},{"description":"Origin DNS Server IPv6 Address.","example":"2001:DB8:ab::CF","format":"ipv6","type":"string"}]},"type":"array"},"dns_firewall_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/dns-firewall"},"type":"array"}}}]},"dns_firewall_single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/dns-firewall"}}}]},"dns_name":{"description":"The name of the DNS record associated with the application.","example":"ssh.example.com","format":"hostname","type":"string"},"dns_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/dns-record"},"type":"array"}},"type":"object"}]},"dns_response_import_scan":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"recs_added":{"description":"Number of DNS records added.","example":5,"type":"number"},"total_records_parsed":{"description":"Total number of DNS records parsed.","example":5,"type":"number"}},"type":"object"},"timing":{"properties":{"end_time":{"description":"When the file parsing ended.","example":"2014-03-01T12:20:01Z","format":"date-time","type":"string"},"process_time":{"description":"Processing time of the file in seconds.","example":1,"type":"number"},"start_time":{"description":"When the file parsing started.","example":"2014-03-01T12:20:00Z","format":"date-time","type":"string"}},"type":"object"}},"type":"object"}]},"dns_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/dns-record"}},"type":"object"}]},"dns_ttl":{"description":"The TTL of our resolution of your DNS record in seconds.","minimum":600,"type":"integer"},"dns_type":{"description":"The type of DNS record associated with the application.","enum":["CNAME","ADDRESS"],"example":"CNAME","type":"string"},"dnslink":{"description":"DNSLink value used if the target is ipfs.","example":"/ipns/onboarding.ipfs.cloudflare.com","type":"string"},"dnssec":{"properties":{"algorithm":{"$ref":"#/components/schemas/algorithm"},"digest":{"$ref":"#/components/schemas/digest"},"digest_algorithm":{"$ref":"#/components/schemas/digest_algorithm"},"digest_type":{"$ref":"#/components/schemas/digest_type"},"ds":{"$ref":"#/components/schemas/ds"},"flags":{"$ref":"#/components/schemas/flags"},"key_tag":{"$ref":"#/components/schemas/key_tag"},"key_type":{"$ref":"#/components/schemas/key_type"},"modified_on":{"$ref":"#/components/schemas/modified_on-JpSxLOr6"},"public_key":{"$ref":"#/components/schemas/public_key"},"status":{"$ref":"#/components/schemas/status-2mOK9Pc7"}},"type":"object"},"dnssec_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/dnssec"}}}]},"domain":{"description":"The domain and path that Access will secure.","example":"test.example.com/admin","type":"string"},"domain-UjOhLqjI":{"properties":{"environment":{"$ref":"#/components/schemas/environment"},"hostname":{"$ref":"#/components/schemas/components-schemas-hostname"},"id":{"$ref":"#/components/schemas/domain_identifier"},"service":{"$ref":"#/components/schemas/schemas-service"},"zone_id":{"$ref":"#/components/schemas/zone_identifier"},"zone_name":{"$ref":"#/components/schemas/zone_name"}},"type":"object"},"domain-history":{"properties":{"categorizations":{"items":{"properties":{"categories":{"example":[{"id":155,"name":"Technology"}]},"end":{"example":"2021-04-30","format":"date","type":"string"},"start":{"example":"2021-04-01","format":"date","type":"string"}},"type":"object"},"type":"array"},"domain":{"$ref":"#/components/schemas/schemas-domain_name"}}},"domain-response-collection":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result_info":{"properties":{"count":{"example":1},"page":{"example":1},"per_page":{"example":100},"total_count":{"example":1}},"type":"object"}}},{"properties":{"result":{"items":{"type":"object"},"type":"array"}}}]},"domain-response-collection-7KXX2Ghb":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/domain-UjOhLqjI"},"type":"array"}},"type":"object"}]},"domain-response-single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"domain-response-single-0j5uvVNJ":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/domain-UjOhLqjI"}},"type":"object"}]},"domain_components-schemas-domain":{"properties":{"additional_information":{"$ref":"#/components/schemas/additional_information"},"application":{"$ref":"#/components/schemas/application-WiomAg5h"},"content_categories":{"$ref":"#/components/schemas/content_categories"},"domain":{"$ref":"#/components/schemas/schemas-domain_name"},"popularity_rank":{"$ref":"#/components/schemas/popularity_rank"},"resolves_to_refs":{"$ref":"#/components/schemas/resolves_to_refs"},"risk_score":{"$ref":"#/components/schemas/risk_score"},"risk_types":{"$ref":"#/components/schemas/risk_types"}}},"domain_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/domain_components-schemas-domain"}}}]},"domain_identifier":{"description":"Identifer of the Worker Domain.","example":"dbe10b4bc17c295377eabd600e1787fd"},"domain_name":{"description":"Name of the domain.","example":"this-is-my-domain-01.com","pattern":"^[a-z0-9][a-z0-9-]*$","type":"string"},"domain_name-lovco9gj":{"description":"Domain name.","example":"cloudflare.com","type":"string"},"domain_names":{"description":"List of domain names.","example":["cloudflare.com","cloudflare.net"],"items":{"type":"string"},"type":"array"},"domain_properties":{"properties":{"available":{"$ref":"#/components/schemas/schemas-available"},"can_register":{"$ref":"#/components/schemas/can_register"},"created_at":{"$ref":"#/components/schemas/components-schemas-created_at"},"current_registrar":{"$ref":"#/components/schemas/current_registrar"},"expires_at":{"$ref":"#/components/schemas/expires_at"},"id":{"$ref":"#/components/schemas/schemas-domain_identifier"},"locked":{"$ref":"#/components/schemas/locked"},"registrant_contact":{"$ref":"#/components/schemas/registrant_contact"},"registry_statuses":{"$ref":"#/components/schemas/registry_statuses"},"supported_tld":{"$ref":"#/components/schemas/supported_tld"},"transfer_in":{"$ref":"#/components/schemas/transfer_in"},"updated_at":{"$ref":"#/components/schemas/components-schemas-updated_at"}},"type":"object"},"domain_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/domains"},"type":"array"}}}]},"domain_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"domain_rule":{"description":"Match an entire email domain.","properties":{"email_domain":{"properties":{"domain":{"description":"The email domain to match.","example":"example.com","type":"string"}},"required":["domain"],"type":"object"}},"required":["email_domain"],"title":"Email domain","type":"object"},"domain_update_properties":{"properties":{"auto_renew":{"$ref":"#/components/schemas/auto_renew"},"locked":{"$ref":"#/components/schemas/locked"},"name_servers":{"$ref":"#/components/schemas/name_servers"},"privacy":{"$ref":"#/components/schemas/privacy"}},"type":"object"},"domains":{"allOf":[{"$ref":"#/components/schemas/domain_properties"}],"type":"object"},"domains-post":{"example":{"name":"example.com"}},"downloadedFrom":{"description":"The source URL for a downloaded image. If the watermark profile was created via direct upload, this field is null.","example":"https://company.com/logo.png","readOnly":true,"type":"string"},"downloads_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"ds":{"description":"Full DS record.","example":"example.com. 3600 IN DS 16953 13 2 48E939042E82C22542CB377B580DFDC52A361CEFDC72E7F9107E2B6BD9306A45","nullable":true,"readOnly":true,"type":"string"},"duration":{"description":"The duration of the plan subscription.","example":1,"type":"number"},"duration-nfHavjWr":{"description":"The duration of the video in seconds. A value of `-1` means the duration is unknown. The duration becomes available after the upload and before the video is ready.","readOnly":true,"type":"integer"},"dynamic-redirect-rules_components-schemas-rule":{"properties":{"action":{"example":"redirect"},"action_parameters":{"$ref":"#/components/schemas/components-schemas-action_parameters"},"description":{"example":"Blog redirect"},"expression":{"example":"http.request.uri.path == \"/blog\""},"id":{"example":"3a03d665bac047339bb530ecb439a90d"},"version":{"example":"1"}}},"early_hints":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["early_hints"],"example":"early_hints"},"value":{"$ref":"#/components/schemas/early_hints_value"}}}],"description":"When enabled, Cloudflare will attempt to speed up overall page loads by serving `103` responses with `Link` headers from the final response. Refer to [Early Hints](https://developers.cloudflare.com/cache/about/early-hints) for more information.","title":"Early Hints"},"early_hints_value":{"default":"off","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"ecs-support":{"description":"Set if the location needs to resolve EDNS queries.","example":false,"type":"boolean"},"ecs_fallback":{"description":"Forward client IP (resolver) subnet if no EDNS Client Subnet is sent.","example":false,"type":"boolean"},"edge_cache_ttl":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["edge_cache_ttl"],"example":"edge_cache_ttl"},"value":{"$ref":"#/components/schemas/edge_cache_ttl_value"}}}],"description":"Time (in seconds) that a resource will be ensured to remain on Cloudflare's cache servers.","title":"Edge Cache TTL"},"edge_cache_ttl_value":{"default":7200,"description":"Value of the zone setting.\nNotes: The minimum TTL available depends on the plan level of the zone. (Enterprise = 30, Business = 1800, Pro = 3600, Free = 7200)","enum":[30,60,300,1200,1800,3600,7200,10800,14400,18000,28800,43200,57600,72000,86400,172800,259200,345600,432000,518400,604800],"type":"number"},"edge_ips":{"default":{"connectivity":"all","type":"dynamic"},"description":"The anycast edge IP configuration for the hostname of this application.","oneOf":[{"properties":{"connectivity":{"description":"The IP versions supported for inbound connections on Spectrum anycast IPs.","enum":["all","ipv4","ipv6"],"example":"all","type":"string"},"type":{"description":"The type of edge IP configuration specified. Dynamically allocated edge IPs use Spectrum anycast IPs in accordance with the connectivity you specify. Only valid with CNAME DNS names.","enum":["dynamic"],"example":"dynamic","type":"string"}},"type":"object"},{"properties":{"ips":{"description":"The array of customer owned IPs we broadcast via anycast for this hostname and application.","example":["192.0.2.1"],"items":{"description":"Edge anycast IPs.","example":"192.0.2.1","type":"string"},"type":"array"},"type":{"description":"The type of edge IP configuration specified. Statically allocated edge IPs use customer IPs in accordance with the ips array you specify. Only valid with ADDRESS DNS names.","enum":["static"],"example":"static","type":"string"}},"type":"object"}]},"editable":{"default":true,"description":"Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).","enum":[true,false],"readOnly":true,"type":"boolean"},"effect":{"description":"Allow or deny operations against the resources.","enum":["allow","deny"],"example":"allow","type":"string"},"egs-pagination":{"properties":{"page":{"default":1,"description":"The page number of paginated results.","minimum":1,"type":"number"},"per_page":{"default":20,"description":"The maximum number of results per page. You can only set the value to `1` or to a multiple of 5 such as `5`, `10`, `15`, or `20`.","maximum":1000,"minimum":1,"type":"number"}},"type":"object"},"either_profile_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"anyOf":[{"$ref":"#/components/schemas/predefined_profile"},{"$ref":"#/components/schemas/custom_profile"},{"$ref":"#/components/schemas/integration_profile"}]}}}]},"either_profile_response-G4QJIAYV":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"anyOf":[{"$ref":"#/components/schemas/predefined_profile"},{"$ref":"#/components/schemas/custom_profile"}]}}}]},"eligibility":{"properties":{"eligible":{"$ref":"#/components/schemas/eligible"},"ready":{"$ref":"#/components/schemas/ready"},"type":{"$ref":"#/components/schemas/eligibility_components-schemas-type"}},"type":"object"},"eligibility_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"additionalProperties":{"items":{"$ref":"#/components/schemas/eligibility"},"type":"array"},"example":{"email":{"eligible":true,"ready":true,"type":"email"}},"type":"object"}}}]},"eligibility_components-schemas-type":{"description":"Determines type of delivery mechanism.","enum":["email","pagerduty","webhook"],"example":"email","type":"string"},"eligible":{"description":"Determines whether or not the account is eligible for the delivery mechanism.","example":true,"type":"boolean"},"email":{"description":"The email address of the authenticating user.","example":"user@example.com","format":"email","type":"string"},"email-rXr4fRvz":{"description":"The contact email address of the user.","example":"user@example.com","maxLength":90,"type":"string"},"email-sNyq81Xd":{"description":"The contact email address of the user.","example":"user@example.com","maxLength":90,"type":"string"},"email-setting_created":{"description":"The date and time the settings have been created.","example":"2014-01-02T02:20:00Z","format":"date-time","readOnly":true,"type":"string"},"email-setting_enabled":{"default":true,"description":"State of the zone settings for Email Routing.","enum":[true,false],"example":true,"type":"boolean"},"email-setting_identifier":{"description":"Email Routing settings identifier.","example":"75610dab9e69410a82cf7e400a09ecec","maxLength":32,"readOnly":true,"type":"string"},"email-setting_modified":{"description":"The date and time the settings have been modified.","example":"2014-01-02T02:20:00Z","format":"date-time","readOnly":true,"type":"string"},"email-setting_name":{"description":"Domain of your zone.","example":"example.net","readOnly":true,"type":"string"},"email-setting_skip-wizard":{"default":true,"description":"Flag to check if the user skipped the configuration wizard.","enum":[true,false],"example":true,"type":"boolean"},"email-setting_status":{"description":"Show the state of your account, and the type or configuration error.","enum":["ready","unconfigured","misconfigured","misconfigured/locked","unlocked"],"example":"ready","readOnly":true,"type":"string"},"email-settings_properties":{"properties":{"created":{"$ref":"#/components/schemas/email-setting_created"},"enabled":{"$ref":"#/components/schemas/email-setting_enabled"},"modified":{"$ref":"#/components/schemas/email-setting_modified"},"name":{"$ref":"#/components/schemas/email-setting_name"},"skip_wizard":{"$ref":"#/components/schemas/email-setting_skip-wizard"},"status":{"$ref":"#/components/schemas/email-setting_status"},"tag":{"$ref":"#/components/schemas/email-setting_identifier"}},"type":"object"},"email-settings_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/settings-2v3jrs7t"}}}]},"email-xwlVNguu":{"description":"The contact email address of the user.","example":"user@example.com","maxLength":90,"type":"string"},"email_obfuscation":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["email_obfuscation"],"example":"email_obfuscation"},"value":{"$ref":"#/components/schemas/email_obfuscation_value"}}}],"description":"Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016).","title":"Email Obfuscation"},"email_obfuscation_value":{"default":"on","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"email_rule":{"description":"Matches a specific email.","properties":{"email":{"properties":{"email":{"description":"The email of the user.","example":"test@example.com","format":"email","type":"string"}},"required":["email"],"type":"object"}},"required":["email"],"title":"Email","type":"object"},"empty_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"empty_response-47a5DGxM":{"allOf":[{"properties":{"result":{"enum":[true,false],"example":true,"type":"boolean"},"success":{"enum":[true,false],"example":true,"type":"boolean"}}}]},"empty_response-RrteGbXp":{"allOf":[{"properties":{"result":{"enum":[true,false],"example":true,"type":"boolean"},"success":{"enum":[true,false],"example":true,"type":"boolean"}}}]},"empty_response-V46LqGZw":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{},"maxItems":0,"type":"array"}},"type":"object"}]},"enable_binding_cookie":{"default":false,"description":"Enables the binding cookie, which increases security against compromised authorization tokens and CSRF attacks.","type":"boolean"},"enable_transfer_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/enable_transfer_result"}}}]},"enable_transfer_result":{"description":"The zone transfer status of a primary zone","example":"Enabled","type":"string"},"enabled":{"description":"Set if the rule is enabled.","example":true,"type":"boolean"},"enabled-A6pti18n":{"description":"Flag that indicates if the job is enabled.","example":false,"type":"boolean"},"enabled-N6CliIvj":{"description":"When true, indicates that Page Shield is enabled.","example":true,"type":"boolean"},"enabled-WoQtkwsn":{"default":true,"description":"Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).","example":false,"type":"boolean"},"enabled-i0fFiRwL":{"default":false,"description":"Whether the Address Map is enabled or not. Cloudflare's DNS will not respond with IP addresses on an Address Map until the map is enabled.","example":true,"nullable":true,"type":"boolean"},"enabled-mOUbjYfQ":{"description":"Whether or not the Keyless SSL is on or off.","example":false,"readOnly":true,"type":"boolean"},"enabled-uhOFAV56":{"description":"Whether or not the Keyless SSL is on or off.","example":false,"readOnly":true,"type":"boolean"},"enabled_download_phase":{"description":"Set to enable antivirus scan on downloads.","example":false,"type":"boolean"},"enabled_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"enabled":{"$ref":"#/components/schemas/zone-authenticated-origin-pull_components-schemas-enabled"}}}}}]},"enabled_upload_phase":{"description":"Set to enable antivirus scan on uploads.","example":false,"type":"boolean"},"enabled_write":{"deprecated":true,"description":"Whether or not the Keyless SSL is on or off.","example":false,"name":"enabled","type":"boolean"},"end":{"anyOf":[{"type":"string"},{"type":"integer"}],"description":"Sets the (exclusive) end of the requested time frame. This can be a unix timestamp (in seconds or nanoseconds), or an absolute timestamp that conforms to RFC 3339. `end` must be at least five minutes earlier than now and must be later than `start`. Difference between `start` and `end` must be not greater than one hour.","example":"2018-05-20T10:01:00Z"},"end_time_seconds":{"description":"Specifies the end time for the video clip in seconds.","readOnly":true,"type":"integer"},"endpoint":{"description":"The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}, during insertion. This will further be Cloudflare-normalized upon insertion. See: https://developers.cloudflare.com/rules/normalization/how-it-works/.","example":"/api/v1/users/{var1}","format":"uri-template","maxLength":4096,"pattern":"^/.*$","type":"string"},"entry_id":{"allOf":[{"$ref":"#/components/schemas/uuid-lbOWhPVX"}],"description":"The ID for this entry","example":"719d1215-260f-41d0-8c32-eb320ad107f7"},"entry_id-A2p6ZYit":{"allOf":[{"$ref":"#/components/schemas/uuid-s0SXln0q"}],"description":"The ID for this entry","example":"719d1215-260f-41d0-8c32-eb320ad107f7"},"environment":{"description":"Worker environment associated with the zone and hostname.","example":"production","type":"string"},"error":{"description":"Errors resulting from collecting traceroute from colo to target.","enum":["","Could not gather traceroute data: Code 1","Could not gather traceroute data: Code 2","Could not gather traceroute data: Code 3","Could not gather traceroute data: Code 4"],"example":"","type":"string"},"errorReasonCode":{"description":"Specifies why the video failed to encode. This field is empty if the video is not in an `error` state. Preferred for programmatic use.","example":"ERR_NON_VIDEO","readOnly":true,"type":"string"},"errorReasonText":{"description":"Specifies why the video failed to encode using a human readable error message in English. This field is empty if the video is not in an `error` state.","example":"The file was not recognized as a valid video file.","readOnly":true,"type":"string"},"error_message":{"description":"If not null, the job is currently failing. Failures are usually repetitive (example: no permissions to write to destination bucket). Only the last failure is recorded. On successful execution of a job the error_message and last_error are set to null.","format":"date-time","nullable":true,"type":"string"},"estimated_queued_users":{"type":"integer"},"estimated_total_active_users":{"type":"integer"},"etag":{"description":"Hashed script content, can be used in a If-None-Match header when updating.","example":"ea95132c15732412d22c1476fa83f27a","readOnly":true,"type":"string"},"etag-q3CF2kCS":{"description":"A digest of the IP data. Useful for determining if the data has changed.","example":"a8e453d9d129a3769407127936edfdb0","type":"string"},"event_custom_page_html":{"description":"If set, the event will override the waiting room's `custom_page_html` property while it is active. If null, the event will inherit it.","example":"{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}","nullable":true,"type":"string"},"event_description":{"default":"","description":"A note that you can use to add more details about the event.","example":"Production event - DO NOT MODIFY","type":"string"},"event_details_custom_page_html":{"example":"{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}","type":"string"},"event_details_disable_session_renewal":{"example":false,"type":"boolean"},"event_details_new_users_per_minute":{"type":"integer"},"event_details_queueing_method":{"example":"random","type":"string"},"event_details_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/event_details_result"}}}]},"event_details_result":{"properties":{"created_on":{"$ref":"#/components/schemas/timestamp"},"custom_page_html":{"$ref":"#/components/schemas/event_details_custom_page_html"},"description":{"$ref":"#/components/schemas/event_description"},"disable_session_renewal":{"$ref":"#/components/schemas/event_details_disable_session_renewal"},"event_end_time":{"$ref":"#/components/schemas/event_end_time"},"event_start_time":{"$ref":"#/components/schemas/event_start_time"},"id":{"$ref":"#/components/schemas/event_id"},"modified_on":{"$ref":"#/components/schemas/timestamp"},"name":{"$ref":"#/components/schemas/event_name"},"new_users_per_minute":{"$ref":"#/components/schemas/event_details_new_users_per_minute"},"prequeue_start_time":{"$ref":"#/components/schemas/event_prequeue_start_time"},"queueing_method":{"$ref":"#/components/schemas/event_details_queueing_method"},"session_duration":{"$ref":"#/components/schemas/event_details_session_duration"},"shuffle_at_event_start":{"$ref":"#/components/schemas/event_shuffle_at_event_start"},"suspended":{"$ref":"#/components/schemas/event_suspended"},"total_active_users":{"$ref":"#/components/schemas/event_details_total_active_users"}},"type":"object"},"event_details_session_duration":{"type":"integer"},"event_details_total_active_users":{"type":"integer"},"event_disable_session_renewal":{"description":"If set, the event will override the waiting room's `disable_session_renewal` property while it is active. If null, the event will inherit it.","nullable":true,"type":"boolean"},"event_end_time":{"description":"An ISO 8601 timestamp that marks the end of the event.","example":"2021-09-28T17:00:00.000Z","type":"string"},"event_id":{"example":"25756b2dfe6e378a06b033b670413757"},"event_id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/event_id"}},"type":"object"}}}]},"event_name":{"description":"A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.","example":"production_webinar_event","type":"string"},"event_new_users_per_minute":{"description":"If set, the event will override the waiting room's `new_users_per_minute` property while it is active. If null, the event will inherit it. This can only be set if the event's `total_active_users` property is also set.","maximum":2147483647,"minimum":200,"nullable":true,"type":"integer"},"event_prequeue_start_time":{"description":"An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before `event_start_time`.","example":"2021-09-28T15:00:00.000Z","nullable":true,"type":"string"},"event_queueing_method":{"description":"If set, the event will override the waiting room's `queueing_method` property while it is active. If null, the event will inherit it.","example":"random","nullable":true,"type":"string"},"event_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/event_result"}}}]},"event_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/event_result"},"type":"array"}}}]},"event_result":{"properties":{"created_on":{"$ref":"#/components/schemas/timestamp"},"custom_page_html":{"$ref":"#/components/schemas/event_custom_page_html"},"description":{"$ref":"#/components/schemas/event_description"},"disable_session_renewal":{"$ref":"#/components/schemas/event_disable_session_renewal"},"event_end_time":{"$ref":"#/components/schemas/event_end_time"},"event_start_time":{"$ref":"#/components/schemas/event_start_time"},"id":{"$ref":"#/components/schemas/event_id"},"modified_on":{"$ref":"#/components/schemas/timestamp"},"name":{"$ref":"#/components/schemas/event_name"},"new_users_per_minute":{"$ref":"#/components/schemas/event_new_users_per_minute"},"prequeue_start_time":{"$ref":"#/components/schemas/event_prequeue_start_time"},"queueing_method":{"$ref":"#/components/schemas/event_queueing_method"},"session_duration":{"$ref":"#/components/schemas/event_session_duration"},"shuffle_at_event_start":{"$ref":"#/components/schemas/event_shuffle_at_event_start"},"suspended":{"$ref":"#/components/schemas/event_suspended"},"total_active_users":{"$ref":"#/components/schemas/event_total_active_users"}},"type":"object"},"event_session_duration":{"description":"If set, the event will override the waiting room's `session_duration` property while it is active. If null, the event will inherit it.","maximum":30,"minimum":1,"nullable":true,"type":"integer"},"event_shuffle_at_event_start":{"default":false,"description":"If enabled, users in the prequeue will be shuffled randomly at the `event_start_time`. Requires that `prequeue_start_time` is not null. This is useful for situations when many users will join the event prequeue at the same time and you want to shuffle them to ensure fairness. Naturally, it makes the most sense to enable this feature when the `queueing_method` during the event respects ordering such as **fifo**, or else the shuffling may be unnecessary.","type":"boolean"},"event_start_time":{"description":"An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. The start time must be at least one minute before `event_end_time`.","example":"2021-09-28T15:30:00.000Z","type":"string"},"event_suspended":{"default":false,"description":"Suspends or allows an event. If set to `true`, the event is ignored and traffic will be handled based on the waiting room configuration.","type":"boolean"},"event_total_active_users":{"description":"If set, the event will override the waiting room's `total_active_users` property while it is active. If null, the event will inherit it. This can only be set if the event's `new_users_per_minute` property is also set.","maximum":2147483647,"minimum":200,"nullable":true,"type":"integer"},"everyone_rule":{"description":"Matches everyone.","properties":{"everyone":{"description":"An empty object which matches on all users.","example":{},"type":"object"}},"required":["everyone"],"title":"Everyone","type":"object"},"exclude":{"description":"Rules evaluated with a NOT logical operator. To match a policy, a user cannot meet any of the Exclude rules.","items":{"$ref":"#/components/schemas/rule"},"type":"array"},"exclude-TaQDb77a":{"description":"Rules evaluated with a NOT logical operator. To match a policy, a user cannot meet any of the Exclude rules.","items":{"$ref":"#/components/schemas/rule_components-schemas-rule"},"type":"array"},"exclude-tYW3UmZW":{"items":{"$ref":"#/components/schemas/split_tunnel"},"type":"array"},"exclude_office_ips":{"description":"Whether to add Microsoft IPs to split tunnel exclusions.","example":true,"type":"boolean"},"existed_at":{"description":"If provided, include only tunnels that were created (and not deleted) before this time.","example":"2019-10-12T07:20:50.52Z","format":"date-time","type":"string"},"expected_body":{"description":"A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.","example":"alive","type":"string"},"expected_codes":{"default":"200","description":"The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.","example":"2xx","type":"string"},"expiration":{"description":"The time, measured in number of seconds since the UNIX epoch, at which the key should expire.","example":1578435000,"type":"number"},"expiration-9DsFtGHX":{"description":"Sets the expiration time for a posture check result. If empty, the result remains valid until it is overwritten by new data from the WARP client.","example":"1h","type":"string"},"expiration_ttl":{"description":"The number of seconds for which the key should be visible before it expires. At least 60.","example":300,"type":"number"},"expired_on":{"description":"Date that the Client Certificate expires","example":"2033-02-20T23:18:00Z","readOnly":true,"type":"string"},"expires_at":{"description":"Shows when domain name registration expires.","example":"2019-08-28T23:59:59Z","format":"date-time","type":"string"},"expires_on":{"description":"When the certificate from the authority expires.","example":"2016-01-01T05:20:00Z","format":"date-time","readOnly":true,"type":"string"},"expires_on-dkbMDCaD":{"description":"The expiration time on or after which the JWT MUST NOT be accepted for processing.","example":"2020-01-01T00:00:00Z","format":"date-time","type":"string"},"expression":{"description":"The filter expression. For more information, refer to [Expressions](https://developers.cloudflare.com/ruleset-engine/rules-language/expressions/).","example":"(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155","type":"string"},"externally_managed":{"default":false,"description":"Indicates whether this plan is managed externally.","example":false,"type":"boolean"},"facebook":{"allOf":[{"$ref":"#/components/schemas/identity-provider"},{"properties":{"config":{"$ref":"#/components/schemas/generic-oauth-config"}},"type":"object"}],"title":"Facebook","type":"object"},"fail_closed":{"description":"Block requests for files that cannot be scanned.","example":false,"type":"boolean"},"failed_login_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"properties":{"expiration":{"type":"integer"},"metadata":{"example":{"app_name":"Test App","aud":"39691c1480a2352a18ece567debc2b32552686cbd38eec0887aa18d5d3f00c04","datetime":"2022-02-02T21:54:34.914Z","ray_id":"6d76a8a42ead4133","user_email":"test@cloudflare.com","user_uuid":"57171132-e453-4ee8-b2a5-8cbaad333207"},"type":"object"}},"type":"object"},"type":"array"}}}]},"failure_reason":{"description":"The current failure reason if status is unhealthy.","example":"","readOnly":true,"type":"string"},"fallback_domain":{"properties":{"description":{"description":"A description of the fallback domain, displayed in the client UI.","example":"Domain bypass for local development","maxLength":100,"type":"string"},"dns_server":{"description":"A list of IP addresses to handle domain resolution.","items":{},"type":"array"},"suffix":{"description":"The domain suffix to match when resolving locally.","example":"example.com","type":"string"}},"required":["suffix"],"type":"object"},"fallback_domain_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/fallback_domain"},"type":"array"}}}]},"fallback_domains":{"items":{"$ref":"#/components/schemas/fallback_domain"},"type":"array"},"fallback_origin_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"fallback_pool":{"description":"The pool ID to use when all other pools are detected as unhealthy."},"fax":{"description":"Contact fax number.","example":"123-867-5309","type":"string"},"feature_app_props":{"properties":{"allowed_idps":{"$ref":"#/components/schemas/allowed_idps"},"auto_redirect_to_identity":{"$ref":"#/components/schemas/schemas-auto_redirect_to_identity"},"domain":{"$ref":"#/components/schemas/domain"},"name":{"$ref":"#/components/schemas/apps_components-schemas-name"},"session_duration":{"$ref":"#/components/schemas/session_duration-itWcJrO0"},"type":{"$ref":"#/components/schemas/type-u7orNcta"}},"required":["type"],"type":"object"},"feature_app_props-g2VC0WUC":{"properties":{"allowed_idps":{"$ref":"#/components/schemas/allowed_idps"},"auto_redirect_to_identity":{"$ref":"#/components/schemas/auto_redirect_to_identity-zRTYoQOC"},"domain":{"$ref":"#/components/schemas/schemas-domain-N8byIUtr"},"name":{"$ref":"#/components/schemas/apps_components-schemas-name"},"session_duration":{"$ref":"#/components/schemas/session_duration-ZxG3i84k"},"type":{"$ref":"#/components/schemas/apps_components-schemas-type"}},"type":"object"},"features":{"anyOf":[{"$ref":"#/components/schemas/thresholds"},{"$ref":"#/components/schemas/parameter_schemas"}],"readOnly":true,"type":"object"},"fetched_at":{"description":"The timestamp of when the script was last fetched.","nullable":true,"type":"string"},"fields":{"description":"Comma-separated list of fields.","example":"ClientIP,ClientRequestHost,ClientRequestMethod,ClientRequestURI,EdgeEndTimestamp,EdgeResponseBytes,EdgeResponseStatus,EdgeStartTimestamp,RayID","type":"string"},"fields_response":{"properties":{"key":{"example":"value","type":"string"}},"type":"object"},"filename":{"description":"Image file name.","example":"logo.png","maxLength":32,"readOnly":true,"type":"string"},"filter":{"description":"Filters to drill down into specific events.","example":"{\"where\":{\"and\":[{\"key\":\"ClientCountry\",\"operator\":\"neq\",\"value\":\"ca\"}]}}","type":"string"},"filter-delete-response-collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"allOf":[{"$ref":"#/components/schemas/filter-k8oSIkrx"},{"required":["id"],"type":"object"}]},"type":"array"}},"type":"object"}]},"filter-delete-response-single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/filter-k8oSIkrx"},{"required":["id"],"type":"object"}]}},"required":["result"],"type":"object"}]},"filter-k8oSIkrx":{"additionalProperties":false,"properties":{"description":{"$ref":"#/components/schemas/filters_components-schemas-description"},"expression":{"$ref":"#/components/schemas/expression"},"id":{"$ref":"#/components/schemas/filters_components-schemas-id"},"paused":{"$ref":"#/components/schemas/filters_components-schemas-paused"},"ref":{"$ref":"#/components/schemas/schemas-ref"}},"type":"object"},"filter-no-id":{"properties":{"enabled":{"$ref":"#/components/schemas/filters_components-schemas-enabled"},"pattern":{"$ref":"#/components/schemas/schemas-pattern"}},"required":["pattern","enabled"]},"filter-response-collection":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/filters-TIm7UZqb"},"type":"array"}}}]},"filter-response-single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/filters-TIm7UZqb"}}}]},"filter-rule-base":{"properties":{"action":{"$ref":"#/components/schemas/components-schemas-action"},"description":{"$ref":"#/components/schemas/firewall-rules_components-schemas-description"},"id":{"$ref":"#/components/schemas/firewall-rules_components-schemas-id"},"paused":{"$ref":"#/components/schemas/components-schemas-paused"},"priority":{"$ref":"#/components/schemas/firewall-rules_components-schemas-priority"},"products":{"$ref":"#/components/schemas/products"},"ref":{"$ref":"#/components/schemas/ref"}},"type":"object"},"filter-rule-response":{"allOf":[{"$ref":"#/components/schemas/filter-rule-base"},{"properties":{"filter":{"oneOf":[{"$ref":"#/components/schemas/filter-k8oSIkrx"},{"$ref":"#/components/schemas/deleted-filter"}]}}}],"type":"object"},"filter-rules-response-collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"allOf":[{"$ref":"#/components/schemas/filter-rule-response"},{"required":["id","filter","action","paused"],"type":"object"}]},"type":"array"}},"required":["result"],"type":"object"}]},"filter-rules-response-collection-delete":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"allOf":[{"$ref":"#/components/schemas/filter-rule-response"},{"required":["id"],"type":"object"}]},"type":"array"}},"required":["result"],"type":"object"}]},"filter-rules-single-response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/filter-rule-response"},{"required":["id","filter","action","paused"],"type":"object"}]}},"required":["result"],"type":"object"}]},"filter-rules-single-response-delete":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/filter-rule-response"},{"required":["id"],"type":"object"}]}},"required":["result"],"type":"object"}]},"filter_options":{"description":"Filter options for a particular resource type (pool or origin). Use null to reset.","nullable":true,"properties":{"disable":{"default":false,"description":"If set true, disable notifications for this type of resource (pool or origin).","type":"boolean"},"healthy":{"description":"If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events).","nullable":true,"type":"boolean"}},"type":"object"},"filters":{"description":"The protocol or layer to evaluate the traffic, identity, and device posture expressions.","example":["http"],"items":{"description":"The protocol or layer to use.","enum":["http","dns","l4","egress"],"example":"http","type":"string"},"type":"array"},"filters-6K6BiPDe":{"description":"Segmentation filter in 'attribute operator value' format.","example":"responseCode==NOERROR,queryType==A","type":"string"},"filters-TIm7UZqb":{"properties":{"enabled":{"$ref":"#/components/schemas/filters_components-schemas-enabled"},"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"pattern":{"$ref":"#/components/schemas/schemas-pattern"}},"required":["id","pattern","enabled"],"type":"object"},"filters_components-schemas-description":{"description":"An informative summary of the filter.","example":"Restrict access from these browsers on this address range.","maxLength":500,"type":"string"},"filters_components-schemas-enabled":{"example":true,"title":"Whether or not this filter will run a script","type":"boolean"},"filters_components-schemas-id":{"description":"The unique identifier of the filter.","example":"372e67954025e0ba6aaa6d586b9e0b61","maxLength":32,"minLength":32,"readOnly":true,"type":"string"},"filters_components-schemas-paused":{"description":"When true, indicates that the filter is currently paused.","example":false,"type":"boolean"},"fingerprint":{"description":"The MD5 fingerprint of the certificate.","example":"MD5 Fingerprint=1E:80:0F:7A:FD:31:55:96:DE:D5:CB:E2:F0:91:F6:91","type":"string"},"fingerprint_sha256":{"description":"Unique identifier of the Client Certificate","example":"256c24690243359fb8cf139a125bd05ebf1d968b71e4caf330718e9f5c8a89ea","readOnly":true,"type":"string"},"fips-settings":{"description":"FIPS settings.","properties":{"tls":{"description":"Enable only cipher suites and TLS versions compliant with FIPS 140-2.","example":true,"type":"boolean"}},"type":"object"},"firewall-rules_components-schemas-description":{"description":"An informative summary of the firewall rule.","example":"Blocks traffic identified during investigation for MIR-31","maxLength":500,"type":"string"},"firewall-rules_components-schemas-id":{"description":"The unique identifier of the firewall rule.","example":"372e67954025e0ba6aaa6d586b9e0b60","maxLength":32,"readOnly":true,"type":"string"},"firewall-rules_components-schemas-priority":{"description":"The priority of the rule. Optional value used to define the processing order. A lower number indicates a higher priority. If not provided, rules with a defined priority will be processed before rules without a priority.","example":50,"maximum":2147483647,"minimum":0,"type":"number"},"firewalluablock":{"properties":{"configuration":{"$ref":"#/components/schemas/components-schemas-configuration"},"description":{"$ref":"#/components/schemas/ua-rules_components-schemas-description"},"id":{"$ref":"#/components/schemas/ua-rules_components-schemas-id"},"mode":{"$ref":"#/components/schemas/ua-rules_components-schemas-mode"},"paused":{"$ref":"#/components/schemas/schemas-paused"}}},"firewalluablock_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/ua-rules"},"type":"array"}},"type":"object"}]},"firewalluablock_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}},"type":"object"}]},"first_name":{"description":"User's first name","example":"John","maxLength":60,"nullable":true,"type":"string"},"fit":{"description":"The fit property describes how the width and height dimensions should be interpreted.","enum":["scale-down","contain","cover","crop","pad"],"example":"scale-down","type":"string"},"flag":{"description":"The log retention flag for Logpull API.","example":true,"type":"boolean"},"flag_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"flag":{"example":true,"type":"boolean"}},"type":"object"}}}]},"flags":{"description":"Flag for DNSSEC record.","example":257,"nullable":true,"readOnly":true,"type":"number"},"follow_redirects":{"default":false,"description":"Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.","example":true,"type":"boolean"},"force_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/force_result"}}}]},"force_result":{"description":"When force_axfr query parameter is set to true, the response is a simple string","example":"OK","type":"string"},"frequency":{"default":"high","description":"The frequency at which Cloudflare sends batches of logs to your destination. Setting frequency to high sends your logs in larger quantities of smaller files. Setting frequency to low sends logs in smaller quantities of larger files.","enum":["high","low"],"example":"high","nullable":true,"type":"string"},"frequency-StdFMmw2":{"description":"How often the subscription is renewed automatically.","enum":["weekly","monthly","quarterly","yearly"],"example":"monthly","type":"string"},"full_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/address-maps"},{"properties":{"ips":{"$ref":"#/components/schemas/schemas-ips"},"memberships":{"$ref":"#/components/schemas/memberships"}},"type":"object"}]}},"type":"object"}]},"full_response-VmfHZCxr":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/address-maps-ldXASIMl"},{"properties":{"ips":{"$ref":"#/components/schemas/ips-noQAIDso"},"memberships":{"$ref":"#/components/schemas/memberships"}},"type":"object"}]}},"type":"object"}]},"gateway-account-device-settings":{"properties":{"gateway_proxy_enabled":{"description":"Enable gateway proxy filtering on TCP.","example":true,"type":"boolean"},"gateway_udp_proxy_enabled":{"description":"Enable gateway proxy filtering on UDP.","example":true,"type":"boolean"}},"type":"object"},"gateway-account-device-settings-response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/gateway-account-device-settings"}}}],"type":"object"},"gateway-account-logging-settings":{"properties":{"redact_pii":{"description":"Redact personally identifiable information from activity logging (PII fields are: source IP, user email, user ID, device ID, URL, referrer, user agent).","example":true,"type":"boolean"},"settings_by_rule_type":{"description":"Logging settings by rule type.","properties":{"dns":{"description":"Logging settings for DNS firewall.","type":"object"},"http":{"description":"Logging settings for HTTP/HTTPS firewall.","type":"object"},"l4":{"description":"Logging settings for Network firewall.","type":"object"}},"type":"object"}},"type":"object"},"gateway-account-logging-settings-response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/gateway-account-logging-settings"}}}],"type":"object"},"gateway-account-settings":{"description":"account settings.","properties":{"settings":{"description":"account settings.","properties":{"activity_log":{"$ref":"#/components/schemas/activity-log-settings"},"antivirus":{"$ref":"#/components/schemas/anti-virus-settings"},"block_page":{"$ref":"#/components/schemas/block-page-settings"},"body_scanning":{"$ref":"#/components/schemas/body-scanning-settings"},"browser_isolation":{"$ref":"#/components/schemas/browser-isolation-settings"},"custom_certificate":{"$ref":"#/components/schemas/custom-certificate-settings"},"fips":{"$ref":"#/components/schemas/fips-settings"},"tls_decrypt":{"$ref":"#/components/schemas/tls-settings"}},"type":"object"}},"type":"object"},"gateway_account":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"gateway_tag":{"$ref":"#/components/schemas/gateway_tag"},"id":{"$ref":"#/components/schemas/cf_account_id"},"provider_name":{"$ref":"#/components/schemas/provider_name"}},"type":"object"}}}],"type":"object"},"gateway_account_config":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/gateway-account-settings"},{"properties":{"created_at":{"$ref":"#/components/schemas/timestamp"},"updated_at":{"$ref":"#/components/schemas/timestamp"}}}],"type":"object"}}}],"type":"object"},"gateway_seat":{"description":"True if the seat is part of Gateway.","example":false,"type":"boolean"},"gateway_tag":{"description":"Gateway internal id.","example":"f174e90afafe4643bbbc4a0ed4fc8415","maxLength":32,"type":"string"},"gateway_unique_id":{"example":"699d98642c564d2e855e9661899b7252","type":"string"},"generic-oauth-config":{"properties":{"client_id":{"description":"Your OAuth Client ID","example":"\u003cyour client id\u003e","type":"string"},"client_secret":{"description":"Your OAuth Client Secret","example":"\u003cyour client secret\u003e","type":"string"}},"type":"object"},"geo_restrictions":{"description":"Specify the region where your private key can be held locally for optimal TLS performance. HTTPS connections to any excluded data center will still be fully encrypted, but will incur some latency while Keyless SSL is used to complete the handshake with the nearest allowed data center. Options allow distribution to only to U.S. data centers, only to E.U. data centers, or only to highest security data centers. Default distribution is to all Cloudflare datacenters, for optimal performance.","properties":{"label":{"enum":["us","eu","highest_security"],"example":"us"}},"type":"object"},"get-zone-connection-response":{"allOf":[{"$ref":"#/components/schemas/connection"}]},"get-zone-script-response":{"allOf":[{"$ref":"#/components/schemas/script"},{"properties":{"versions":{"example":[{"fetched_at":"2021-08-18T10:51:08Z","hash":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b423","js_integrity_score":2}],"items":{"$ref":"#/components/schemas/version"},"nullable":true,"type":"array"}}}]},"get-zone-settings-response":{"properties":{"enabled":{"$ref":"#/components/schemas/enabled-N6CliIvj"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"use_cloudflare_reporting_endpoint":{"$ref":"#/components/schemas/use_cloudflare_reporting_endpoint"},"use_connection_url_path":{"$ref":"#/components/schemas/use_connection_url_path"}}},"get_ownership_response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"nullable":true,"properties":{"filename":{"example":"logs/challenge-filename.txt","type":"string"},"message":{"example":"","type":"string"},"valid":{"example":true,"type":"boolean"}},"type":"object"}}}]},"get_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"$ref":"#/components/schemas/zone_metadata"}]},"get_settings_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"public_key":{"example":"EmpOvSXw8BfbrGCi0fhGiD/3yXk2SiV1Nzg2lru3oj0=","nullable":true,"type":"string"}},"required":["public_key"]}}}]},"github":{"allOf":[{"$ref":"#/components/schemas/identity-provider"},{"properties":{"config":{"$ref":"#/components/schemas/generic-oauth-config"}},"type":"object"}],"title":"GitHub","type":"object"},"github_organization_rule":{"description":"Matches a Github organization.\nRequires a Github identity provider.","properties":{"github-organization":{"properties":{"connection_id":{"description":"The ID of your Github identity provider.","example":"ea85612a-29c8-46c2-bacb-669d65136971","type":"string"},"name":{"description":"The name of the organization.","example":"cloudflare","type":"string"}},"required":["name","connection_id"],"type":"object"}},"required":["github-organization"],"title":"Github organization","type":"object"},"google":{"allOf":[{"$ref":"#/components/schemas/identity-provider"},{"properties":{"config":{"$ref":"#/components/schemas/generic-oauth-config"}},"type":"object"}],"title":"Google","type":"object"},"google-apps":{"allOf":[{"$ref":"#/components/schemas/identity-provider"},{"properties":{"config":{"allOf":[{"$ref":"#/components/schemas/generic-oauth-config"},{"properties":{"apps_domain":{"description":"Your companies TLD","example":"mycompany.com","type":"string"}},"type":"object"}]}},"type":"object"}],"title":"Google Workspace","type":"object"},"grants":{"example":{"read":true,"write":false},"properties":{"read":{"example":true,"type":"boolean"},"write":{"example":true,"type":"boolean"}},"type":"object"},"gre":{"description":"The configuration specific to GRE interconnects.","properties":{"cloudflare_endpoint":{"description":"The IP address assigned to the Cloudflare side of the GRE tunnel created as part of the Interconnect.","example":"203.0.113.1","type":"string"}},"type":"object"},"gre-tunnel":{"properties":{"cloudflare_gre_endpoint":{"$ref":"#/components/schemas/cloudflare_gre_endpoint"},"created_on":{"$ref":"#/components/schemas/schemas-created_on"},"customer_gre_endpoint":{"$ref":"#/components/schemas/customer_gre_endpoint"},"description":{"$ref":"#/components/schemas/schemas-description-SitV9b51"},"health_check":{"$ref":"#/components/schemas/health_check"},"id":{"$ref":"#/components/schemas/schemas-identifier-67y1Mk1I"},"interface_address":{"$ref":"#/components/schemas/interface_address"},"modified_on":{"$ref":"#/components/schemas/schemas-modified_on"},"mtu":{"$ref":"#/components/schemas/mtu"},"name":{"$ref":"#/components/schemas/name-z6BHq9UH"},"ttl":{"$ref":"#/components/schemas/ttl"}},"required":["name","customer_gre_endpoint","cloudflare_gre_endpoint","interface_address"],"type":"object"},"group":{"properties":{"description":{"$ref":"#/components/schemas/group_components-schemas-description"},"id":{"$ref":"#/components/schemas/group_components-schemas-identifier"},"modified_rules_count":{"$ref":"#/components/schemas/modified_rules_count"},"name":{"$ref":"#/components/schemas/group_components-schemas-name"},"package_id":{"$ref":"#/components/schemas/package_components-schemas-identifier"},"rules_count":{"$ref":"#/components/schemas/rules_count"}},"type":"object"},"group_components-schemas-description":{"description":"An informative summary of what the rule group does.","example":"Group designed to protect against IP addresses that are a threat and typically used to launch DDoS attacks","nullable":true,"readOnly":true,"type":"string"},"group_components-schemas-identifier":{"description":"The unique identifier of the rule group.","example":"de677e5818985db1285d0e80225f06e5","maxLength":32,"readOnly":true,"type":"string"},"group_components-schemas-name":{"description":"The name of the rule group.","example":"Project Honey Pot","readOnly":true,"type":"string"},"groups":{"properties":{"created_at":{"$ref":"#/components/schemas/timestamp"},"exclude":{"$ref":"#/components/schemas/exclude"},"id":{"$ref":"#/components/schemas/schemas-uuid-JmfIpL8C"},"include":{"$ref":"#/components/schemas/include"},"name":{"$ref":"#/components/schemas/components-schemas-name-4G3Rlgj8"},"require":{"$ref":"#/components/schemas/require"},"updated_at":{"$ref":"#/components/schemas/timestamp"}},"type":"object"},"groups-fQOB8cgI":{"additionalProperties":true,"description":"An object that allows you to enable or disable WAF rule groups for the current WAF override. Each key of this object must be the ID of a WAF rule group, and each value must be a valid WAF action (usually `default` or `disable`). When creating a new URI-based WAF override, you must provide a `groups` object or a `rules` object.","example":{"ea8687e59929c1fd05ba97574ad43f77":"default"},"type":"object"},"groups_components-schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/schemas-uuid-vgvRNXQL"}},"type":"object"}}}]},"groups_components-schemas-name":{"description":"The name of the Access group.","example":"Allow devs","type":"string"},"groups_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/schemas-groups"},"type":"array"}}}]},"groups_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/schemas-groups"}}}]},"gsuite_group_rule":{"description":"Matches a group in Google Workspace.\nRequires a Google Workspace identity provider.","properties":{"gsuite":{"properties":{"connection_id":{"description":"The ID of your Google Workspace identity provider.","example":"ea85612a-29c8-46c2-bacb-669d65136971","type":"string"},"email":{"description":"The email of the Google Workspace group.","example":"devs@cloudflare.com","type":"string"}},"required":["email","connection_id"],"type":"object"}},"required":["gsuite"],"title":"Google Workspace group","type":"object"},"h2_prioritization":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["h2_prioritization"],"example":"h2_prioritization"},"value":{"$ref":"#/components/schemas/h2_prioritization_value"}}}],"description":"HTTP/2 Edge Prioritization optimises the delivery of resources served through HTTP/2 to improve page load performance. It also supports fine control of content delivery when used in conjunction with Workers.","title":"HTTP/2 Edge Prioritization"},"h2_prioritization_value":{"default":"off","description":"Value of the zone setting.","enum":["on","off","custom"],"type":"string"},"hash":{"description":"The computed hash of the analyzed script.","maxLength":64,"minLength":64,"nullable":true,"type":"string"},"header":{"description":"The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.","example":{"Host":["example.com"],"X-App-ID":["abc123"]},"type":"object"},"header_name":{"description":"The name of the response header to match.","example":"Cf-Cache-Status","type":"string"},"header_op":{"description":"The operator used when matching: `eq` means \"equal\" and `ne` means \"not equal\".","enum":["eq","ne"],"example":"ne","type":"string"},"header_value":{"description":"The value of the response header, which must match exactly.","example":"HIT","type":"string"},"health_check":{"properties":{"enabled":{"default":true,"description":"Determines whether to run healthchecks for a tunnel.","example":true,"type":"boolean"},"rate":{"default":"mid","description":"How frequent the health check is run. The default value is `mid`.","enum":["low","mid","high"],"example":"low","type":"string"},"target":{"description":"The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`.","example":"203.0.113.1","type":"string"},"type":{"default":"reply","description":"The type of healthcheck to run, reply or request. The default value is `reply`.","enum":["reply","request"],"example":"request","type":"string"}},"type":"object"},"health_details":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"description":"A list of regions from which to run health checks. Null means every Cloudflare data center.","example":{"pool_id":"17b5962d775c646f3f9725cbc7a53df4","pop_health":{"Amsterdam, NL":{"healthy":true,"origins":[{"2001:DB8::5":{"failure_reason":"No failures","healthy":true,"response_code":401,"rtt":"12.1ms"}}]}}},"type":"object"}}}]},"healthchecks":{"properties":{"address":{"$ref":"#/components/schemas/address"},"check_regions":{"$ref":"#/components/schemas/check_regions"},"consecutive_fails":{"$ref":"#/components/schemas/consecutive_fails"},"consecutive_successes":{"$ref":"#/components/schemas/consecutive_successes"},"created_on":{"$ref":"#/components/schemas/timestamp"},"description":{"$ref":"#/components/schemas/description-hRvlp2wh"},"failure_reason":{"$ref":"#/components/schemas/failure_reason"},"http_config":{"$ref":"#/components/schemas/http_config"},"id":{"$ref":"#/components/schemas/identifier-Kg4WBtjI"},"interval":{"$ref":"#/components/schemas/interval"},"modified_on":{"$ref":"#/components/schemas/timestamp"},"name":{"$ref":"#/components/schemas/name-51RmM5yT"},"retries":{"$ref":"#/components/schemas/retries"},"status":{"$ref":"#/components/schemas/status"},"suspended":{"$ref":"#/components/schemas/suspended"},"tcp_config":{"$ref":"#/components/schemas/tcp_config"},"timeout":{"$ref":"#/components/schemas/timeout"},"type":{"$ref":"#/components/schemas/type-Eu3SX4l3"}},"type":"object"},"height":{"description":"Maximum height in image pixels.","example":768,"minimum":1,"type":"number"},"height-YS9whiRo":{"description":"The height of the image in pixels.","readOnly":true,"type":"integer"},"hero_url":{"description":"URI to hero variant for an image.","example":"https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/hero","format":"uri","readOnly":true,"type":"string"},"history":{"properties":{"alert_body":{"$ref":"#/components/schemas/alert_body"},"alert_type":{"$ref":"#/components/schemas/schemas-alert_type"},"description":{"$ref":"#/components/schemas/history_components-schemas-description"},"id":{"$ref":"#/components/schemas/uuid-s0SXln0q"},"mechanism":{"$ref":"#/components/schemas/mechanism"},"mechanism_type":{"$ref":"#/components/schemas/mechanism_type"},"name":{"$ref":"#/components/schemas/history_components-schemas-name"},"sent":{"$ref":"#/components/schemas/sent"}},"type":"object"},"history_components-schemas-description":{"description":"Description of the notification policy (if present).","example":"Universal Certificate validation status, issuance, renewal, and expiration notices","type":"string"},"history_components-schemas-name":{"description":"Name of the policy.","example":"SSL Notification Event Policy","type":"string"},"history_components-schemas-per_page":{"default":25,"description":"Number of items per page.","maximum":1000,"minimum":5,"type":"number"},"history_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"example":[{"alert_body":"SSL certificate has expired","alert_type":"universal_ssl_event_type","description":"Universal Certificate validation status, issuance, renewal, and expiration notices.","id":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","mechanism":"test@example.com","mechanism_type":"email","name":"SSL Notification Event Policy","sent":"2021-10-08T17:52:17.571336Z"}],"items":{"$ref":"#/components/schemas/history"},"type":"array"},"result_info":{"example":{"count":1,"page":1,"per_page":20},"type":"object"}}}]},"hop_result":{"properties":{"nodes":{"description":"An array of node objects.","items":{"$ref":"#/components/schemas/node_result"},"type":"array"},"packets_lost":{"$ref":"#/components/schemas/packets_lost"},"packets_sent":{"$ref":"#/components/schemas/packets_sent"},"packets_ttl":{"$ref":"#/components/schemas/packets_ttl"}},"type":"object"},"host":{"description":"The host name to which the waiting room will be applied (no wildcards). Please do not include the scheme (http:// or https://). The host and path combination must be unique.","example":"shop.example.com","type":"string"},"host-EEtGIG7W":{"description":"The keyless SSL name.","example":"example.com","format":"hostname","maxLength":253,"type":"string"},"host-nm3Leu3G":{"description":"RFC3986-compliant host.","example":"www.example.com","format":"hostname","maxLength":255,"type":"string"},"hostname":{"description":"The custom hostname that will point to your hostname via CNAME.","example":"app.example.com","maxLength":255,"readOnly":true,"type":"string"},"hostname-authenticated-origin-pull":{"allOf":[{"$ref":"#/components/schemas/hostname_certid_object"}],"properties":{"cert_id":{"$ref":"#/components/schemas/identifier-tZwYoMuc"},"certificate":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate"},"enabled":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-enabled"},"hostname":{"$ref":"#/components/schemas/schemas-hostname"},"id":{"$ref":"#/components/schemas/identifier-tZwYoMuc"},"private_key":{"$ref":"#/components/schemas/schemas-private_key"}},"type":"object"},"hostname-authenticated-origin-pull-q1NG48LD":{"allOf":[{"$ref":"#/components/schemas/hostname_certid_object-EGVUDBlM"}],"properties":{"cert_id":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier"},"certificate":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate"},"enabled":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-enabled"},"hostname":{"$ref":"#/components/schemas/schemas-hostname"},"id":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier"},"private_key":{"$ref":"#/components/schemas/schemas-private_key"}},"type":"object"},"hostname-authenticated-origin-pull_components-schemas-certificate":{"description":"The hostname certificate.","example":"-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n","type":"string"},"hostname-authenticated-origin-pull_components-schemas-certificate_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull-q1NG48LD"},"type":"array"}}}]},"hostname-authenticated-origin-pull_components-schemas-enabled":{"description":"Indicates whether hostname-level authenticated origin pulls is enabled. A null value voids the association.","example":true,"nullable":true,"type":"boolean"},"hostname-authenticated-origin-pull_components-schemas-expires_on":{"description":"The date when the certificate expires.","example":"2100-01-01T05:20:00Z","format":"date-time","readOnly":true,"type":"string"},"hostname-authenticated-origin-pull_components-schemas-identifier":{"description":"Certificate identifier tag.","example":"2458ce5a-0c35-4c7f-82c7-8e9487d3ff60","maxLength":36,"readOnly":true,"type":"string"},"hostname-authenticated-origin-pull_components-schemas-status":{"description":"Status of the certificate or the association.","enum":["initializing","pending_deployment","pending_deletion","active","deleted","deployment_timed_out","deletion_timed_out"],"example":"active","readOnly":true},"hostname_aop_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull-q1NG48LD"},"type":"array"}}}]},"hostname_aop_single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/hostname_certid_object-EGVUDBlM"}}}]},"hostname_association":{"properties":{"hostnames":{"items":{"example":"api.example.com","type":"string"},"type":"array"}},"type":"object"},"hostname_associations_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/hostname_association"}}}]},"hostname_certid_input":{"properties":{"cert_id":{"$ref":"#/components/schemas/cert_id"},"enabled":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-enabled"},"hostname":{"$ref":"#/components/schemas/schemas-hostname"}},"type":"object"},"hostname_certid_input-CNETqmIk":{"properties":{"cert_id":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier"},"enabled":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-enabled"},"hostname":{"$ref":"#/components/schemas/schemas-hostname"}},"type":"object"},"hostname_certid_object":{"properties":{"cert_id":{"$ref":"#/components/schemas/identifier-tZwYoMuc"},"cert_status":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-status"},"cert_updated_at":{"$ref":"#/components/schemas/updated_at-AejnlvA8"},"cert_uploaded_on":{"$ref":"#/components/schemas/components-schemas-uploaded_on"},"certificate":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate"},"created_at":{"$ref":"#/components/schemas/schemas-created_at"},"enabled":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-enabled"},"expires_on":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-expires_on"},"hostname":{"$ref":"#/components/schemas/schemas-hostname"},"issuer":{"$ref":"#/components/schemas/issuer"},"serial_number":{"$ref":"#/components/schemas/serial_number"},"signature":{"$ref":"#/components/schemas/signature"},"status":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-status"},"updated_at":{"$ref":"#/components/schemas/updated_at-AejnlvA8"}}},"hostname_certid_object-EGVUDBlM":{"properties":{"cert_id":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier"},"cert_status":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-status"},"cert_updated_at":{"$ref":"#/components/schemas/updated_at-W25UuRZk"},"cert_uploaded_on":{"$ref":"#/components/schemas/components-schemas-uploaded_on"},"certificate":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate"},"created_at":{"$ref":"#/components/schemas/schemas-created_at"},"enabled":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-enabled"},"expires_on":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-expires_on"},"hostname":{"$ref":"#/components/schemas/schemas-hostname"},"issuer":{"$ref":"#/components/schemas/issuer"},"serial_number":{"$ref":"#/components/schemas/serial_number"},"signature":{"$ref":"#/components/schemas/signature"},"status":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-status"},"updated_at":{"$ref":"#/components/schemas/updated_at-W25UuRZk"}}},"hostname_post":{"description":"The custom hostname that will point to your hostname via CNAME.","example":"app.example.com","maxLength":255,"type":"string"},"hostnames":{"description":"Array of hostnames or wildcard names (e.g., *.example.com) bound to the certificate.","example":["example.com","*.example.com"],"items":{},"type":"array"},"hosts":{"items":{"description":"The valid hosts for the certificates.","example":"example.com","maxLength":253,"readOnly":true,"type":"string"},"type":"array"},"hotlink_protection":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["hotlink_protection"],"example":"hotlink_protection"},"value":{"$ref":"#/components/schemas/hotlink_protection_value"}}}],"description":"When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it's not another site requesting them. People will still be able to download and view images from your page, but other sites won't be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026).","title":"Hotlink Protection"},"hotlink_protection_value":{"default":"off","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"http2":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["http2"],"example":"http2"},"value":{"$ref":"#/components/schemas/http2_value"}}}],"description":"HTTP2 enabled for this zone.","title":"HTTP2 Value"},"http2_value":{"default":"off","description":"Value of the HTTP2 setting.","enum":["on","off"],"type":"string"},"http3":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["http3"],"example":"http3"},"value":{"$ref":"#/components/schemas/http3_value"}}}],"description":"HTTP3 enabled for this zone.","title":"HTTP3 Value"},"http3_value":{"default":"off","description":"Value of the HTTP3 setting.","enum":["on","off"],"type":"string"},"http_config":{"description":"Parameters specific to an HTTP or HTTPS health check.","nullable":true,"properties":{"allow_insecure":{"default":false,"description":"Do not validate the certificate when the health check uses HTTPS.","type":"boolean"},"expected_body":{"description":"A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy.","example":"success","type":"string"},"expected_codes":{"default":"200","description":"The expected HTTP response codes (e.g. \"200\") or code ranges (e.g. \"2xx\" for all codes starting with 2) of the health check.","example":["2xx","302"],"items":{"type":"string"},"nullable":true,"type":"array"},"follow_redirects":{"default":false,"description":"Follow redirects if the origin returns a 3xx status code.","type":"boolean"},"header":{"description":"The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden.","example":{"Host":["example.com"],"X-App-ID":["abc123"]},"nullable":true,"type":"object"},"method":{"default":"GET","description":"The HTTP method to use for the health check.","enum":["GET","HEAD"],"type":"string"},"path":{"default":"/","description":"The endpoint path to health check against.","example":"/health","type":"string"},"port":{"default":80,"description":"Port number to connect to for the health check. Defaults to 80 if type is HTTP or 443 if type is HTTPS.","type":"integer"}},"type":"object"},"http_only_cookie_attribute":{"default":true,"description":"Enables the HttpOnly cookie attribute, which increases security against XSS attacks.","example":true,"type":"boolean"},"id":{"description":"The identifier for this category. There is only one category per id.","type":"integer"},"id-6U71Robk":{"description":"Identifier of a recommedation result.","example":"ssl_recommendation","type":"string"},"id-Un5diNDY":{"description":"Unique id of the job.","minimum":1,"type":"integer"},"id-ZJpijMo1":{"description":"The ID of the resource.","example":"c9ef84a6bf5e47138c75d95e2f933e8f","maxLength":32,"minLength":32,"type":"string"},"id-e2D1eWah":{"description":"The ID of the CA.","example":"7eddae4619b50ab1361ba8ae9bd72269a432fea041529ed9","maxLength":48,"readOnly":true,"type":"string"},"id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/identifier-Kg4WBtjI"}},"type":"object"}}}]},"id_response-99rIWUZu":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/identifier-FZThz4k7"}},"type":"object"}}}]},"id_response-DDywCCxj":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/schemas-uuid-JmfIpL8C"}},"type":"object"}}}]},"id_response-I5lr4Hc3":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/delegation_identifier"}},"type":"object"}}}]},"id_response-W0Mu1ujx":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/monitor_components-schemas-identifier"}},"type":"object"}}}]},"id_response-eHg5OKOR":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/uuid-l20MFQPz"}},"type":"object"}}}]},"id_response-lg4lL9us":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/identifier-ahBjrSIO"}},"type":"object"}}}]},"identifier":{"example":"699d98642c564d2e855e9661899b7252"},"identifier-59LodGbZ":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"identifier-5dNKLCP5":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"identifier-98VX040R":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"identifier-A3V71xbt":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"identifier-BccsQUhC":{"type":"string"},"identifier-ECDhGQVO":{"description":"Policy identifier.","example":"f267e341f3dd4697bd3b9f71dd96247f","readOnly":true,"type":"string"},"identifier-FZThz4k7":{"example":"f1aba936b94213e5b8dca0c0dbf1f9cc"},"identifier-Gw95Cj70":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"identifier-JiolAARC":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"identifier-Kg4WBtjI":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"identifier-MZFDye9j":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"type":"string"},"identifier-W1xsq8r6":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"identifier-XSj9HnWY":{"description":"A Cloudflare-generated unique identifier for a media item.","example":"ea95132c15732412d22c1476fa83f27a","maxLength":32,"readOnly":true,"type":"string"},"identifier-YhmC5GTP":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"identifier-ahBjrSIO":{"example":"269d8f4853475ca241c4e730be286b20","readOnly":true},"identifier-b3jdvVAb":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"identifier-fzl1amog":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"identifier-g7jwPNXP":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"identifier-gI2sCanq":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"identifier-jnfvAiHn":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"identifier-oBX6a2Mp":{"description":"Account identifier tag.","example":"372e67954025e0ba6aaa6d586b9e0b59","maxLength":32,"readOnly":true,"type":"string"},"identifier-smPsQb9r":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"identifier-tZwYoMuc":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"identifier-v0xEcFCj":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"identifier-zpETYDGh":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"identity":{"description":"The wirefilter expression to be used for identity matching.","example":"any(identity.groups.name[*] in {\"finance\"})","type":"string"},"identity-provider":{"properties":{"config":{"description":"The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).","type":"object"},"id":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"},"name":{"$ref":"#/components/schemas/schemas-name-QA00iN6H"},"scim_config":{"description":"The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.","properties":{"enabled":{"description":"A flag to enable or disable SCIM for the identity provider.","type":"boolean"},"group_member_deprovision":{"description":"A flag to revoke a user's session in Access and force a reauthentication on the user's Gateway session when they have been added or removed from a group in the Identity Provider.","type":"boolean"},"seat_deprovision":{"description":"A flag to remove a user's seat in Zero Trust when they have been deprovisioned in the Identity Provider. This cannot be enabled unless user_deprovision is also enabled.","type":"boolean"},"secret":{"description":"A read-only token generated when the SCIM integration is enabled for the first time. It is redacted on subsequent requests. If you lose this you will need to refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.","type":"string"},"user_deprovision":{"description":"A flag to enable revoking a user's session in Access and Gateway when they have been deprovisioned in the Identity Provider.","type":"boolean"}},"type":"object"},"type":{"description":"The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).","example":"onetimepin","type":"string"}},"required":["name","type","config"],"type":"object"},"identity-providers":{"oneOf":[{"$ref":"#/components/schemas/azureAD"},{"$ref":"#/components/schemas/centrify"},{"$ref":"#/components/schemas/facebook"},{"$ref":"#/components/schemas/github"},{"$ref":"#/components/schemas/google"},{"$ref":"#/components/schemas/google-apps"},{"$ref":"#/components/schemas/linkedin"},{"$ref":"#/components/schemas/oidc"},{"$ref":"#/components/schemas/okta"},{"$ref":"#/components/schemas/onelogin"},{"$ref":"#/components/schemas/pingone"},{"$ref":"#/components/schemas/saml"},{"$ref":"#/components/schemas/yandex"}]},"identity-providers-jdnkP8pB":{"properties":{"config":{"$ref":"#/components/schemas/schemas-config"},"id":{"$ref":"#/components/schemas/uuid-s0SXln0q"},"name":{"$ref":"#/components/schemas/identity-providers_components-schemas-name"},"type":{"$ref":"#/components/schemas/identity-providers_components-schemas-type"}},"type":"object"},"identity-providers_components-schemas-name":{"description":"The name of the identity provider, shown to users on the login page.","example":"Widget Corps OTP","type":"string"},"identity-providers_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"anyOf":[{"$ref":"#/components/schemas/schemas-azureAD"},{"$ref":"#/components/schemas/schemas-centrify"},{"$ref":"#/components/schemas/schemas-facebook"},{"$ref":"#/components/schemas/schemas-github"},{"$ref":"#/components/schemas/schemas-google"},{"$ref":"#/components/schemas/schemas-google-apps"},{"$ref":"#/components/schemas/schemas-linkedin"},{"$ref":"#/components/schemas/schemas-oidc"},{"$ref":"#/components/schemas/schemas-okta"},{"$ref":"#/components/schemas/schemas-onelogin"},{"$ref":"#/components/schemas/schemas-pingone"},{"$ref":"#/components/schemas/schemas-saml"},{"$ref":"#/components/schemas/schemas-yandex"}]},"type":"array"}},"type":"object"}],"type":"object"},"identity-providers_components-schemas-response_collection-7VdQuy6l":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/identity-providers-jdnkP8pB"},"type":"array"}}}]},"identity-providers_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/schemas-identity-providers"}}}]},"identity-providers_components-schemas-single_response-mzpMSK38":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/identity-providers-jdnkP8pB"}}}]},"identity-providers_components-schemas-type":{"description":"The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).","example":"onetimepin","type":"string"},"image_basic_upload_via_url":{"properties":{"metadata":{"description":"User modifiable key-value store. Can use used for keeping references to another system of record for managing images.","type":"object"},"requireSignedURLs":{"default":false,"description":"Indicates whether the image requires a signature token for the access.","example":true,"type":"boolean"},"url":{"description":"A URL to fetch an image from origin.","example":"https://example.com/path/to/logo.png","type":"string"}},"required":["url"],"type":"object"},"image_patch_request":{"properties":{"metadata":{"description":"User modifiable key-value store. Can be used for keeping references to another system of record for managing images. No change if not specified.","type":"object"},"requireSignedURLs":{"description":"Indicates whether the image can be accessed using only its UID. If set to `true`, a signed token needs to be generated with a signing key to view the image. Returns a new UID on a change. No change if not specified.","example":true,"type":"boolean"}},"type":"object"},"image_resizing":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["image_resizing"],"example":"image_resizing"},"value":{"$ref":"#/components/schemas/image_resizing_value"}}}],"description":"Image Resizing provides on-demand resizing, conversion and optimisation for images served through Cloudflare's network. Refer to the [Image Resizing documentation](https://developers.cloudflare.com/images/) for more information.","title":"Image Resizing"},"image_resizing_value":{"default":"off","description":"Whether the feature is enabled, disabled, or enabled in `open proxy` mode.","enum":["on","off","open"],"type":"string"},"image_response_blob":{"anyOf":[{"type":"string"},{"type":"object"}],"example":"\u003cimage blob data\u003e"},"image_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/images"},"type":"array"}}}]},"image_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"images":{"properties":{"filename":{"$ref":"#/components/schemas/filename"},"id":{"$ref":"#/components/schemas/images_components-schemas-identifier"},"metadata":{"$ref":"#/components/schemas/metadata"},"requireSignedURLs":{"$ref":"#/components/schemas/requireSignedURLs"},"uploaded":{"$ref":"#/components/schemas/uploaded"},"variants":{"$ref":"#/components/schemas/schemas-variants"}},"type":"object"},"images_components-schemas-identifier":{"description":"Image unique identifier.","example":"107b9558-dd06-4bbd-5fef-9c2c16bb7900","maxLength":32,"readOnly":true,"type":"string"},"images_count":{"properties":{"allowed":{"$ref":"#/components/schemas/allowed-r2rT3jf5"},"current":{"$ref":"#/components/schemas/current"}},"type":"object"},"images_stats":{"properties":{"count":{"$ref":"#/components/schemas/images_count"}},"type":"object"},"include":{"description":"Rules evaluated with an OR logical operator. A user needs to meet only one of the Include rules.","items":{"$ref":"#/components/schemas/rule"},"type":"array"},"include-6K7SmqAm":{"description":"Rules evaluated with an OR logical operator. A user needs to meet only one of the Include rules.","items":{"$ref":"#/components/schemas/rule_components-schemas-rule"},"type":"array"},"include-9GPmbbUN":{"items":{"$ref":"#/components/schemas/split_tunnel_include"},"type":"array"},"input":{"description":"The value to be checked against.","properties":{"id":{"$ref":"#/components/schemas/device-posture-rules_components-schemas-uuid"}},"type":"object"},"input-NaZjecAw":{"description":"The value to be checked against.","properties":{"checkDisks":{"$ref":"#/components/schemas/checkDisks"},"id":{"$ref":"#/components/schemas/uuid-l20MFQPz"},"requireAll":{"$ref":"#/components/schemas/requireAll"}},"type":"object"},"input-kvQ6FpFL":{"properties":{"height":{"description":"The video height in pixels. A value of `-1` means the height is unknown. The value becomes available after the upload and before the video is ready.","readOnly":true,"type":"integer"},"width":{"description":"The video width in pixels. A value of `-1` means the width is unknown. The value becomes available after the upload and before the video is ready.","readOnly":true,"type":"integer"}},"readOnly":true,"type":"object"},"input_rtmps":{"description":"Details for streaming to an live input using RTMPS.","properties":{"streamKey":{"$ref":"#/components/schemas/input_rtmps_stream_key"},"url":{"$ref":"#/components/schemas/input_rtmps_url"}},"type":"object"},"input_rtmps_stream_key":{"description":"The secret key to use when streaming via RTMPS to a live input.","example":"2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada","readOnly":true,"type":"string"},"input_rtmps_url":{"description":"The RTMPS URL you provide to the broadcaster, which they stream live video to.","example":"rtmps://live.cloudflare.com:443/live/","readOnly":true,"type":"string"},"input_srt":{"description":"Details for streaming to a live input using SRT.","properties":{"passphrase":{"$ref":"#/components/schemas/input_srt_stream_passphrase"},"streamId":{"$ref":"#/components/schemas/input_srt_stream_id"},"url":{"$ref":"#/components/schemas/input_srt_url"}},"type":"object"},"input_srt_stream_id":{"description":"The identifier of the live input to use when streaming via SRT.","example":"f256e6ea9341d51eea64c9454659e576","readOnly":true,"type":"string"},"input_srt_stream_passphrase":{"description":"The secret key to use when streaming via SRT to a live input.","example":"2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada","readOnly":true,"type":"string"},"input_srt_url":{"description":"The SRT URL you provide to the broadcaster, which they stream live video to.","example":"srt://live.cloudflare.com:778","readOnly":true,"type":"string"},"input_webrtc":{"description":"Details for streaming to a live input using WebRTC.","properties":{"url":{"$ref":"#/components/schemas/input_webrtc_url"}},"type":"object"},"input_webrtc_url":{"description":"The WebRTC URL you provide to the broadcaster, which they stream live video to.","example":"https://customer-m033z5x00ks6nunl.cloudflarestream.com/b236bde30eb07b9d01318940e5fc3edake34a3efb3896e18f2dc277ce6cc993ad/webRTC/publish","readOnly":true,"type":"string"},"install_id":{"description":"app install id.","type":"string"},"instant_logs_job":{"nullable":true,"properties":{"destination_conf":{"$ref":"#/components/schemas/schemas-destination_conf"},"fields":{"$ref":"#/components/schemas/fields"},"filter":{"$ref":"#/components/schemas/filter"},"sample":{"$ref":"#/components/schemas/sample"},"session_id":{"$ref":"#/components/schemas/session_id"}},"type":"object"},"instant_logs_job_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/instant_logs_job"},"type":"array"}}}]},"instant_logs_job_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/instant_logs_job"}}}]},"integration_entry":{"description":"An entry derived from an integration","properties":{"created_at":{"$ref":"#/components/schemas/timestamp"},"enabled":{"description":"Whether the entry is enabled or not.","example":true,"type":"boolean"},"id":{"$ref":"#/components/schemas/entry_id"},"name":{"description":"The name of the entry.","example":"Top Secret","type":"string"},"profile_id":{"description":"ID of the parent profile"},"updated_at":{"$ref":"#/components/schemas/timestamp"}},"title":"Integration entry","type":"object"},"integration_profile":{"properties":{"created_at":{"$ref":"#/components/schemas/timestamp"},"description":{"description":"The description of the profile.","type":"string"},"entries":{"description":"The entries for this profile.","items":{"$ref":"#/components/schemas/integration_entry"},"type":"array"},"id":{"$ref":"#/components/schemas/profile_id"},"name":{"description":"The name of the profile.","example":"MIP Sensitivity Labels: Profile 1","type":"string"},"type":{"description":"The type of the profile.","enum":["integration"],"example":"integration","type":"string"},"updated_at":{"$ref":"#/components/schemas/timestamp"}},"title":"Integration profile","type":"object"},"interconnect":{"properties":{"colo_name":{"$ref":"#/components/schemas/components-schemas-name-MuyCBGYr"},"created_on":{"$ref":"#/components/schemas/schemas-created_on"},"description":{"$ref":"#/components/schemas/interconnect_components-schemas-description"},"gre":{"$ref":"#/components/schemas/gre"},"health_check":{"$ref":"#/components/schemas/schemas-health_check"},"id":{"$ref":"#/components/schemas/schemas-identifier-67y1Mk1I"},"interface_address":{"$ref":"#/components/schemas/interface_address"},"modified_on":{"$ref":"#/components/schemas/schemas-modified_on"},"mtu":{"$ref":"#/components/schemas/schemas-mtu"},"name":{"$ref":"#/components/schemas/components-schemas-name-MuyCBGYr"}},"type":"object"},"interconnect_components-schemas-description":{"description":"An optional description of the interconnect.","example":"Tunnel for Interconnect to ORD","type":"string"},"interface_address":{"description":"A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side of the tunnel. Select the subnet from the following private IP space: 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.","example":"192.0.2.0/31","type":"string"},"interval":{"default":60,"description":"The interval between each health check. Shorter intervals may give quicker notifications if the origin status changes, but will increase load on the origin as we check from multiple locations.","type":"integer"},"interval-FAyugCvL":{"description":"The interval between each posture check with the third party API. Use \"m\" for minutes (e.g. \"5m\") and \"h\" for hours (e.g. \"12h\").","example":"10m","type":"string"},"interval-IFpdxmAf":{"default":60,"description":"The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations.","type":"integer"},"interval-hA6swy38":{"default":60,"description":"The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations.","type":"integer"},"intune_config_request":{"properties":{"client_id":{"description":"The Intune client ID.","example":"example client id","type":"string"},"client_secret":{"description":"The Intune client secret.","example":"example client secret","type":"string"},"customer_id":{"description":"The Intune customer ID.","example":"example customer id","type":"string"}},"required":["customer_id","client_id","client_secret"],"type":"object"},"invite":{"allOf":[{"$ref":"#/components/schemas/organization_invite"}],"type":"object"},"invite_components-schemas-identifier":{"description":"Invite identifier tag.","example":"4f5f0c14a2a41d5063dd301b2f829f04","maxLength":32,"readOnly":true,"type":"string"},"invited_by":{"description":"The email address of the user who created the invite.","example":"user@example.com","maxLength":90,"type":"string"},"invited_member_email":{"description":"Email address of the user to add to the organization.","example":"user@example.com","maxLength":90,"type":"string"},"invited_on":{"description":"When the invite was sent.","example":"2014-01-01T05:20:00Z","format":"date-time","readOnly":true,"type":"string"},"ip":{"description":"IPV6 destination ip assigned to this location. DNS requests sent to this IP will counted as the request under this location. (auto-generated).","example":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","type":"string"},"ip-8QKcCQCp":{"description":"An IPv4 or IPv6 address.","example":"192.0.2.1","type":"string"},"ip-anO5UL8J":{"description":"IPv4/IPv6 address of primary or secondary nameserver, depending on what zone this peer is linked to. For primary zones this IP defines the IP of the secondary nameserver Cloudflare will NOTIFY upon zone changes. For secondary zones this IP defines the IP of the primary nameserver Cloudflare will send AXFR/IXFR requests to.","example":"192.0.2.53","type":"string"},"ip-gs35mKhq":{"description":"An IPv4 or IPv6 address.","example":"192.0.2.1","type":"string"},"ip-ibmclV7b":{"description":"The IP address of the authenticating user.","example":"198.41.129.166","type":"string"},"ip-idMl3BYW":{"description":"IPv4 or IPv6 address.","example":"1.1.1.1","type":"string"},"ip-list":{"properties":{"description":{"type":"string"},"id":{"type":"integer"},"name":{"example":"Malware","type":"string"}}},"ip_address":{"description":"An IPv4 or IPv6 address.","example":"192.0.2.1","type":"string"},"ip_components-schemas-ip":{"properties":{"belongs_to_ref":{"description":"Specifies a reference to the autonomous systems (AS) that the IP address belongs to.","properties":{"country":{"example":"US","type":"string"},"description":{"example":"CLOUDFLARENET","type":"string"},"id":{"example":"autonomous-system--2fa28d71-3549-5a38-af05-770b79ad6ea8"},"type":{"description":"Infrastructure type of this ASN.","enum":["hosting_provider","isp","organization"],"example":"hosting_provider","type":"string"},"value":{"type":"string"}},"type":"object"},"ip":{"$ref":"#/components/schemas/common_components-schemas-ip"},"risk_types":{"example":[{"id":131,"name":"Phishing","super_category_id":21}]}}},"ip_configuration":{"properties":{"target":{"description":"The configuration target. You must set the target to `ip` when specifying an IP address in the rule.","enum":["ip"],"example":"ip"},"value":{"description":"The IP address to match. This address will be compared to the IP address of incoming requests.","example":"198.51.100.4","type":"string"}},"title":"An IP address configuration."},"ip_firewall":{"description":"Enables IP Access Rules for this application.\nNotes: Only available for TCP applications.","example":true,"type":"boolean"},"ip_geolocation":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["ip_geolocation"],"example":"ip_geolocation"},"value":{"$ref":"#/components/schemas/ip_geolocation_value"}}}],"description":"Enable IP Geolocation to have Cloudflare geolocate visitors to your website and pass the country code to you. (https://support.cloudflare.com/hc/en-us/articles/200168236).","title":"IP Geolocation"},"ip_geolocation_value":{"default":"on","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"ip_list_rule":{"description":"Matches an IP address from a list.","properties":{"ip_list":{"properties":{"id":{"description":"The ID of a previously created IP list.","example":"aa0a4aab-672b-4bdb-bc33-a59f1130a11f","type":"string"}},"required":["id"],"type":"object"}},"required":["ip_list"],"title":"IP list","type":"object"},"ip_network":{"description":"The private IPv4 or IPv6 range connected by the route, in CIDR notation.","example":"172.16.0.0/16","type":"string"},"ip_network_encoded":{"description":"IP/CIDR range in URL-encoded format","example":"172.16.0.0%2F16","type":"string"},"ip_range":{"description":"Allowed IPv4/IPv6 address range of primary or secondary nameservers. This will be applied for the entire account. The IP range is used to allow additional NOTIFY IPs for secondary zones and IPs Cloudflare allows AXFR/IXFR requests from for primary zones. CIDRs are limited to a maximum of /24 for IPv4 and /64 for IPv6 respectively.","example":"192.0.2.53/28","type":"string"},"ip_range_search":{"description":"A single IP address range to search for in existing rules.","example":"1.2.3.0/16","type":"string"},"ip_rule":{"description":"Matches an IP address block.","properties":{"ip":{"properties":{"ip":{"description":"An IPv4 or IPv6 CIDR block.","example":"2400:cb00:21:10a::/64","type":"string"}},"required":["ip"],"type":"object"}},"required":["ip"],"title":"IP ranges","type":"object"},"ip_search":{"description":"A single IP address to search for in existing rules.","example":"1.2.3.4","type":"string"},"ipam-delegations":{"properties":{"cidr":{"$ref":"#/components/schemas/cidr"},"created_at":{"$ref":"#/components/schemas/timestamp"},"delegated_account_id":{"$ref":"#/components/schemas/delegated_account_identifier"},"id":{"$ref":"#/components/schemas/delegation_identifier"},"modified_at":{"$ref":"#/components/schemas/timestamp"},"parent_prefix_id":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}},"type":"object"},"ipam-delegations-pbRciqF5":{"properties":{"cidr":{"$ref":"#/components/schemas/cidr"},"created_at":{"$ref":"#/components/schemas/timestamp"},"delegated_account_id":{"$ref":"#/components/schemas/delegated_account_identifier-hmTz3KXe"},"id":{"$ref":"#/components/schemas/delegation_identifier"},"modified_at":{"$ref":"#/components/schemas/timestamp"},"parent_prefix_id":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},"type":"object"},"ipam-delegations_components-schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/delegation_identifier"}},"type":"object"}}}]},"ipam-delegations_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/ipam-delegations-pbRciqF5"},"type":"array"}}}]},"ipam-delegations_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/ipam-delegations-pbRciqF5"}}}]},"ipam-prefixes":{"properties":{"account_id":{"$ref":"#/components/schemas/identifier-v0xEcFCj"},"advertised":{"$ref":"#/components/schemas/advertised"},"advertised_modified_at":{"$ref":"#/components/schemas/modified_at_nullable"},"approved":{"$ref":"#/components/schemas/approved"},"asn":{"$ref":"#/components/schemas/asn"},"cidr":{"$ref":"#/components/schemas/cidr"},"created_at":{"$ref":"#/components/schemas/timestamp"},"description":{"$ref":"#/components/schemas/description-AqNwNwjr"},"id":{"$ref":"#/components/schemas/identifier-v0xEcFCj"},"loa_document_id":{"$ref":"#/components/schemas/loa_document_identifier"},"modified_at":{"$ref":"#/components/schemas/timestamp"},"on_demand_enabled":{"$ref":"#/components/schemas/on_demand_enabled"},"on_demand_locked":{"$ref":"#/components/schemas/on_demand_locked"}},"type":"object"},"ipam-prefixes-HslRkpIE":{"properties":{"account_id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"advertised":{"$ref":"#/components/schemas/advertised"},"advertised_modified_at":{"$ref":"#/components/schemas/modified_at_nullable"},"approved":{"$ref":"#/components/schemas/approved"},"asn":{"$ref":"#/components/schemas/asn-N957CyNV"},"cidr":{"$ref":"#/components/schemas/cidr"},"created_at":{"$ref":"#/components/schemas/timestamp"},"description":{"$ref":"#/components/schemas/ipam-prefixes_components-schemas-description"},"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"loa_document_id":{"$ref":"#/components/schemas/loa_document_identifier-eboVwtvp"},"modified_at":{"$ref":"#/components/schemas/timestamp"},"on_demand_enabled":{"$ref":"#/components/schemas/on_demand_enabled"},"on_demand_locked":{"$ref":"#/components/schemas/on_demand_locked"}},"type":"object"},"ipam-prefixes_components-schemas-description":{"description":"Description of the prefix.","example":"Internal test prefix","maxLength":1000,"type":"string"},"ipam-prefixes_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/ipam-prefixes-HslRkpIE"},"type":"array"}}}]},"ipam-prefixes_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/ipam-prefixes-HslRkpIE"}}}]},"ips":{"description":"A list of CIDRs to restrict ingress connections.","items":{"description":"The IPv4 CIDR or IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /109. IPv4 CIDRs are limited to a maximum of /25.","example":"192.0.2.1/32","type":"string"},"type":"array"},"ips-BbJyXXsk":{"properties":{"etag":{"description":"A digest of the IP data. Useful for determining if the data has changed.","example":"a8e453d9d129a3769407127936edfdb0","type":"string"},"ipv4_cidrs":{"description":"List of Cloudflare IPv4 CIDR addresses.","items":{"description":"IPv4 CIDR.","example":"199.27.128.0/21","type":"string"},"type":"array"},"ipv6_cidrs":{"description":"List of Cloudflare IPv6 CIDR addresses.","items":{"description":"IPv6 CIDR.","example":"2400:cb00::/32","type":"string"},"type":"array"}},"type":"object"},"ips-noQAIDso":{"description":"The set of IPs on the Address Map.","items":{"$ref":"#/components/schemas/address-maps-ip-spXX1kUy"},"type":"array"},"ips_jdcloud":{"properties":{"etag":{"$ref":"#/components/schemas/etag-q3CF2kCS"},"ipv4_cidrs":{"$ref":"#/components/schemas/ipv4_cidrs"},"ipv6_cidrs":{"$ref":"#/components/schemas/ipv6_cidrs"},"jdcloud_cidrs":{"description":"List IPv4 and IPv6 CIDRs, only popoulated if `?networks=jdcloud` is used.","items":{"description":"IPv4 or IPv6 CIDR.","example":"199.27.128.0/21","type":"string"},"type":"array"}},"type":"object"},"ipsec-tunnel":{"properties":{"allow_null_cipher":{"$ref":"#/components/schemas/allow_null_cipher"},"cloudflare_endpoint":{"$ref":"#/components/schemas/cloudflare_ipsec_endpoint"},"created_on":{"$ref":"#/components/schemas/schemas-created_on"},"customer_endpoint":{"$ref":"#/components/schemas/customer_ipsec_endpoint"},"description":{"$ref":"#/components/schemas/components-schemas-description-EJnoLTyB"},"id":{"$ref":"#/components/schemas/schemas-identifier-67y1Mk1I"},"interface_address":{"$ref":"#/components/schemas/interface_address"},"modified_on":{"$ref":"#/components/schemas/schemas-modified_on"},"name":{"$ref":"#/components/schemas/schemas-name-m2fEJLlJ"},"psk_metadata":{"$ref":"#/components/schemas/psk_metadata"},"tunnel_health_check":{"$ref":"#/components/schemas/tunnel_health_check"}},"required":["name","cloudflare_endpoint","interface_address"],"type":"object"},"ipv4":{"example":"192.0.2.0","format":"ipv4","type":"string"},"ipv4_cidrs":{"description":"List of Cloudflare IPv4 CIDR addresses.","items":{"description":"IPv4 CIDR.","example":"199.27.128.0/21","type":"string"},"type":"array"},"ipv6":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["ipv6"],"example":"ipv6"},"value":{"$ref":"#/components/schemas/ipv6_value"}}}],"description":"Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586).","title":"IPv6"},"ipv6-KrBmBy6R":{"example":"2001:0DB8::","format":"ipv6","type":"string"},"ipv6_cidrs":{"description":"List of Cloudflare IPv6 CIDR addresses.","items":{"description":"IPv6 CIDR.","example":"2400:cb00::/32","type":"string"},"type":"array"},"ipv6_configuration":{"properties":{"target":{"description":"The configuration target. You must set the target to `ip6` when specifying an IPv6 address in the rule.","enum":["ip6"],"example":"ip6"},"value":{"description":"The IPv6 address to match.","example":"2001:DB8:100::CF","type":"string"}},"title":"An IPv6 address configuration."},"ipv6_value":{"default":"off","description":"Value of the zone setting.","enum":["off","on"],"type":"string"},"is_default_network":{"description":"If `true`, this virtual network is the default for the account.","example":true,"type":"boolean"},"is_pending_reconnect":{"description":"Cloudflare continues to track connections for several minutes after they disconnect. This is an optimization to improve latency and reliability of reconnecting. If `true`, the connection has disconnected but is still being tracked. If `false`, the connection is actively serving traffic.","example":false,"type":"boolean"},"is_subscribed":{"default":false,"description":"Indicates whether you are currently subscribed to this plan.","example":false,"type":"boolean"},"is_ui_read_only":{"description":"Lock all settings as Read-Only in the Dashboard, regardless of user permission. Updates may only be made via the API or Terraform for this account when enabled.","example":"false","type":"boolean"},"issued_on":{"description":"Date that the Client Certificate was issued by the Certificate Authority","example":"2023-02-23T23:18:00Z","readOnly":true,"type":"string"},"issued_on-ckMiaqK5":{"description":"The time on which the token was created.","example":"2018-07-01T05:20:00Z","format":"date-time","readOnly":true,"type":"string"},"issuer":{"description":"The certificate authority that issued the certificate.","example":"GlobalSign","readOnly":true,"type":"string"},"item":{"example":{"comment":"Private IP address","created_on":"2020-01-01T08:00:00Z","id":"2c0fc9fa937b11eaa1b71c4d701ab86e","ip":"10.0.0.1","modified_on":"2020-01-10T14:00:00Z"},"oneOf":[{"required":["ip"]},{"required":["redirect"]},{"required":["hostname"]}],"properties":{"comment":{"$ref":"#/components/schemas/item_comment"},"created_on":{"description":"The RFC 3339 timestamp of when the item was created.","example":"2020-01-01T08:00:00Z","readOnly":true,"type":"string"},"hostname":{"$ref":"#/components/schemas/item_hostname"},"id":{"$ref":"#/components/schemas/list_id"},"ip":{"$ref":"#/components/schemas/item_ip"},"modified_on":{"description":"The RFC 3339 timestamp of when the item was last modified.","example":"2020-01-10T14:00:00Z","readOnly":true,"type":"string"},"redirect":{"$ref":"#/components/schemas/item_redirect"}},"type":"object"},"item-response-collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/item"}},"type":"object"}]},"item_comment":{"description":"An informative summary of the list item.","example":"Private IP address","type":"string"},"item_hostname":{"description":"Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-).","properties":{"url_hostname":{"example":"example.com","type":"string"}},"required":["url_hostname"],"type":"string"},"item_id":{"description":"The unique ID of the item in the List.","example":"34b12448945f11eaa1b71c4d701ab86e","type":"string"},"item_ip":{"description":"An IPv4 address, an IPv4 CIDR, or an IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /64.","example":"10.0.0.1","type":"string"},"item_redirect":{"description":"The definition of the redirect.","properties":{"include_subdomains":{"default":false,"type":"boolean"},"preserve_path_suffix":{"default":true,"type":"boolean"},"preserve_query_string":{"default":false,"type":"boolean"},"source_url":{"example":"example.com/arch","type":"string"},"status_code":{"default":301,"enum":[301,302,307,308],"type":"integer"},"subpath_matching":{"default":false,"type":"boolean"},"target_url":{"example":"https://archlinux.org/","type":"string"}},"required":["source_url","target_url"],"type":"object"},"items":{"description":"The items in the List.","items":{"properties":{"created_at":{"$ref":"#/components/schemas/timestamp"},"value":{"$ref":"#/components/schemas/value"}},"type":"object"},"type":"array"},"items-ExjoSuj9":{"items":{"$ref":"#/components/schemas/item"},"type":"array"},"items-list-response-collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/items-ExjoSuj9"},"result_info":{"properties":{"cursors":{"properties":{"after":{"example":"yyy","type":"string"},"before":{"example":"xxx","type":"string"}},"type":"object"}},"type":"object"}},"type":"object"}]},"items-update-request-collection":{"items":{"allOf":[{"oneOf":[{"required":["ip"]},{"required":["redirect"]},{"required":["hostname"]}],"properties":{"comment":{"$ref":"#/components/schemas/item_comment"},"ip":{"$ref":"#/components/schemas/item_ip"},"redirect":{"$ref":"#/components/schemas/item_redirect"}},"type":"object"}]},"type":"array"},"ixfr_enable":{"description":"Enable IXFR transfer protocol, default is AXFR. Only applicable to secondary zones.","example":false,"type":"boolean"},"js_integrity_score":{"description":"The integrity score of the JavaScript content.","maximum":99,"minimum":1,"nullable":true,"type":"integer"},"json_response_enabled":{"default":false,"description":"Only available for the Waiting Room Advanced subscription. If `true`, requests to the waiting room with the header `Accept: application/json` will receive a JSON response object with information on the user's status in the waiting room as opposed to the configured static HTML page. This JSON response object has one property `cfWaitingRoom` which is an object containing the following fields:\n1. `inWaitingRoom`: Boolean indicating if the user is in the waiting room (always **true**).\n2. `waitTimeKnown`: Boolean indicating if the current estimated wait times are accurate. If **false**, they are not available.\n3. `waitTime`: Valid only when `waitTimeKnown` is **true**. Integer indicating the current estimated time in minutes the user will wait in the waiting room. When `queueingMethod` is **random**, this is set to `waitTime50Percentile`.\n4. `waitTime25Percentile`: Valid only when `queueingMethod` is **random** and `waitTimeKnown` is **true**. Integer indicating the current estimated maximum wait time for the 25% of users that gain entry the fastest (25th percentile).\n5. `waitTime50Percentile`: Valid only when `queueingMethod` is **random** and `waitTimeKnown` is **true**. Integer indicating the current estimated maximum wait time for the 50% of users that gain entry the fastest (50th percentile). In other words, half of the queued users are expected to let into the origin website before `waitTime50Percentile` and half are expected to be let in after it.\n6. `waitTime75Percentile`: Valid only when `queueingMethod` is **random** and `waitTimeKnown` is **true**. Integer indicating the current estimated maximum wait time for the 75% of users that gain entry the fastest (75th percentile).\n7. `waitTimeFormatted`: String displaying the `waitTime` formatted in English for users. If `waitTimeKnown` is **false**, `waitTimeFormatted` will display **unavailable**.\n8. `queueIsFull`: Boolean indicating if the waiting room's queue is currently full and not accepting new users at the moment.\n9. `queueAll`: Boolean indicating if all users will be queued in the waiting room and no one will be let into the origin website.\n10. `lastUpdated`: String displaying the timestamp as an ISO 8601 string of the user's last attempt to leave the waiting room and be let into the origin website. The user is able to make another attempt after `refreshIntervalSeconds` past this time. If the user makes a request too soon, it will be ignored and `lastUpdated` will not change.\n11. `refreshIntervalSeconds`: Integer indicating the number of seconds after `lastUpdated` until the user is able to make another attempt to leave the waiting room and be let into the origin website. When the `queueingMethod` is `reject`, there is no specified refresh time — it will always be **zero**.\n12. `queueingMethod`: The queueing method currently used by the waiting room. It is either **fifo**, **random**, **passthrough**, or **reject**.\n13. `isFIFOQueue`: Boolean indicating if the waiting room uses a FIFO (First-In-First-Out) queue.\n14. `isRandomQueue`: Boolean indicating if the waiting room uses a Random queue where users gain access randomly.\n15. `isPassthroughQueue`: Boolean indicating if the waiting room uses a passthrough queue. Keep in mind that when passthrough is enabled, this JSON response will only exist when `queueAll` is **true** or `isEventPrequeueing` is **true** because in all other cases requests will go directly to the origin.\n16. `isRejectQueue`: Boolean indicating if the waiting room uses a reject queue.\n17. `isEventActive`: Boolean indicating if an event is currently occurring. Events are able to change a waiting room's behavior during a specified period of time. For additional information, look at the event properties `prequeue_start_time`, `event_start_time`, and `event_end_time` in the documentation for creating waiting room events. Events are considered active between these start and end times, as well as during the prequeueing period if it exists.\n18. `isEventPrequeueing`: Valid only when `isEventActive` is **true**. Boolean indicating if an event is currently prequeueing users before it starts.\n19. `timeUntilEventStart`: Valid only when `isEventPrequeueing` is **true**. Integer indicating the number of minutes until the event starts.\n20. `timeUntilEventStartFormatted`: String displaying the `timeUntilEventStart` formatted in English for users. If `isEventPrequeueing` is **false**, `timeUntilEventStartFormatted` will display **unavailable**.\n21. `timeUntilEventEnd`: Valid only when `isEventActive` is **true**. Integer indicating the number of minutes until the event ends.\n22. `timeUntilEventEndFormatted`: String displaying the `timeUntilEventEnd` formatted in English for users. If `isEventActive` is **false**, `timeUntilEventEndFormatted` will display **unavailable**.\n23. `shuffleAtEventStart`: Valid only when `isEventActive` is **true**. Boolean indicating if the users in the prequeue are shuffled randomly when the event starts.\n\nAn example cURL to a waiting room could be:\n\n\tcurl -X GET \"https://example.com/waitingroom\" \\\n\t\t-H \"Accept: application/json\"\n\nIf `json_response_enabled` is **true** and the request hits the waiting room, an example JSON response when `queueingMethod` is **fifo** and no event is active could be:\n\n\t{\n\t\t\"cfWaitingRoom\": {\n\t\t\t\"inWaitingRoom\": true,\n\t\t\t\"waitTimeKnown\": true,\n\t\t\t\"waitTime\": 10,\n\t\t\t\"waitTime25Percentile\": 0,\n\t\t\t\"waitTime50Percentile\": 0,\n\t\t\t\"waitTime75Percentile\": 0,\n\t\t\t\"waitTimeFormatted\": \"10 minutes\",\n\t\t\t\"queueIsFull\": false,\n\t\t\t\"queueAll\": false,\n\t\t\t\"lastUpdated\": \"2020-08-03T23:46:00.000Z\",\n\t\t\t\"refreshIntervalSeconds\": 20,\n\t\t\t\"queueingMethod\": \"fifo\",\n\t\t\t\"isFIFOQueue\": true,\n\t\t\t\"isRandomQueue\": false,\n\t\t\t\"isPassthroughQueue\": false,\n\t\t\t\"isRejectQueue\": false,\n\t\t\t\"isEventActive\": false,\n\t\t\t\"isEventPrequeueing\": false,\n\t\t\t\"timeUntilEventStart\": 0,\n\t\t\t\"timeUntilEventStartFormatted\": \"unavailable\",\n\t\t\t\"timeUntilEventEnd\": 0,\n\t\t\t\"timeUntilEventEndFormatted\": \"unavailable\",\n\t\t\t\"shuffleAtEventStart\": false\n\t\t}\n\t}\n\nIf `json_response_enabled` is **true** and the request hits the waiting room, an example JSON response when `queueingMethod` is **random** and an event is active could be:\n\n\t{\n\t\t\"cfWaitingRoom\": {\n\t\t\t\"inWaitingRoom\": true,\n\t\t\t\"waitTimeKnown\": true,\n\t\t\t\"waitTime\": 10,\n\t\t\t\"waitTime25Percentile\": 5,\n\t\t\t\"waitTime50Percentile\": 10,\n\t\t\t\"waitTime75Percentile\": 15,\n\t\t\t\"waitTimeFormatted\": \"5 minutes to 15 minutes\",\n\t\t\t\"queueIsFull\": false,\n\t\t\t\"queueAll\": false,\n\t\t\t\"lastUpdated\": \"2020-08-03T23:46:00.000Z\",\n\t\t\t\"refreshIntervalSeconds\": 20,\n\t\t\t\"queueingMethod\": \"random\",\n\t\t\t\"isFIFOQueue\": false,\n\t\t\t\"isRandomQueue\": true,\n\t\t\t\"isPassthroughQueue\": false,\n\t\t\t\"isRejectQueue\": false,\n\t\t\t\"isEventActive\": true,\n\t\t\t\"isEventPrequeueing\": false,\n\t\t\t\"timeUntilEventStart\": 0,\n\t\t\t\"timeUntilEventStartFormatted\": \"unavailable\",\n\t\t\t\"timeUntilEventEnd\": 15,\n\t\t\t\"timeUntilEventEndFormatted\": \"15 minutes\",\n\t\t\t\"shuffleAtEventStart\": true\n\t\t}\n\t}.","example":false,"type":"boolean"},"jwk":{"description":"The signing key in JWK format.","example":"eyJ1c2UiOiJzaWciLCJrdHkiOiJSU0EiLCJraWQiOiI1MjEzY2ZhMTIxZjcwYjhjMTM4MDY4NmZmYzM3MWJhMyIsImFsZyI6IlJTMjU2IiwibiI6IjBUandqT2laV21KNDN2ZjNUbzREb1htWFd0SkdOR3lYZmh5dHRMYUJnRjEtRVFXUURLaG9LYm9hS21xakNBc21za3V0YkxVN1BVOGRrUU5ER1p3S3VWczA4elNaNGt4aTR0RWdQUFp5dDdkWEMtbFlSWW95ckFHRjRBWGh5MzI5YkhDUDFJbHJCQl9Ba0dnbmRMQWd1bnhZMHJSZ2N2T3ppYXc2S0p4Rm5jMlVLMFdVOGIwcDRLS0hHcDFLTDlkazBXVDhkVllxYmVSaUpqQ2xVRW1oOHl2OUNsT1ZhUzRLeGlYNnhUUTREWnc2RGFKZklWM1F0Tmd2cG1ieWxOSmFQSG5zc3JodDJHS1A5NjJlS2poUVJsaWd2SFhKTE9uSm9KZkxlSUVIWi1peFdmY1RETUg5MnNHdm93MURPanhMaUNOMXpISy1oN2JMb1hUaUxnYzRrdyIsImUiOiJBUUFCIiwiZCI6IndpQWEwaU5mWnNYSGNOcVMxSWhnUmdzVHJHay1TcFlYV2lReDZHTU9kWlJKekhGazN0bkRERFJvNHNKZTBxX0dEOWkzNlEyZkVadS15elpEcEJkc3U5OHNtaHhNU19Ta0s5X3VFYUo1Zm96V2IyN3JRRnFoLVliUU9MUThkUnNPRHZmQl9Hb2txWWJzblJDR3kzWkFaOGZJZ25ocXBUNEpiOHdsaWxpMUgxeFpzM3RnTWtkTEluTm1yMFAtcTYxZEtNd3JYZVRoSWNEc0kyb2Z1LTFtRm1MWndQb2ZGbmxaTW9QN1pfRU5pUGNfWGtWNzFhaHBOZE9pcW5ablZtMHBCNE5QS1UweDRWTjQyYlAzWEhMUmpkV2hJOGt3SC1BdXhqb3BLaHJ0R2tvcG1jZFRkM1ZRdElaOGRpZHByMXpBaEpvQi16ZVlIaTFUel9ZSFFld0FRUSIsInAiOiIyVTZFVUJka3U3TndDYXoyNzZuWGMxRXgwVHpNZjU4U0UtU2M2eUNaYWk2TkwzVURpWi1mNHlIdkRLYnFGUXdLWDNwZ0l2aVE3Y05QYUpkbE9NeS1mU21GTXU3V3hlbVZYamFlTjJCMkRDazhQY0NEOVgxU2hhR3E1ZUdSSHNObVUtSDNxTG1FRGpjLWliazRHZ0RNb2lVYjQ2OGxFZHAwU2pIOXdsOUdsYTgiLCJxIjoiOW5ucXg5ZnNNY2dIZ29DemhfVjJmaDhoRUxUSUM5aFlIOVBCTG9aQjZIaE1TWG1ja1BSazVnUlpPWlFEN002TzlMaWZjNmFDVXdEbjBlQzU2YkFDNUNrcWxjODJsVDhzTWlMeWJyTjh3bWotcjNjSTBGQTlfSGQySEY1ZkgycnJmenVqd0NWM3czb09Ud3p4d1g3c2xKbklRanphel91SzEyWEtucVZZcUYwIiwiZHAiOiJxQklTUTlfVUNWaV9Ucng0UU9VYnZoVU9jc2FUWkNHajJiNzNudU9YeElnOHFuZldSSnN4RG5zd2FKaXdjNWJjYnZ3M1h0VGhRd1BNWnhpeE1UMHFGNlFGWVY5WXZibnJ6UEp4YkdNdTZqajZYc2lIUjFlbWU3U09lVDM4Xzg0aFZyOXV6UkN2RWstb0R0MHlodW9YVzFGWVFNRTE2cGtMV0ZkUjdRUERsQUUiLCJkcSI6Im5zQUp3eXZFbW8tdW5wU01qYjVBMHB6MExCRjBZNFMxeGRJYXNfLVBSYzd0dThsVFdWMl8teExEOFR6dmhqX0lmY0RJR3JJZGNKNjlzVVZnR1M3ZnZkcng3Y21uNjFyai1XcmU0UVJFRC1lV1dxZDlpc2FVRmg5UGVKZ2tCbFZVVnYtdnladVlWdFF2a1NUU05ZR3RtVXl2V2xKZDBPWEFHRm9jdGlfak9aVSIsInFpIjoib0dYaWxLQ2NKRXNFdEE1eG54WUdGQW5UUjNwdkZLUXR5S0F0UGhHaHkybm5ya2VzN1RRaEFxMGhLRWZtU1RzaE1hNFhfd05aMEstX1F0dkdoNDhpeHdTTDVLTEwxZnFsY0k2TF9XUnF0cFQxS21LRERlUHR2bDVCUzFGbjgwSGFwR215cmZRWUU4S09QR2UwUl82S1BOZE1vc3dYQ3Nfd0RYMF92ZzNoNUxRIn0=","readOnly":true,"type":"string"},"key":{"description":"A name for a value. A value stored under a given key may be retrieved via the same key.","properties":{"expiration":{"description":"The time, measured in number of seconds since the UNIX epoch, at which the key will expire. This property is omitted for keys that will not expire.","example":1577836800,"type":"number"},"metadata":{"$ref":"#/components/schemas/list_metadata"},"name":{"$ref":"#/components/schemas/key_name"}},"required":["name"],"type":"object"},"key-sOXCdDRQ":{"description":"The device's public key.","example":"yek0SUYoOQ10vMGsIYAevozXUQpQtNFJFfFGqER/BGc=","type":"string"},"key_config":{"properties":{"days_until_next_rotation":{"$ref":"#/components/schemas/days_until_next_rotation"},"key_rotation_interval_days":{"$ref":"#/components/schemas/key_rotation_interval_days"},"last_key_rotation_at":{"$ref":"#/components/schemas/last_key_rotation_at"}},"type":"object"},"key_generation_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/keys-iPBE1L5T"}}}]},"key_name":{"description":"A key's name. The name may be at most 512 bytes. All printable, non-whitespace characters are valid. Use percent-encoding to define key names as part of a URL.","example":"My-Key","maxLength":512,"type":"string"},"key_name_bulk":{"description":"A key's name. The name may be at most 512 bytes. All printable, non-whitespace characters are valid.","example":"My-Key","maxLength":512,"type":"string"},"key_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/keys_response"}}}]},"key_response_collection-FpLR6Wht":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"properties":{"created":{"$ref":"#/components/schemas/signing_key_created"},"id":{"$ref":"#/components/schemas/schemas-identifier"}},"type":"object"},"type":"array"}}}]},"key_rotation_interval_days":{"description":"The number of days between key rotations.","example":30,"maximum":365,"minimum":21,"type":"number"},"key_tag":{"description":"Code for key tag.","example":42,"nullable":true,"readOnly":true,"type":"number"},"key_type":{"description":"Algorithm key type.","example":"ECDSAP256SHA256","nullable":true,"readOnly":true,"type":"string"},"keyless-certificate":{"allOf":[{"$ref":"#/components/schemas/base-cc0u02EK"}],"type":"object"},"keyless-certificate-1A90AEZs":{"allOf":[{"$ref":"#/components/schemas/components-schemas-base"}],"type":"object"},"keyless-certificate_components-schemas-identifier":{"description":"Keyless certificate identifier tag.","example":"4d2844d2ce78891c34d0b6c0535a291e","maxLength":32,"readOnly":true,"type":"string"},"keyless-certificate_components-schemas-name":{"description":"The keyless SSL name.","example":"example.com Keyless SSL","maxLength":180,"readOnly":true,"type":"string"},"keyless-certificate_components-schemas-status":{"description":"Status of the Keyless SSL.","enum":["active","deleted"],"example":"active","readOnly":true,"type":"string"},"keyless_private_ip":{"description":"Private IP of the Key Server Host","example":"10.0.0.1","type":"string"},"keyless_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/keyless-certificate-1A90AEZs"},"type":"array"}}}]},"keyless_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/base-cc0u02EK"}],"type":"object"}}}]},"keyless_response_single-D6V6oKzw":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"keyless_response_single_id":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/identifier-tZwYoMuc"}},"type":"object"}}}]},"keyless_response_single_id-oOZ29VcY":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/keyless-certificate_components-schemas-identifier"}},"type":"object"}}}]},"keyless_tunnel":{"description":"Configuration for using Keyless SSL through a Cloudflare Tunnel","properties":{"private_ip":{"$ref":"#/components/schemas/keyless_private_ip"},"vnet_id":{"$ref":"#/components/schemas/keyless_vnet_id"}},"required":["private_ip","vnet_id"],"type":"object"},"keyless_vnet_id":{"description":"Cloudflare Tunnel Virtual Network ID","example":"7365377a-85a4-4390-9480-531ef7dc7a3c","type":"string"},"keys":{"properties":{"name":{"$ref":"#/components/schemas/keys_components-schemas-name"},"value":{"$ref":"#/components/schemas/keys_components-schemas-value"}},"type":"object"},"keys-iPBE1L5T":{"properties":{"created":{"$ref":"#/components/schemas/signing_key_created"},"id":{"$ref":"#/components/schemas/schemas-identifier"},"jwk":{"$ref":"#/components/schemas/jwk"},"pem":{"$ref":"#/components/schemas/pem"}},"type":"object"},"keys_components-schemas-name":{"description":"Key name.","example":"default","readOnly":true,"type":"string"},"keys_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/key_config"}]},"keys_components-schemas-value":{"description":"Key value.","example":"Oix0bbNaT8Rge9PuyxUBrjI6zrgnsyJ5=","readOnly":true,"type":"string"},"keys_response":{"properties":{"keys":{"items":{"$ref":"#/components/schemas/keys"},"type":"array"}},"type":"object"},"kind":{"description":"The type of the membership.","enum":["zone","account"],"example":"zone","type":"string"},"kind-ZDHCkJmG":{"description":"The type of the list. Each type supports specific list items (IP addresses, hostnames or redirects).","enum":["ip","redirect","hostname"],"example":"ip","type":"string"},"kolide_config_request":{"properties":{"client_id":{"description":"The Kolide client ID.","example":"example client id","type":"string"},"client_secret":{"description":"The Kolide client secret.","example":"example client secret","type":"string"}},"required":["client_id","client_secret"],"type":"object"},"kv_components-schemas-value":{"description":"A byte sequence to be stored, up to 10 MB in length.","example":"Some Value","type":"string"},"kv_namespace_binding":{"properties":{"name":{"$ref":"#/components/schemas/binding_name"},"namespace_id":{"$ref":"#/components/schemas/namespace_identifier"},"type":{"description":"The class of resource that the binding provides.","enum":["kv_namespace"],"example":"kv_namespace","type":"string"}},"required":["name","type","namespace_id"],"type":"object"},"label":{"description":"The language label displayed in the native language to users.","example":"Türkçe","readOnly":true,"type":"string"},"labels":{"description":"Field appears if there is an additional annotation printed when the probe returns. Field also appears when running a GRE+ICMP traceroute to denote which traceroute a node comes from.","items":{"type":"string"},"type":"array"},"language":{"description":"The language tag in BCP 47 format.","example":"tr","readOnly":true,"type":"string"},"language_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/captions"},"type":"array"}}}]},"language_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"last_complete":{"description":"Records the last time for which logs have been successfully pushed. If the last successful push was for logs range 2018-07-23T10:00:00Z to 2018-07-23T10:01:00Z then the value of this field will be 2018-07-23T10:01:00Z. If the job has never run or has just been enabled and hasn't run yet then the field will be empty.","format":"date-time","nullable":true,"type":"string"},"last_error":{"description":"Records the last time the job failed. If not null, the job is currently failing. If null, the job has either never failed or has run successfully at least once since last failure. See also the error_message field.","format":"date-time","nullable":true,"type":"string"},"last_failure":{"description":"Timestamp of the last time an attempt to dispatch a notification to this webhook failed.","example":"2020-10-26T18:25:04.532316Z","format":"date-time","readOnly":true,"type":"string"},"last_key_rotation_at":{"description":"The timestamp of the previous key rotation.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","type":"string"},"last_name":{"description":"User's last name","example":"Appleseed","maxLength":60,"nullable":true,"type":"string"},"last_seen":{"description":"When the device last connected to Cloudflare services.","example":"2017-06-14T00:00:00Z","format":"date-time","type":"string"},"last_success":{"description":"Timestamp of the last time Cloudflare was able to successfully dispatch a notification using this webhook.","example":"2020-10-26T18:25:04.532316Z","format":"date-time","readOnly":true,"type":"string"},"last_successful_login":{"description":"The time at which the user last successfully logged in.","example":"2020-07-01T05:20:00Z","format":"date-time","type":"string"},"last_updated":{"description":"The timestamp of when the ruleset was last modified.","example":"2000-01-01T00:00:00.000000Z","type":"string"},"latitude":{"description":"The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set.","type":"number"},"legacy_discount":{"default":false,"description":"Indicates whether this plan has a legacy discount applied.","example":false,"type":"boolean"},"legacy_id":{"description":"The legacy identifier for this rate plan, if any.","example":"free","readOnly":true,"type":"string"},"limit":{"default":100000,"description":"Limit number of returned metrics.","example":100,"type":"integer"},"linkedin":{"allOf":[{"$ref":"#/components/schemas/identity-provider"},{"properties":{"config":{"$ref":"#/components/schemas/generic-oauth-config"}},"type":"object"}],"title":"LinkedIn","type":"object"},"list":{"properties":{"created_on":{"$ref":"#/components/schemas/schemas-created_on-KZj9IpMd"},"description":{"$ref":"#/components/schemas/lists_components-schemas-description"},"id":{"$ref":"#/components/schemas/list_id"},"kind":{"$ref":"#/components/schemas/kind-ZDHCkJmG"},"modified_on":{"$ref":"#/components/schemas/lists_components-schemas-modified_on"},"name":{"$ref":"#/components/schemas/lists_components-schemas-name"},"num_items":{"$ref":"#/components/schemas/num_items"},"num_referencing_filters":{"$ref":"#/components/schemas/num_referencing_filters"}}},"list-delete-response-collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/item_id"}},"type":"object"}},"type":"object"}]},"list-response-collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/list"}},"type":"object"}]},"list-zone-connections-response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/connection"},"type":"array"},"result_info":{"$ref":"#/components/schemas/result_info"}},"type":"object"}]},"list-zone-scripts-response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/script"},"type":"array"},"result_info":{"$ref":"#/components/schemas/result_info"}},"type":"object"}]},"list_id":{"description":"The unique ID of the list.","example":"2c0fc9fa937b11eaa1b71c4d701ab86e","maxLength":32,"minLength":32,"readOnly":true,"type":"string"},"list_item_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/items"},"type":"array"}}},{"properties":{"result_info":{"properties":{"count":{"description":"Total results returned based on your search parameters.","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results.","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters.","example":2000,"type":"number"}},"type":"object"}}}]},"list_metadata":{"description":"Arbitrary JSON that is associated with a key.","example":{"someMetadataKey":"someMetadataValue"},"type":"object"},"lists":{"properties":{"count":{"$ref":"#/components/schemas/count"},"created_at":{"$ref":"#/components/schemas/timestamp"},"description":{"$ref":"#/components/schemas/description"},"id":{"$ref":"#/components/schemas/uuid"},"name":{"$ref":"#/components/schemas/name"},"type":{"$ref":"#/components/schemas/type"},"updated_at":{"$ref":"#/components/schemas/timestamp"}},"type":"object"},"lists-async-response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"properties":{"operation_id":{"$ref":"#/components/schemas/operation_id"}},"type":"object"}},"type":"object"}]},"lists-response-collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"allOf":[{"$ref":"#/components/schemas/list"},{"required":["id","name","kind","num_items","created_on","modified_on"],"type":"object"}]},"type":"array"}},"type":"object"}]},"lists_components-schemas-description":{"description":"An informative summary of the list.","example":"This is a note.","maxLength":500,"type":"string"},"lists_components-schemas-modified_on":{"description":"The RFC 3339 timestamp of when the list was last modified.","example":"2020-01-10T14:00:00Z","type":"string"},"lists_components-schemas-name":{"description":"An informative name for the list. Use this name in filter and rule expressions.","example":"list1","maxLength":50,"pattern":"^[a-zA-Z0-9_]+$","type":"string"},"liveInput":{"description":"The live input ID used to upload a video with Stream Live.","example":"fc0a8dc887b16759bfd9ad922230a014","maxLength":32,"readOnly":true,"type":"string"},"live_input":{"description":"Details about a live input.","properties":{"created":{"$ref":"#/components/schemas/live_input_created"},"meta":{"$ref":"#/components/schemas/live_input_metadata"},"modified":{"$ref":"#/components/schemas/live_input_modified"},"recording":{"$ref":"#/components/schemas/live_input_recording_settings"},"rtmps":{"$ref":"#/components/schemas/input_rtmps"},"rtmpsPlayback":{"$ref":"#/components/schemas/playback_rtmps"},"srt":{"$ref":"#/components/schemas/input_srt"},"srtPlayback":{"$ref":"#/components/schemas/playback_srt"},"status":{"$ref":"#/components/schemas/live_input_status"},"uid":{"$ref":"#/components/schemas/live_input_identifier"},"webRTC":{"$ref":"#/components/schemas/input_webrtc"},"webRTCPlayback":{"$ref":"#/components/schemas/playback_webrtc"}},"type":"object"},"live_input_created":{"description":"The date and time the live input was created.","example":"2014-01-02T02:20:00Z","format":"date-time","readOnly":true,"type":"string"},"live_input_default_creator":{"description":"Sets the creator ID asssociated with this live input.","type":"string"},"live_input_identifier":{"description":"A unique identifier for a live input.","example":"66be4bf738797e01e1fca35a7bdecdcd","maxLength":32,"readOnly":true,"type":"string"},"live_input_metadata":{"description":"A user modifiable key-value store used to reference other systems of record for managing live inputs.","example":{"name":"test stream 1"},"type":"object"},"live_input_modified":{"description":"The date and time the live input was last modified.","example":"2014-01-02T02:20:00Z","format":"date-time","readOnly":true,"type":"string"},"live_input_object_without_url":{"properties":{"created":{"$ref":"#/components/schemas/live_input_created"},"meta":{"$ref":"#/components/schemas/live_input_metadata"},"modified":{"$ref":"#/components/schemas/live_input_modified"},"uid":{"$ref":"#/components/schemas/live_input_identifier"}}},"live_input_recording_allowedOrigins":{"description":"Lists the origins allowed to display videos created with this input. Enter allowed origin domains in an array and use `*` for wildcard subdomains. An empty array allows videos to be viewed on any origin.","example":["example.com"],"items":{"type":"string"},"type":"array"},"live_input_recording_mode":{"default":"off","description":"Specifies the recording behavior for the live input. Set this value to `off` to prevent a recording. Set the value to `automatic` to begin a recording and transition to on-demand after Stream Live stops receiving input.","enum":["off","automatic"],"example":"automatic","type":"string"},"live_input_recording_requireSignedURLs":{"default":false,"description":"Indicates if a video using the live input has the `requireSignedURLs` property set. Also enforces access controls on any video recording of the livestream with the live input.","example":true,"type":"boolean"},"live_input_recording_settings":{"description":"Records the input to a Cloudflare Stream video. Behavior depends on the mode. In most cases, the video will initially be viewable as a live video and transition to on-demand after a condition is satisfied.","example":{"mode":"off","requireSignedURLs":false,"timeoutSeconds":0},"properties":{"allowedOrigins":{"$ref":"#/components/schemas/live_input_recording_allowedOrigins"},"mode":{"$ref":"#/components/schemas/live_input_recording_mode"},"requireSignedURLs":{"$ref":"#/components/schemas/live_input_recording_requireSignedURLs"},"timeoutSeconds":{"$ref":"#/components/schemas/live_input_recording_timeoutSeconds"}},"type":"object"},"live_input_recording_timeoutSeconds":{"default":0,"description":"Determines the amount of time a live input configured in `automatic` mode should wait before a recording transitions from live to on-demand. `0` is recommended for most use cases and indicates the platform default should be used.","type":"integer"},"live_input_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"properties":{"liveInputs":{"items":{"$ref":"#/components/schemas/live_input_object_without_url"},"type":"array"},"range":{"description":"The total number of remaining live inputs based on cursor position.","example":1000,"readOnly":true,"type":"integer"},"total":{"description":"The total number of live inputs that match the provided filters.","example":35586,"readOnly":true,"type":"integer"}},"type":"object"}}}]},"live_input_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/live_input"}}}]},"live_input_status":{"description":"The connection status of a live input.","enum":[null,"connected","reconnected","reconnecting","client_disconnect","ttl_exceeded","failed_to_connect","failed_to_reconnect","new_configuration_accepted"],"nullable":true,"readOnly":true,"type":"string"},"loa_document_identifier":{"description":"Identifier for the uploaded LOA document.","example":"d933b1530bc56c9953cf8ce166da8004","maxLength":32,"nullable":true,"type":"string"},"loa_document_identifier-eboVwtvp":{"description":"Identifier for the uploaded LOA document.","example":"d933b1530bc56c9953cf8ce166da8004","maxLength":32,"nullable":true,"readOnly":true,"type":"string"},"loa_upload_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"filename":{"description":"Name of LOA document.","example":"document.pdf","type":"string"}},"type":"object"}}}]},"load-balancer":{"properties":{"adaptive_routing":{"$ref":"#/components/schemas/adaptive_routing"},"country_pools":{"$ref":"#/components/schemas/country_pools"},"created_on":{"$ref":"#/components/schemas/timestamp"},"default_pools":{"$ref":"#/components/schemas/default_pools"},"description":{"$ref":"#/components/schemas/load-balancer_components-schemas-description"},"enabled":{"$ref":"#/components/schemas/load-balancer_components-schemas-enabled"},"fallback_pool":{"$ref":"#/components/schemas/fallback_pool"},"id":{"$ref":"#/components/schemas/load-balancer_components-schemas-identifier"},"location_strategy":{"$ref":"#/components/schemas/location_strategy"},"modified_on":{"$ref":"#/components/schemas/timestamp"},"name":{"$ref":"#/components/schemas/load-balancer_components-schemas-name"},"pop_pools":{"$ref":"#/components/schemas/pop_pools"},"proxied":{"$ref":"#/components/schemas/proxied-ZJJb2RTk"},"random_steering":{"$ref":"#/components/schemas/random_steering"},"region_pools":{"$ref":"#/components/schemas/region_pools"},"rules":{"$ref":"#/components/schemas/components-schemas-rules"},"session_affinity":{"$ref":"#/components/schemas/session_affinity"},"session_affinity_attributes":{"$ref":"#/components/schemas/session_affinity_attributes"},"session_affinity_ttl":{"$ref":"#/components/schemas/session_affinity_ttl"},"steering_policy":{"$ref":"#/components/schemas/steering_policy"},"ttl":{"$ref":"#/components/schemas/ttl-vFKh1wOV"}},"type":"object"},"load-balancer-ZLoHsRks":{"properties":{"adaptive_routing":{"$ref":"#/components/schemas/adaptive_routing"},"country_pools":{"$ref":"#/components/schemas/country_pools"},"created_on":{"$ref":"#/components/schemas/timestamp"},"default_pools":{"$ref":"#/components/schemas/default_pools"},"description":{"$ref":"#/components/schemas/components-schemas-description-UH5FN4sh"},"enabled":{"$ref":"#/components/schemas/components-schemas-enabled-tktxdyPy"},"fallback_pool":{"$ref":"#/components/schemas/fallback_pool"},"id":{"$ref":"#/components/schemas/load-balancer_components-schemas-identifier"},"location_strategy":{"$ref":"#/components/schemas/location_strategy"},"modified_on":{"$ref":"#/components/schemas/timestamp"},"name":{"$ref":"#/components/schemas/components-schemas-name-h5gI0ndx"},"pop_pools":{"$ref":"#/components/schemas/pop_pools"},"proxied":{"$ref":"#/components/schemas/proxied-ZGed5Tdg"},"random_steering":{"$ref":"#/components/schemas/random_steering"},"region_pools":{"$ref":"#/components/schemas/region_pools"},"rules":{"$ref":"#/components/schemas/rules-8L4eu614"},"session_affinity":{"$ref":"#/components/schemas/session_affinity"},"session_affinity_attributes":{"$ref":"#/components/schemas/session_affinity_attributes"},"session_affinity_ttl":{"$ref":"#/components/schemas/session_affinity_ttl"},"steering_policy":{"$ref":"#/components/schemas/steering_policy"},"ttl":{"$ref":"#/components/schemas/ttl-0jCBhfJ2"}},"type":"object"},"load-balancer_components-schemas-description":{"description":"Object description.","example":"Load Balancer for www.example.com","type":"string"},"load-balancer_components-schemas-enabled":{"default":true,"description":"Whether to enable (the default) this load balancer.","example":true,"type":"boolean"},"load-balancer_components-schemas-identifier":{"example":"699d98642c564d2e855e9661899b7252"},"load-balancer_components-schemas-name":{"description":"The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will not be used.","example":"www.example.com","type":"string"},"load-balancer_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/load-balancer-ZLoHsRks"},"type":"array"}}}]},"load-balancer_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/load-balancer-ZLoHsRks"}}}]},"load_shedding":{"description":"Configures load shedding policies and percentages for the pool.","properties":{"default_percent":{"default":0,"description":"The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity.","maximum":100,"minimum":0,"type":"number"},"default_policy":{"default":"random","description":"The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests originating from a percent of IPs.","enum":["random","hash"],"type":"string"},"session_percent":{"default":0,"description":"The percent of existing sessions to shed from the pool, according to the session policy.","maximum":100,"minimum":0,"type":"number"},"session_policy":{"default":"hash","description":"Only the hash policy is supported for existing sessions (to avoid exponential decay).","enum":["hash"],"type":"string"}},"type":"object"},"location":{"description":"Location, provided by the CSR","example":"Somewhere","readOnly":true,"type":"string"},"location_strategy":{"description":"Controls location-based steering for non-proxied requests. See `steering_policy` to learn how steering is affected.","properties":{"mode":{"default":"pop","description":"Determines the authoritative location when ECS is not preferred, does not exist in the request, or its GeoIP lookup is unsuccessful.\n- `\"pop\"`: Use the Cloudflare PoP location.\n- `\"resolver_ip\"`: Use the DNS resolver GeoIP location. If the GeoIP lookup is unsuccessful, use the Cloudflare PoP location.","enum":["pop","resolver_ip"],"example":"resolver_ip","type":"string"},"prefer_ecs":{"default":"proximity","description":"Whether the EDNS Client Subnet (ECS) GeoIP should be preferred as the authoritative location.\n- `\"always\"`: Always prefer ECS.\n- `\"never\"`: Never prefer ECS.\n- `\"proximity\"`: Prefer ECS only when `steering_policy=\"proximity\"`.\n- `\"geo\"`: Prefer ECS only when `steering_policy=\"geo\"`.","enum":["always","never","proximity","geo"],"example":"always","type":"string"}},"type":"object"},"locations":{"properties":{"client_default":{"$ref":"#/components/schemas/client-default"},"created_at":{"$ref":"#/components/schemas/timestamp"},"doh_subdomain":{"$ref":"#/components/schemas/subdomain"},"ecs_support":{"$ref":"#/components/schemas/ecs-support"},"id":{"$ref":"#/components/schemas/schemas-uuid"},"ip":{"$ref":"#/components/schemas/ip"},"name":{"$ref":"#/components/schemas/schemas-name"},"networks":{"$ref":"#/components/schemas/network"},"updated_at":{"$ref":"#/components/schemas/timestamp"}},"type":"object"},"lockdowns_components-schemas-description":{"description":"An informative summary of the rule.","example":"Restrict access to these endpoints to requests from a known IP address","maxLength":1024,"type":"string"},"lockdowns_components-schemas-id":{"description":"The unique identifier of the Zone Lockdown rule.","example":"372e67954025e0ba6aaa6d586b9e0b59","maxLength":32,"readOnly":true,"type":"string"},"lockdowns_components-schemas-priority":{"description":"The priority of the rule to control the processing order. A lower number indicates higher priority. If not provided, any rules with a configured priority will be processed before rules without a priority.","example":5,"type":"number"},"locked":{"description":"Shows whether a registrar lock is in place for a domain.","example":false,"type":"boolean"},"logging":{"description":"An object configuring the rule's logging behavior.","example":{"enabled":true},"properties":{"enabled":{"description":"Whether to generate a log when the rule matches.","example":true,"type":"boolean"}},"type":"object"},"login_design":{"properties":{"background_color":{"description":"The background color on your login page.","example":"#c5ed1b","type":"string"},"footer_text":{"description":"The text at the bottom of your login page.","example":"This is an example description.","type":"string"},"header_text":{"description":"The text at the top of your login page.","example":"This is an example description.","type":"string"},"logo_path":{"description":"The URL of the logo on your login page.","example":"https://example.com/logo.png","type":"string"},"text_color":{"description":"The text color on your login page.","example":"#c5ed1b","type":"string"}}},"logo_url":{"description":"The image URL for the logo shown in the App Launcher dashboard.","example":"https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg","type":"string"},"logpull_options":{"description":"Configuration string. It specifies things like requested fields and timestamp formats. If migrating from the logpull api, copy the url (full url or just the query string) of your call here, and logpush will keep on making this call for you, setting start and end times appropriately.","example":"fields=RayID,ClientIP,EdgeStartTimestamp\u0026timestamps=rfc3339","format":"uri-reference","maxLength":4096,"nullable":true,"type":"string"},"logpush":{"description":"Whether Logpush is turned on for the Worker.","example":false,"type":"boolean"},"logpush_field_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"items":{"nullable":true,"properties":{"key":{"example":"value","type":"string"}},"type":"object"},"type":"object"}}}]},"logpush_job":{"nullable":true,"properties":{"dataset":{"$ref":"#/components/schemas/dataset"},"destination_conf":{"$ref":"#/components/schemas/destination_conf"},"enabled":{"$ref":"#/components/schemas/enabled-A6pti18n"},"error_message":{"$ref":"#/components/schemas/error_message"},"frequency":{"$ref":"#/components/schemas/frequency"},"id":{"$ref":"#/components/schemas/id-Un5diNDY"},"last_complete":{"$ref":"#/components/schemas/last_complete"},"last_error":{"$ref":"#/components/schemas/last_error"},"logpull_options":{"$ref":"#/components/schemas/logpull_options"},"name":{"$ref":"#/components/schemas/name-rRqaJzmt"}},"type":"object"},"logpush_job_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/logpush_job"},"type":"array"}}}]},"logpush_job_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/logpush_job"}}}]},"logs":{"anyOf":[{"type":"string"},{"type":"object"}],"example":"{\"ClientIP\":\"192.0.2.1\",\"RayID\":\"41ddf1740f67442d\",\"EdgeStartTimestamp\":1526810289280000000}\n{\"ClientIP\":\"192.0.2.1\",\"RayID\":\"41ddf1740f67442d\",\"EdgeStartTimestamp\":1526810289280000000}\n{\"ClientIP\":\"192.0.2.1\",\"RayID\":\"41ddf1740f67442d\",\"EdgeStartTimestamp\":1526810289280000000}"},"longitude":{"description":"The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set.","type":"number"},"mac_address":{"description":"The device mac address.","example":"00-00-5E-00-53-00","type":"string"},"managed_headers_components-schemas-enabled":{"description":"When true, the Managed Transform is enabled.","example":true,"type":"boolean"},"managed_headers_components-schemas-id":{"description":"Human-readable identifier of the Managed Transform.","example":"add_cf-bot-score_header","type":"string"},"manufacturer":{"description":"The device manufacturer name.","example":"My phone corp","type":"string"},"match":{"description":"Determines which traffic the rate limit counts towards the threshold.","oneOf":[{"properties":{"headers":{"items":{"properties":{"name":{"$ref":"#/components/schemas/header_name"},"op":{"$ref":"#/components/schemas/header_op"},"value":{"$ref":"#/components/schemas/header_value"}},"type":"object"},"type":"array"},"request":{"properties":{"methods":{"$ref":"#/components/schemas/methods"},"schemes":{"$ref":"#/components/schemas/schemes"},"url":{"$ref":"#/components/schemas/schemas-url"}},"type":"object"},"response":{"properties":{"origin_traffic":{"$ref":"#/components/schemas/origin_traffic"}},"type":"object"}},"type":"object"}],"type":"object"},"match-gWGZ7MOw":{"description":"The conditions that the client must match to run the rule.","items":{"$ref":"#/components/schemas/match_item"},"type":"array"},"match_item":{"properties":{"platform":{"$ref":"#/components/schemas/platform"}},"type":"object"},"maxDurationSeconds":{"description":"The maximum duration in seconds for a video upload. Can be set for a video that is not yet uploaded to limit its duration. Uploads that exceed the specified duration will fail during processing. A value of `-1` means the value is unknown.","maximum":21600,"minimum":1,"type":"integer"},"max_age":{"description":"The maximum number of seconds the results of a preflight request can be cached.","example":-1,"maximum":86400,"minimum":-1,"type":"number"},"max_estimated_time_minutes":{"type":"integer"},"max_retries":{"example":3,"type":"number"},"max_rtt_ms":{"description":"Maximum RTT in ms.","type":"number"},"max_ttl":{"default":15,"description":"Max TTL.","maximum":64,"minimum":0,"type":"integer"},"max_upload":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"identifier of the zone setting.","enum":["max_upload"],"example":"max_upload"},"value":{"$ref":"#/components/schemas/max_upload_value"}}}],"description":"Maximum size of an allowable upload.","title":"Max Upload"},"max_upload_value":{"default":100,"description":"Value of the zone setting.\nNotes: The size depends on the plan level of the zone. (Enterprise = 500, Business = 200, Pro = 100, Free = 100)","enum":[100,200,500],"type":"number"},"max_wait_time_ms":{"example":5000,"type":"number"},"maximum_cache_ttl":{"default":900,"description":"Maximum DNS Cache TTL.","example":900,"maximum":36000,"minimum":30,"type":"number"},"mean_rtt_ms":{"description":"Mean RTT in ms.","type":"number"},"mechanism":{"description":"The mechanism to which the notification has been dispatched.","example":"test@example.com","type":"string"},"mechanism_type":{"description":"The type of mechanism to which the notification has been dispatched. This can be email/pagerduty/webhook based on the mechanism configured.","enum":["email","pagerduty","webhook"],"example":"email","type":"string"},"mechanisms":{"additionalProperties":{"items":{"properties":{"id":{"$ref":"#/components/schemas/uuid-s0SXln0q"}},"type":"object"},"type":"array"},"description":"List of IDs that will be used when dispatching a notification. IDs for email type will be the email address.","example":{"email":[{"id":"test@example.com"}],"pagerduty":[{"id":"e8133a15-00a4-4d69-aec1-32f70c51f6e5"}],"webhooks":[{"id":"14cc1190-5d2b-4b98-a696-c424cb2ad05f"}]},"type":"object"},"media_metadata":{"description":"A user modifiable key-value store used to reference other systems of record for managing videos.","example":{},"type":"object"},"media_state":{"description":"Specifies the processing status of the video.","enum":["pendingupload","downloading","queued","inprogress","ready","error"],"example":"inprogress","readOnly":true,"type":"string"},"media_status":{"description":"Specifies a detailed status for a video. If the `state` is `inprogress` or `error`, the `step` field returns `encoding` or `manifest`. If the `state` is `inprogress`, `pctComplete` returns a number between 0 and 100 to indicate the approximate percent of completion. If the `state` is `error`, `errorReasonCode` and `errorReasonText` provide additional details.","properties":{"errorReasonCode":{"$ref":"#/components/schemas/errorReasonCode"},"errorReasonText":{"$ref":"#/components/schemas/errorReasonText"},"pctComplete":{"$ref":"#/components/schemas/pctComplete"},"state":{"$ref":"#/components/schemas/media_state"}},"readOnly":true},"member":{"properties":{"code":{"$ref":"#/components/schemas/code"},"id":{"$ref":"#/components/schemas/membership_components-schemas-identifier"},"roles":{"description":"Roles assigned to this member.","items":{"$ref":"#/components/schemas/role"},"type":"array"},"status":{"readOnly":true},"user":{"properties":{"email":{"$ref":"#/components/schemas/email-sNyq81Xd"},"first_name":{"$ref":"#/components/schemas/first_name"},"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"last_name":{"$ref":"#/components/schemas/last_name"},"two_factor_authentication_enabled":{"$ref":"#/components/schemas/two_factor_authentication_enabled"}},"readOnly":true,"required":["email"],"type":"object"}},"required":["id","user","status","roles"],"type":"object"},"member_components-schemas-name":{"description":"Member Name.","example":"John Smith","maxLength":100,"nullable":true,"type":"string"},"membership":{"properties":{"account":{"$ref":"#/components/schemas/schemas-account"},"api_access_enabled":{"$ref":"#/components/schemas/api_access_enabled"},"code":{"$ref":"#/components/schemas/code"},"id":{"$ref":"#/components/schemas/membership_components-schemas-identifier"},"permissions":{"allOf":[{"$ref":"#/components/schemas/permissions"}],"description":"All access permissions for the user at the account.","readOnly":true},"roles":{"$ref":"#/components/schemas/roles"},"status":{"$ref":"#/components/schemas/schemas-status-uJZPVtIE"}},"type":"object"},"membership_components-schemas-identifier":{"description":"Membership identifier tag.","example":"4536bcfad5faccb111b47003c79917fa","maxLength":32,"readOnly":true,"type":"string"},"memberships":{"description":"Zones and Accounts which will be assigned IPs on this Address Map. A zone membership will take priority over an account membership.","items":{"$ref":"#/components/schemas/address-maps-membership-upHJKSmv"},"type":"array"},"messages":{"example":[],"items":{"properties":{"code":{"minimum":1000,"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"type":"object","uniqueItems":true},"type":"array"},"metadata":{"description":"User modifiable key-value store. Can be used for keeping references to another system of record for managing images. Metadata must not exceed 1024 bytes.","example":{"key":"value"},"type":"object"},"method":{"description":"The HTTP method used to access the endpoint.","enum":["GET","POST","HEAD","OPTIONS","PUT","DELETE","CONNECT","PATCH","TRACE"],"example":"GET","type":"string"},"method-guvmKTdR":{"default":"GET","description":"The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.","example":"GET","type":"string"},"methods":{"description":"The HTTP methods to match. You can specify a subset (for example, `['POST','PUT']`) or all methods (`['_ALL_']`). This field is optional when creating a rate limit.","example":["GET","POST"],"items":{"description":"An HTTP method or `_ALL_` to indicate all methods.","enum":["GET","POST","PUT","DELETE","PATCH","HEAD","_ALL_"],"example":"GET","type":"string"},"type":"array"},"metrics":{"description":"A comma-separated list of metrics to query.","example":"queryCount,uncachedCount","type":"string"},"min_rtt_ms":{"description":"Minimum RTT in ms.","type":"number"},"min_tls_version":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["min_tls_version"],"example":"min_tls_version"},"value":{"$ref":"#/components/schemas/min_tls_version_value"}}}],"default":"1.0","description":"Only accepts HTTPS requests that use at least the TLS protocol version specified. For example, if TLS 1.1 is selected, TLS 1.0 connections will be rejected, while 1.1, 1.2, and 1.3 (if enabled) will be permitted.","title":"Zone Minimum TLS Version value"},"min_tls_version_value":{"default":"1.0","description":"Value of the zone setting.","enum":["1.0","1.1","1.2","1.3"],"type":"string"},"minify":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"Zone setting identifier.","enum":["minify"],"example":"minify"},"value":{"$ref":"#/components/schemas/minify_value"}}}],"description":"Automatically minify certain assets for your website. Refer to [Using Cloudflare Auto Minify](https://support.cloudflare.com/hc/en-us/articles/200168196) for more information.","title":"Auto-Minify Assets"},"minify_value":{"description":"Value of the zone setting.","properties":{"css":{"default":"off","description":"Automatically minify all CSS files for your website.","enum":["on","off"]},"html":{"default":"off","description":"Automatically minify all HTML files for your website.","enum":["on","off"]},"js":{"default":"off","description":"Automatically minify all JavaScript files for your website.","enum":["on","off"]}},"type":"object"},"minimum_cache_ttl":{"default":60,"description":"Minimum DNS Cache TTL.","example":60,"maximum":36000,"minimum":30,"type":"number"},"minimum_origins":{"default":1,"description":"The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool.","type":"integer"},"mirage":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["mirage"],"example":"mirage"},"value":{"$ref":"#/components/schemas/mirage_value"}}}],"description":"Automatically optimize image loading for website visitors on mobile\ndevices. Refer to [our blog post](http://blog.cloudflare.com/mirage2-solving-mobile-speed)\nfor more information.\n","title":"Mirage Image Optimization"},"mirage_value":{"default":"off","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"miscategorization":{"properties":{"content_adds":{"description":"Content category IDs to add.","example":[82]},"content_removes":{"description":"Content category IDs to remove.","example":[155]},"indicator_type":{"enum":["domain","ipv4","ipv6","url"],"example":"domain"},"ip":{"description":"Provide only if indicator_type is `ipv4` or `ipv6`."},"security_adds":{"description":"Security category IDs to add.","example":[117,131]},"security_removes":{"description":"Security category IDs to remove.","example":[83]},"url":{"description":"Provide only if indicator_type is `domain` or `url`. Example if indicator_type is `domain`: `example.com`. Example if indicator_type is `url`: `https://example.com/news/`.","type":"string"}}},"mnm_config":{"properties":{"default_sampling":{"$ref":"#/components/schemas/mnm_config_default_sampling"},"name":{"$ref":"#/components/schemas/mnm_config_name"},"router_ips":{"$ref":"#/components/schemas/mnm_config_router_ips"}},"required":["name","default_sampling","router_ips"],"type":"object"},"mnm_config_default_sampling":{"default":1,"description":"Fallback sampling rate of flow messages being sent in packets per second. This should match the packet sampling rate configured on the router.","minimum":1,"type":"number"},"mnm_config_name":{"description":"The account name.","example":"cloudflare user's account","type":"string"},"mnm_config_router_ip":{"description":"IPv4 CIDR of the router sourcing flow data. Only /32 addresses are currently supported.","example":"203.0.113.1/32","type":"string"},"mnm_config_router_ips":{"items":{"$ref":"#/components/schemas/mnm_config_router_ip"},"type":"array"},"mnm_config_single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/mnm_config"}},"type":"object"}]},"mnm_rule":{"nullable":true,"properties":{"automatic_advertisement":{"$ref":"#/components/schemas/mnm_rule_automatic_advertisement"},"bandwidth_threshold":{"$ref":"#/components/schemas/mnm_rule_bandwidth_threshold"},"duration":{"$ref":"#/components/schemas/mnm_rule_duration"},"id":{"$ref":"#/components/schemas/rule_identifier"},"name":{"$ref":"#/components/schemas/mnm_rule_name"},"packet_threshold":{"$ref":"#/components/schemas/mnm_rule_packet_threshold"},"prefixes":{"$ref":"#/components/schemas/mnm_rule_ip_prefixes"}},"required":["name","prefixes","automatic_advertisement","duration"],"type":"object"},"mnm_rule_advertisable_response":{"nullable":true,"properties":{"automatic_advertisement":{"$ref":"#/components/schemas/mnm_rule_automatic_advertisement"}},"required":["automatic_advertisement"],"type":"object"},"mnm_rule_advertisement_single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/mnm_rule_advertisable_response"}},"type":"object"}]},"mnm_rule_automatic_advertisement":{"description":"Toggle on if you would like Cloudflare to automatically advertise the IP Prefixes within the rule via Magic Transit when the rule is triggered. Only available for users of Magic Transit.","example":"false","nullable":true,"type":"boolean"},"mnm_rule_bandwidth_threshold":{"description":"The number of bits per second for the rule. When this value is exceeded for the set duration, an alert notification is sent. Minimum of 1 and no maximum.","example":1000,"minimum":1,"type":"number"},"mnm_rule_duration":{"default":"60s","description":"The amount of time that the rule threshold must be exceeded to send an alert notification. The minimum is 60 seconds and maximum is 21600 seconds. The format is XhYmZs where X, Y, and Z durations are optional; however at least one unit must be provided.","example":"1h2m3s","type":"string"},"mnm_rule_ip_prefix":{"description":"The IP prefixes that are monitored for this rule. Must be a CIDR range like 203.0.113.0/24. Max 5000 different CIDR ranges.","example":"203.0.113.1/32","type":"string"},"mnm_rule_ip_prefixes":{"items":{"$ref":"#/components/schemas/mnm_rule_ip_prefix"},"type":"array"},"mnm_rule_name":{"description":"The name of the rule. Must be unique. Supports characters A-Z, a-z, 0-9, underscore (_), dash (-), period (.), and tilde (~). You can’t have a space in the rule name. Max 256 characters.","example":"my_rule_1","type":"string"},"mnm_rule_packet_threshold":{"description":"The number of packets per second for the rule. When this value is exceeded for the set duration, an alert notification is sent. Minimum of 1 and no maximum.","example":10000,"minimum":1,"type":"number"},"mnm_rules_collection_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/mnm_rule"},"nullable":true,"type":"array"}}}]},"mnm_rules_single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/mnm_rule"}},"type":"object"}]},"mobile_redirect":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"Identifier of the zone setting.","enum":["mobile_redirect"],"example":"mobile_redirect"},"value":{"$ref":"#/components/schemas/mobile_redirect_value"}}}],"description":"Automatically redirect visitors on mobile devices to a mobile-optimized subdomain. Refer to [Understanding Cloudflare Mobile Redirect](https://support.cloudflare.com/hc/articles/200168336) for more information.","title":"Mobile Redirect"},"mobile_redirect_value":{"description":"Value of the zone setting.","properties":{"mobile_subdomain":{"description":"Which subdomain prefix you wish to redirect visitors on mobile devices to (subdomain must already exist).","example":"m","minLength":1,"nullable":true,"type":"string"},"status":{"default":"off","description":"Whether or not mobile redirect is enabled.","enum":["on","off"]},"strip_uri":{"default":false,"description":"Whether to drop the current page path and redirect to the mobile subdomain URL root, or keep the path and redirect to the same page on the mobile subdomain.","example":false,"type":"boolean"}},"type":"object"},"mode":{"description":"The action to perform.","enum":["simulate","ban","challenge","js_challenge","managed_challenge"],"example":"challenge","type":"string"},"mode_allow_traditional":{"description":"When set to `on`, the current rule will be used when evaluating the request. Applies to traditional (allow) WAF rules.","enum":["on","off"],"example":"on","type":"string"},"mode_anomaly":{"description":"When set to `on`, the current WAF rule will be used when evaluating the request. Applies to anomaly detection WAF rules.","enum":["on","off"],"example":"on","type":"string"},"mode_deny_traditional":{"description":"The action that the current WAF rule will perform when triggered. Applies to traditional (deny) WAF rules.","enum":["default","disable","simulate","block","challenge"],"example":"block","type":"string"},"model":{"description":"The device model name.","example":"MyPhone(pro-X)","type":"string"},"modified":{"description":"When the Application was last modified.","example":"2014-01-02T02:20:00Z","format":"date-time","readOnly":true,"type":"string"},"modified-5P46cImn":{"description":"The date and time the media item was last modified.","example":"2014-01-02T02:20:00Z","format":"date-time","readOnly":true,"type":"string"},"modified-Hq0wyeit":{"description":"The date and time the destination address was last modified.","example":"2014-01-02T02:20:00Z","format":"date-time","readOnly":true,"type":"string"},"modified_at_nullable":{"description":"Last time the advertisement status was changed. This field is only not 'null' if on demand is enabled.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","nullable":true,"type":"string"},"modified_on":{"description":"When the route was last modified.","example":"2017-06-14T05:20:00Z","format":"date-time","readOnly":true,"type":"string"},"modified_on-6lsEa3Mx":{"description":"When the script was last modified.","example":"2017-01-01T00:00:00Z","format":"date-time","readOnly":true,"type":"string"},"modified_on-JpSxLOr6":{"description":"When DNSSEC was last modified.","example":"2014-01-01T05:20:00Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"modified_on-bJDfxiY8":{"description":"Last time the token was modified.","example":"2018-07-02T05:20:00Z","format":"date-time","readOnly":true,"type":"string"},"modified_on-t5RPC3jV":{"description":"When the certificate was last modified.","example":"2014-01-01T05:20:00Z","format":"date-time","readOnly":true,"type":"string"},"modified_on-uPCC7iXw":{"description":"Last modification of DNS Firewall cluster.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string"},"modified_on-zM0Z89yx":{"description":"last time this setting was modified.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"modified_rules_count":{"default":0,"description":"The number of rules within the group that have been modified from their default configuration.","example":2,"readOnly":true,"type":"number"},"modified_tunnels_collection_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"modified":{"example":true,"type":"boolean"},"modified_gre_tunnels":{"items":{"$ref":"#/components/schemas/gre-tunnel"},"type":"array"}}}}}]},"modify_request":{"properties":{"description":{"$ref":"#/components/schemas/web3-hostname_components-schemas-description"},"dnslink":{"$ref":"#/components/schemas/dnslink"}},"type":"object"},"monitor":{"properties":{"allow_insecure":{"$ref":"#/components/schemas/allow_insecure"},"created_on":{"$ref":"#/components/schemas/timestamp"},"description":{"$ref":"#/components/schemas/monitor_components-schemas-description"},"expected_body":{"$ref":"#/components/schemas/expected_body"},"expected_codes":{"$ref":"#/components/schemas/expected_codes"},"follow_redirects":{"$ref":"#/components/schemas/follow_redirects"},"header":{"$ref":"#/components/schemas/header"},"id":{"$ref":"#/components/schemas/monitor_components-schemas-identifier"},"interval":{"$ref":"#/components/schemas/interval-IFpdxmAf"},"method":{"$ref":"#/components/schemas/schemas-method"},"modified_on":{"$ref":"#/components/schemas/timestamp"},"path":{"$ref":"#/components/schemas/path-N56b8ntG"},"port":{"$ref":"#/components/schemas/schemas-port"},"retries":{"$ref":"#/components/schemas/retries"},"timeout":{"$ref":"#/components/schemas/schemas-timeout"},"type":{"$ref":"#/components/schemas/monitor_components-schemas-type"}},"type":"object"},"monitor-FBAH67XY":{"properties":{"allow_insecure":{"$ref":"#/components/schemas/allow_insecure"},"created_on":{"$ref":"#/components/schemas/timestamp"},"description":{"$ref":"#/components/schemas/description-Jd6AMFjR"},"expected_body":{"$ref":"#/components/schemas/expected_body"},"expected_codes":{"$ref":"#/components/schemas/expected_codes"},"follow_redirects":{"$ref":"#/components/schemas/follow_redirects"},"header":{"$ref":"#/components/schemas/header"},"id":{"$ref":"#/components/schemas/identifier-FZThz4k7"},"interval":{"$ref":"#/components/schemas/interval-hA6swy38"},"method":{"$ref":"#/components/schemas/method-guvmKTdR"},"modified_on":{"$ref":"#/components/schemas/timestamp"},"path":{"$ref":"#/components/schemas/path-I0p9X4oI"},"port":{"$ref":"#/components/schemas/port-WXwz9tIV"},"retries":{"$ref":"#/components/schemas/retries"},"timeout":{"$ref":"#/components/schemas/timeout"},"type":{"$ref":"#/components/schemas/type-gTI6cLgq"}},"type":"object"},"monitor_components-schemas-description":{"description":"Object description.","example":"Login page monitor","type":"string"},"monitor_components-schemas-identifier":{"example":"f1aba936b94213e5b8dca0c0dbf1f9cc"},"monitor_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/monitor"},"type":"array"}}}]},"monitor_components-schemas-response_collection-2":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/components-schemas-monitor"},"type":"array"}}}]},"monitor_components-schemas-response_collection-hQYwgX5c":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/components-schemas-monitor-vfiRsl5D"},"type":"array"}}}]},"monitor_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/components-schemas-monitor-vfiRsl5D"}}}]},"monitor_components-schemas-type":{"default":"http","description":"The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'.","enum":["http","https","tcp","udp_icmp","icmp_ping","smtp"],"example":"https","type":"string"},"mtls-management_components-schemas-certificate_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/components-schemas-certificateObject-Eyk3On6c"},"type":"array"}}},{"properties":{"result_info":{"properties":{"count":{"example":1},"page":{"example":1},"per_page":{"example":50},"total_count":{"example":1},"total_pages":{"example":1}},"type":"object"}}}]},"mtls-management_components-schemas-certificate_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/components-schemas-certificateObject-Eyk3On6c"}],"type":"object"}}}]},"mtls-management_components-schemas-expires_on":{"description":"When the certificate expires.","example":"2122-10-29T16:59:47Z","format":"date-time","readOnly":true,"type":"string"},"mtls-management_components-schemas-identifier":{"description":"Certificate identifier tag.","example":"2458ce5a-0c35-4c7f-82c7-8e9487d3ff60","maxLength":36,"readOnly":true,"type":"string"},"mtls-management_components-schemas-name":{"description":"Optional unique name for the certificate. Only used for human readability.","example":"example_ca_cert","type":"string"},"mtls-management_components-schemas-status":{"description":"Certificate deployment status for the given service.","example":"pending_deployment","type":"string"},"mtls-management_components-schemas-uploaded_on":{"description":"This is the time the certificate was uploaded.","example":"2022-11-22T17:32:30.467938Z","format":"date-time","type":"string"},"mtu":{"default":1476,"description":"Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value is 576.","type":"integer"},"multiple_route_delete_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"deleted":{"example":true,"type":"boolean"},"deleted_routes":{"type":"object"}}}}}]},"multiple_route_modified_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"modified":{"example":true,"type":"boolean"},"modified_routes":{"items":{"$ref":"#/components/schemas/route"},"type":"array"}}}}}]},"name":{"description":"The name of the List.","example":"Admin Serial Numbers","type":"string"},"name-0M1mwjDs":{"default":"","description":"A short description of the watermark profile.","example":"Marketing Videos","readOnly":true,"type":"string"},"name-51RmM5yT":{"description":"A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed.","example":"server-1","type":"string"},"name-LiICrXvM":{"description":"The domain name","example":"example.com","maxLength":253,"pattern":"^([a-zA-Z0-9][\\-a-zA-Z0-9]*\\.)+[\\-a-zA-Z0-9]{2,20}$","type":"string"},"name-Pky1OOiR":{"description":"A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.","example":"primary-dc-1","type":"string"},"name-SScjQrIN":{"description":"DNS Firewall Cluster Name.","example":"My Awesome DNS Firewall cluster","maxLength":160,"type":"string"},"name-VvYEM0tR":{"description":"The keyless SSL name.","example":"example.com Keyless SSL","maxLength":180,"readOnly":true,"type":"string"},"name-YGUm4gr7":{"description":"Zone name.","example":"www.example.com.","type":"string"},"name-jYNmruXY":{"description":"A unique name to identify the waiting room. Only alphanumeric characters, hyphens and underscores are allowed.","example":"production_webinar","type":"string"},"name-pG4STmz5":{"description":"Token name.","example":"readonly token","maxLength":120,"type":"string"},"name-rRqaJzmt":{"description":"Optional human readable job name. Not unique. Cloudflare suggests that you set this to a meaningful string, like the domain name, to make it easier to identify your job.","example":"example.com","maxLength":512,"nullable":true,"pattern":"^[a-zA-Z0-9\\-\\.]*$","type":"string"},"name-wyyCMADI":{"description":"The name of the Device Posture Rule.","example":"Admin Serial Numbers","type":"string"},"name-xThA5RuS":{"description":"DNS record name (or @ for the zone apex).","example":"example.com","maxLength":255,"type":"string"},"name-xgxcxGi8":{"description":"The name of your Zero Trust organization.","example":"Widget Corps Internal Applications","type":"string"},"name-z6BHq9UH":{"description":"The name of the tunnel. The name cannot contain spaces or special characters, must be 15 characters or less, and cannot share a name with another GRE tunnel.","example":"GRE_1","type":"string"},"name_servers":{"description":"List of name servers.","example":["preston.ns.cloudflare.com","oli.ns.cloudflare.com"],"items":{"type":"string"},"type":"array"},"name_write":{"description":"The keyless SSL name.","example":"example.com Keyless SSL","maxLength":180,"name":"name","type":"string"},"namespace":{"properties":{"id":{"$ref":"#/components/schemas/namespace_identifier"},"supports_url_encoding":{"description":"True if keys written on the URL will be URL-decoded before storing. For example, if set to \"true\", a key written on the URL as \"%3F\" will be stored as \"?\".","example":true,"readOnly":true,"type":"boolean"},"title":{"$ref":"#/components/schemas/namespace_title"}},"required":["id","title"],"type":"object"},"namespace_identifier":{"description":"Namespace identifier tag.","example":"0f2ac74b498b48028cb68387c421e279","maxLength":32,"readOnly":true,"type":"string"},"namespace_title":{"description":"A human-readable string name for a Namespace.","example":"My Own Namespace","type":"string"},"negative_cache_ttl":{"description":"Negative DNS Cache TTL.","example":900,"maximum":36000,"minimum":30,"nullable":true,"type":"number"},"nel":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"Zone setting identifier.","enum":["nel"],"example":"nel"},"value":{"$ref":"#/components/schemas/nel_value"}}}],"description":"Enable Network Error Logging reporting on your zone. (Beta) ","title":"Network Error Logging"},"nel_value":{"description":"Value of the zone setting.","properties":{"enabled":{"default":false,"example":false,"type":"boolean"}},"type":"object"},"network":{"description":"A list of network ranges that requests from this location would originate from.","items":{"description":"The IPv4 address or IPv4 CIDR. IPv4 CIDRs are limited to a maximum of /24.","example":"192.0.2.1/32","type":"string"},"type":"array"},"neverRequireSignedURLs":{"default":false,"description":"Indicates whether the variant can access an image without a signature, regardless of image access control.","example":true,"type":"boolean"},"new-project-response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"type":"object"}}}]},"new_custom_entry":{"description":"A custom entry create payload","properties":{"enabled":{"description":"Whether the entry is enabled or not.","example":true,"type":"boolean"},"name":{"description":"The name of the entry.","example":"Credit card (Visa)","type":"string"},"pattern":{"$ref":"#/components/schemas/pattern"}},"required":["name","enabled","pattern"],"title":"Custom entry","type":"object"},"new_custom_entry-PxvT1kkf":{"description":"A custom entry create payload","properties":{"enabled":{"description":"Whether the entry is enabled or not.","example":true,"type":"boolean"},"name":{"description":"The name of the entry.","example":"Credit card (Visa)","type":"string"},"pattern":{"$ref":"#/components/schemas/components-schemas-pattern"}},"required":["name","enabled","pattern"],"title":"Custom entry","type":"object"},"new_custom_profile":{"properties":{"allowed_match_count":{"$ref":"#/components/schemas/allowed_match_count"},"description":{"description":"The description of the profile.","example":"A standard CVV card number","type":"string"},"entries":{"description":"The entries for this profile.","items":{"$ref":"#/components/schemas/new_custom_entry-PxvT1kkf"},"type":"array"},"name":{"description":"The name of the profile.","example":"Generic CVV Card Number","type":"string"}},"type":"object"},"new_users_per_minute":{"description":"Sets the number of new users that will be let into the route every minute. This value is used as baseline for the number of users that are let in per minute. So it is possible that there is a little more or little less traffic coming to the route based on the traffic patterns at that time around the world.","maximum":2147483647,"minimum":200,"type":"integer"},"next_event_prequeue_start_time":{"description":"An ISO 8601 timestamp that marks when the next event will begin queueing.","example":"2021-09-28T15:00:00.000Z","nullable":true,"type":"string"},"next_event_start_time":{"description":"An ISO 8601 timestamp that marks when the next event will start.","example":"2021-09-28T15:00:00.000Z","nullable":true,"type":"string"},"nexthop":{"description":"The next-hop IP Address for the static route.","example":"203.0.113.1","type":"string"},"node_result":{"example":{"asn":"AS13335","ip":"1.1.1.1","max_latency_ms":0.034,"mean_latency_ms":0.021,"min_latency_ms":0.014,"name":"one.one.one.one","packet_count":3,"std_dev_latency_ms":0.011269427669584647},"properties":{"asn":{"$ref":"#/components/schemas/schemas-asn"},"ip":{"$ref":"#/components/schemas/traceroute_components-schemas-ip"},"labels":{"$ref":"#/components/schemas/labels"},"max_rtt_ms":{"$ref":"#/components/schemas/max_rtt_ms"},"mean_rtt_ms":{"$ref":"#/components/schemas/mean_rtt_ms"},"min_rtt_ms":{"$ref":"#/components/schemas/min_rtt_ms"},"name":{"$ref":"#/components/schemas/traceroute_components-schemas-name"},"packet_count":{"$ref":"#/components/schemas/packet_count"},"std_dev_rtt_ms":{"$ref":"#/components/schemas/std_dev_rtt_ms"}},"type":"object"},"not_before":{"description":"The time before which the token MUST NOT be accepted for processing.","example":"2018-07-01T05:20:00Z","format":"date-time","type":"string"},"notes":{"description":"An informative summary of the rule, typically used as a reminder or explanation.","example":"This rule is enabled because of an event that occurred on date X.","type":"string"},"notificationUrl":{"description":"The URL where webhooks will be sent.","example":"https://example.com","format":"uri","type":"string"},"notification_email":{"description":"The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.","example":"someone@example.com,sometwo@example.com","type":"string"},"notification_filter":{"description":"Filter pool and origin health notifications by resource type or health status. Use null to reset.","example":{"origin":{"disable":true},"pool":{"healthy":false}},"nullable":true,"properties":{"origin":{"$ref":"#/components/schemas/filter_options"},"pool":{"$ref":"#/components/schemas/filter_options"}},"type":"object"},"ns_name":{"description":"The FQDN of the name server.","example":"ns1.example.com","format":"hostname","type":"string"},"num_items":{"description":"The number of items in the list.","example":10,"type":"number"},"num_referencing_filters":{"description":"The number of [filters](#filters) referencing the list.","example":2,"type":"number"},"object":{"properties":{"hasStoredData":{"description":"Whether the Durable Object has stored data.","example":true,"readOnly":true,"type":"boolean"},"id":{"description":"ID of the Durable Object.","example":"fe7803fc55b964e09d94666545aab688d360c6bda69ba349ced1e5f28d2fc2c8","readOnly":true,"type":"string"}},"type":"object"},"occurred_at":{"description":"When the billing item was created.","example":"2014-03-01T12:21:59.3456Z","format":"date-time","readOnly":true,"type":"string"},"oidc":{"allOf":[{"$ref":"#/components/schemas/identity-provider"},{"properties":{"config":{"allOf":[{"$ref":"#/components/schemas/generic-oauth-config"},{"properties":{"auth_url":{"description":"The authorization_endpoint URL of your IdP","example":"https://accounts.google.com/o/oauth2/auth","type":"string"},"certs_url":{"description":"The jwks_uri endpoint of your IdP to allow the IdP keys to sign the tokens","example":"https://www.googleapis.com/oauth2/v3/certs","type":"string"},"scopes":{"description":"OAuth scopes","example":["openid","email","profile"],"items":{"type":"string"},"type":"array"},"token_url":{"description":"The token_endpoint URL of your IdP","example":"https://accounts.google.com/o/oauth2/token","type":"string"}},"type":"object"}]}},"type":"object"}],"title":"Generic OAuth","type":"object"},"okta":{"allOf":[{"$ref":"#/components/schemas/identity-provider"},{"properties":{"config":{"allOf":[{"$ref":"#/components/schemas/generic-oauth-config"},{"properties":{"okta_account":{"description":"Your okta account url","example":"https://dev-abc123.oktapreview.com","type":"string"}},"type":"object"}]}},"type":"object"}],"title":"Okta","type":"object"},"okta_group_rule":{"description":"Matches an Okta group.\nRequires an Okta identity provider.","properties":{"okta":{"properties":{"connection_id":{"description":"The ID of your Okta identity provider.","example":"ea85612a-29c8-46c2-bacb-669d65136971","type":"string"},"email":{"description":"The email of the Okta group.","example":"devs@cloudflare.com","type":"string"}},"required":["email","connection_id"],"type":"object"}},"required":["okta"],"title":"Okta group","type":"object"},"on_demand_enabled":{"description":"Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.","example":true,"type":"boolean"},"on_demand_locked":{"description":"Whether advertisement status of the prefix is locked, meaning it cannot be changed.","example":false,"type":"boolean"},"oneTimeUploadExpiry":{"description":"The date and time when the video upload URL is no longer valid for direct user uploads.","example":"2014-01-02T02:20:00Z","format":"date-time","type":"string"},"onelogin":{"allOf":[{"$ref":"#/components/schemas/identity-provider"},{"properties":{"config":{"allOf":[{"$ref":"#/components/schemas/generic-oauth-config"},{"properties":{"onelogin_account":{"description":"Your OneLogin account url","example":"https://mycompany.onelogin.com","type":"string"}},"type":"object"}]}},"type":"object"}],"title":"OneLogin","type":"object"},"opacity":{"default":1,"description":"The translucency of the image. A value of `0.0` makes the image completely transparent, and `1.0` makes the image completely opaque. Note that if the image is already semi-transparent, setting this to `1.0` will not make the image completely opaque.","example":0.75,"maximum":1,"minimum":0,"readOnly":true,"type":"number"},"openapi":{"description":"A OpenAPI 3.0.0 compliant schema.","example":{"info":{"title":"OpenAPI JSON schema for www.example.com","version":"1.0"},"openapi":"3.0.0","paths":{"... Further paths ...":{},"/api/v1/users/{var1}":{"get":{"parameters":[{"in":"path","name":"var1","required":true,"schema":{"type":"string"}}]}}},"servers":[{"url":"www.example.com"}]},"type":"object"},"openapiwiththresholds":{"description":"A OpenAPI 3.0.0 compliant schema.","example":{"info":{"title":"OpenAPI JSON schema for www.example.com","version":"1.0"},"openapi":"3.0.0","paths":{"... Further paths ...":{},"/api/v1/users/{var1}":{"get":{"parameters":[{"in":"path","name":"var1","required":true,"schema":{"type":"string"}}]}}},"servers":[{"url":"www.example.com"}]},"type":"object"},"operation":{"properties":{"endpoint":{"$ref":"#/components/schemas/endpoint"},"features":{"$ref":"#/components/schemas/features"},"host":{"$ref":"#/components/schemas/host-nm3Leu3G"},"last_updated":{"$ref":"#/components/schemas/timestamp"},"method":{"$ref":"#/components/schemas/method"},"operation_id":{"$ref":"#/components/schemas/uuid-s0SXln0q"}},"required":["operation_id","method","host","endpoint","last_updated"],"type":"object"},"operation_id":{"description":"The unique operation ID of the asynchronous action.","example":"4da8780eeb215e6cb7f48dd981c4ea02","readOnly":true,"type":"string"},"opportunistic_encryption":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["opportunistic_encryption"],"example":"opportunistic_encryption"},"value":{"$ref":"#/components/schemas/opportunistic_encryption_value"}}}],"description":"Enables the Opportunistic Encryption feature for a zone.","title":"Enable Opportunistic Encryption for a zone"},"opportunistic_encryption_value":{"default":"on","description":"Value of the zone setting.\nNotes: Default value depends on the zone's plan level.","enum":["on","off"],"type":"string"},"opportunistic_onion":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["opportunistic_onion"],"example":"opportunistic_onion"},"value":{"$ref":"#/components/schemas/opportunistic_onion_value"}}}],"default":"off","description":"Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes.","title":"Zone Enable Onion Routing"},"opportunistic_onion_value":{"default":"off","description":"Value of the zone setting.\nNotes: Default value depends on the zone's plan level.","enum":["on","off"],"type":"string"},"options":{"description":"Allows you to define image resizing sizes for different use cases.","properties":{"fit":{"$ref":"#/components/schemas/fit"},"height":{"$ref":"#/components/schemas/height"},"metadata":{"$ref":"#/components/schemas/schemas-metadata"},"width":{"$ref":"#/components/schemas/width"}},"required":["fit","metadata","width","height"],"type":"object"},"orange_to_orange":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["orange_to_orange"],"example":"orange_to_orange"},"value":{"$ref":"#/components/schemas/orange_to_orange_value"}}}],"description":"Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also on Cloudflare.","title":"Orange to Orange"},"orange_to_orange_value":{"default":"on","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"organization":{"description":"Organization, provided by the CSR","example":"Organization","readOnly":true,"type":"string"},"organization-8ZC4Qebn":{"properties":{"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"name":{"$ref":"#/components/schemas/schemas-name-Usb6SCq8"},"permissions":{"$ref":"#/components/schemas/schemas-permissions"},"roles":{"description":"List of roles that a user has within an organization.","items":{"example":"All Privileges - Super Administrator","maxLength":120,"type":"string"},"readOnly":true,"type":"array"},"status":{"$ref":"#/components/schemas/components-schemas-status-bVKpIIc1"}},"type":"object"},"organization_components-schemas-identifier":{"description":"Organization identifier tag.","example":"01a7362d577a6c3019a474fd6f485823","maxLength":32,"readOnly":true,"type":"string"},"organization_invite":{"allOf":[{"$ref":"#/components/schemas/base-bSfRyaRZ"},{"properties":{"organization_is_enforcing_twofactor":{"default":false,"description":"Current status of two-factor enforcement on the organization.","example":true,"type":"boolean"},"status":{"description":"Current status of the invitation.","enum":["pending","accepted","rejected","canceled","left","expired"],"example":"accepted","type":"string"}}}]},"organizational_unit":{"description":"Organizational Unit, provided by the CSR","example":"Organizational Unit","readOnly":true,"type":"string"},"organizations":{"properties":{"auth_domain":{"$ref":"#/components/schemas/auth_domain"},"created_at":{"$ref":"#/components/schemas/timestamp"},"is_ui_read_only":{"$ref":"#/components/schemas/is_ui_read_only"},"login_design":{"$ref":"#/components/schemas/login_design"},"name":{"$ref":"#/components/schemas/name-xgxcxGi8"},"ui_read_only_toggle_reason":{"$ref":"#/components/schemas/ui_read_only_toggle_reason"},"updated_at":{"$ref":"#/components/schemas/timestamp"},"user_seat_expiration_inactive_time":{"$ref":"#/components/schemas/user_seat_expiration_inactive_time"}},"type":"object"},"organizations-ARhl3PEA":{"properties":{"auth_domain":{"$ref":"#/components/schemas/auth_domain"},"created_at":{"$ref":"#/components/schemas/timestamp"},"is_ui_read_only":{"$ref":"#/components/schemas/is_ui_read_only"},"login_design":{"$ref":"#/components/schemas/login_design"},"name":{"$ref":"#/components/schemas/organizations_components-schemas-name"},"updated_at":{"$ref":"#/components/schemas/timestamp"}},"type":"object"},"organizations_components-schemas-name":{"description":"The name of your Zero Trust organization.","example":"Widget Corps Internal Applications","type":"string"},"organizations_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/organizations-ARhl3PEA"}}}]},"origin":{"description":"Your origin hostname that requests to your custom hostnames will be sent to.","example":"fallback.example.com","maxLength":255,"type":"string"},"origin-D5vqwwTi":{"properties":{"address":{"$ref":"#/components/schemas/address-95deJOax"},"disabled_at":{"$ref":"#/components/schemas/disabled_at"},"enabled":{"$ref":"#/components/schemas/schemas-enabled-ItkBt4kJ"},"header":{"$ref":"#/components/schemas/schemas-header"},"name":{"$ref":"#/components/schemas/schemas-name-Tf4rbdAh"},"virtual_network_id":{"$ref":"#/components/schemas/virtual_network_id"},"weight":{"$ref":"#/components/schemas/weight-6YtMahm8"}},"type":"object"},"origin-rules_components-schemas-rule":{"properties":{"action":{"example":"route"},"action_parameters":{"$ref":"#/components/schemas/schemas-action_parameters"},"description":{"example":"change the host header, origin, and SNI"},"expression":{"example":"http.cookie contains \"something\""},"id":{"example":"3a03d665bac047339bb530ecb439a90d"},"version":{"example":"1"}}},"origin_components-schemas-enabled":{"default":true,"description":"Whether to enable (the default) this origin within the pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool.","example":true,"type":"boolean"},"origin_components-schemas-name":{"description":"A human-identifiable name for the origin.","example":"app-server-1","type":"string"},"origin_dns":{"description":"The name and type of DNS record for the Spectrum application.","properties":{"name":{"$ref":"#/components/schemas/origin_dns_name"},"ttl":{"$ref":"#/components/schemas/dns_ttl"},"type":{"$ref":"#/components/schemas/origin_dns_type"}},"type":"object"},"origin_dns_name":{"description":"The name of the DNS record associated with the origin.","example":"origin.example.com","format":"hostname","type":"string"},"origin_dns_type":{"description":"The type of DNS record associated with the origin. \"\" is used to specify a combination of A/AAAA records.","enum":["","A","AAAA","SRV"],"example":"","type":"string"},"origin_error_page_pass_thru":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["origin_error_page_pass_thru"],"example":"origin_error_page_pass_thru"},"value":{"$ref":"#/components/schemas/origin_error_page_pass_thru_value"}}}],"default":"off","description":"Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones.","title":"Error Pages On"},"origin_error_page_pass_thru_value":{"default":"off","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"origin_health_data":{"description":"The origin ipv4/ipv6 address or domain name mapped to it's health data.","example":{"failure_reason":"No failures","healthy":true,"response_code":200,"rtt":"66ms"},"properties":{"failure_reason":{"type":"string"},"healthy":{"type":"boolean"},"response_code":{"type":"number"},"rtt":{"type":"string"}},"type":"object"},"origin_healthy":{"default":true,"description":"If true, filter events where the origin status is healthy. If false, filter events where the origin status is unhealthy.","example":true,"type":"boolean"},"origin_ips":{"example":["192.0.2.1","198.51.100.1","2001:DB8:100::CF"],"items":{"anyOf":[{"description":"Origin DNS Server IPv4 Address.","example":"192.0.2.1","format":"ipv4","type":"string"},{"description":"Origin DNS Server IPv6 Address.","example":"2001:DB8:100::CF","format":"ipv6","type":"string"}]},"type":"array"},"origin_max_http_version":{"allOf":[{"properties":{"id":{"description":"Identifier of the zone setting.","enum":["origin_max_http_version"],"example":"origin_max_http_version"},"modified_on":{"description":"last time this setting was modified.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"}},"required":["id"]}],"description":"The highest HTTP version Cloudflare will attempt to use with your origin. This setting allows Cloudflare to make HTTP/2 requests to your origin. (Refer to [Enable HTTP/2 to Origin](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/), for more information.).","title":"Origin Max HTTP version"},"origin_port":{"anyOf":[{"type":"integer"},{"type":"string"}],"description":"The destination port at the origin. Only specified in conjunction with origin_dns. May use an integer to specify a single origin port, for example `1000`, or a string to specify a range of origin ports, for example `\"1000-2000\"`.\nNotes: If specifying a port range, the number of ports in the range must match the number of ports specified in the \"protocol\" field.","example":22,"maximum":65535,"minimum":1},"origin_steering":{"description":"Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.","properties":{"policy":{"default":"random","description":"The type of origin steering policy to use, either \"random\" or \"hash\" (based on CF-Connecting-IP).","enum":["random","hash"],"type":"string"}},"type":"object"},"origin_traffic":{"description":"When true, only the uncached traffic served from your origin servers will count towards rate limiting. In this case, any cached traffic served by Cloudflare will not count towards rate limiting. This field is optional.\nNotes: This field is deprecated. Instead, use response headers and set \"origin_traffic\" to \"false\" to avoid legacy behaviour interacting with the \"response_headers\" property.","type":"boolean"},"original_url":{"description":"URI to original variant for an image.","example":"https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/original","format":"uri","readOnly":true,"type":"string"},"origins":{"description":"The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.","items":{"$ref":"#/components/schemas/schemas-origin"},"type":"array"},"origins-BzaDTSuG":{"description":"The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.","items":{"$ref":"#/components/schemas/origin-D5vqwwTi"},"type":"array"},"os_distro_name":{"description":"The Linux distro name.","example":"ubuntu","type":"string"},"os_distro_revision":{"description":"The Linux distro revision.","example":"1.0.0","type":"string"},"os_version":{"description":"The operating system version.","example":"10.0.0","type":"string"},"output":{"properties":{"enabled":{"$ref":"#/components/schemas/output_enabled"},"streamKey":{"$ref":"#/components/schemas/output_streamKey"},"uid":{"$ref":"#/components/schemas/output_identifier"},"url":{"$ref":"#/components/schemas/output_url"}}},"output_enabled":{"default":true,"description":"When enabled, live video streamed to the associated live input will be sent to the output URL. When disabled, live video will not be sent to the output URL, even when streaming to the associated live input. Use this to control precisely when you start and stop simulcasting to specific destinations like YouTube and Twitch.","example":true,"type":"boolean"},"output_identifier":{"description":"A unique identifier for the output.","example":"baea4d9c515887b80289d5c33cf01145","maxLength":32,"readOnly":true,"type":"string"},"output_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/output"},"type":"array"}}}]},"output_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/output"}}}]},"output_streamKey":{"description":"The streamKey used to authenticate against an output's target.","example":"uzya-f19y-g2g9-a2ee-51j2","readOnly":true,"type":"string"},"output_url":{"description":"The URL an output uses to restream.","example":"rtmp://a.rtmp.youtube.com/live2","readOnly":true,"type":"string"},"override":{"properties":{"description":{"$ref":"#/components/schemas/overrides_components-schemas-description"},"groups":{"$ref":"#/components/schemas/groups-fQOB8cgI"},"id":{"$ref":"#/components/schemas/overrides_components-schemas-id"},"paused":{"$ref":"#/components/schemas/paused-jas4Z8f1"},"priority":{"$ref":"#/components/schemas/components-schemas-priority"},"rewrite_action":{"$ref":"#/components/schemas/rewrite_action"},"rules":{"$ref":"#/components/schemas/rules-YnuEBjzV"},"urls":{"$ref":"#/components/schemas/urls"}}},"override_codes_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"properties":{"disable_for_time":{"$ref":"#/components/schemas/disable_for_time"}},"type":"object"}}}]},"override_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"allOf":[{"$ref":"#/components/schemas/override"},{"required":["id","paused","urls","priority"],"type":"object"}]},"type":"array"}},"required":["result"],"type":"object"}]},"override_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/override"}},"required":["result"],"type":"object"}]},"overrides_components-schemas-description":{"description":"An informative summary of the current URI-based WAF override.","example":"Enable Cloudflare Magento ruleset for shop.example.com","maxLength":1024,"nullable":true,"type":"string"},"overrides_components-schemas-id":{"description":"The unique identifier of the WAF override.","example":"de677e5818985db1285d0e80225f06e5","maxLength":32,"readOnly":true,"type":"string"},"ownership_challenge":{"description":"Ownership challenge token to prove destination ownership.","example":"00000000000000000000","maxLength":4096,"pattern":"^[a-zA-Z0-9/\\+\\.\\-_]*$","type":"string"},"ownership_verification":{"description":"This is a record which can be placed to activate a hostname.","oneOf":[{"properties":{"name":{"description":"DNS Name for record.","example":"_cf-custom-hostname.app.example.com","type":"string"},"type":{"description":"DNS Record type.","enum":["txt"],"example":"txt"},"value":{"description":"Content for the record.","example":"5cc07c04-ea62-4a5a-95f0-419334a875a4","type":"string"}},"type":"object"}],"type":"object"},"ownership_verification_http":{"description":"This presents the token to be served by the given http url to activate a hostname.","oneOf":[{"properties":{"http_body":{"description":"Token to be served.","example":"5cc07c04-ea62-4a5a-95f0-419334a875a4","type":"string"},"http_url":{"description":"The HTTP URL that will be checked during custom hostname verification and where the customer should host the token.","example":"http://custom.test.com/.well-known/cf-custom-hostname-challenge/0d89c70d-ad9f-4843-b99f-6cc0252067e9","type":"string"}},"type":"object"}],"type":"object"},"p50":{"description":"The p50 quantile of requests (in period_seconds).","readOnly":true,"type":"integer"},"p90":{"description":"The p90 quantile of requests (in period_seconds).","readOnly":true,"type":"integer"},"p99":{"description":"The p99 quantile of requests (in period_seconds).","readOnly":true,"type":"integer"},"package":{"oneOf":[{"$ref":"#/components/schemas/package_definition"},{"$ref":"#/components/schemas/anomaly_package"}],"type":"object"},"package_components-schemas-description":{"description":"A summary of the purpose/function of the WAF package.","example":"null","readOnly":true,"type":"string"},"package_components-schemas-identifier":{"description":"The unique identifier of a WAF package.","example":"a25a9a7e9c00afc1fb2e0245519d725b","maxLength":32,"readOnly":true,"type":"string"},"package_components-schemas-name":{"description":"The name of the WAF package.","example":"USER","readOnly":true,"type":"string"},"package_components-schemas-status":{"default":"active","description":"When set to `active`, indicates that the WAF package will be applied to the zone.","enum":["active"],"readOnly":true,"type":"string"},"package_definition":{"properties":{"description":{"$ref":"#/components/schemas/package_components-schemas-description"},"detection_mode":{"$ref":"#/components/schemas/detection_mode"},"id":{"$ref":"#/components/schemas/package_components-schemas-identifier"},"name":{"$ref":"#/components/schemas/package_components-schemas-name"},"status":{"$ref":"#/components/schemas/package_components-schemas-status"},"zone_id":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},"required":["id","name","description","detection_mode","zone_id"],"title":"Traditional WAF package"},"package_response_collection":{"anyOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/package"},"type":"array"}}}]},"package_response_single":{"oneOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"packet_count":{"description":"Number of packets with a response from this node.","type":"integer"},"packet_type":{"default":"icmp","description":"Type of packet sent.","enum":["icmp","tcp","udp","gre","gre+icmp"],"example":"icmp","type":"string"},"packets_lost":{"description":"Number of packets where no response was received.","type":"integer"},"packets_per_ttl":{"default":3,"description":"Number of packets sent at each TTL.","maximum":10,"minimum":0,"type":"integer"},"packets_sent":{"description":"Number of packets sent with specified TTL.","type":"integer"},"packets_ttl":{"description":"The time to live (TTL).","type":"integer"},"padding":{"default":0.05,"description":"The whitespace between the adjacent edges (determined by position) of the video and the image. `0.0` indicates no padding, and `1.0` indicates a fully padded video width or length, as determined by the algorithm.","example":0.1,"maximum":1,"minimum":0,"readOnly":true,"type":"number"},"page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"page-rule":{"properties":{"actions":{"$ref":"#/components/schemas/actions"},"created_on":{"$ref":"#/components/schemas/created_on-kB9fypz8"},"id":{"$ref":"#/components/schemas/schemas-identifier"},"modified_on":{"$ref":"#/components/schemas/schemas-modified_on-DUFYxWOX"},"priority":{"$ref":"#/components/schemas/priority-21tFu5p5"},"status":{"$ref":"#/components/schemas/status-cnKVAn0b"},"targets":{"$ref":"#/components/schemas/targets"}},"required":["id","targets","actions","priority","status","modified_on","created_on"],"type":"object"},"pagerduty":{"properties":{"id":{"$ref":"#/components/schemas/uuid-s0SXln0q"},"name":{"$ref":"#/components/schemas/pagerduty_components-schemas-name"}},"type":"object"},"pagerduty_components-schemas-name":{"description":"The name of the pagerduty service.","example":"My PagerDuty Service","type":"string"},"pagerduty_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/pagerduty"},"type":"array"}}}]},"pagerule_response_collection":{"allOf":[{"$ref":"#/components/schemas/schemas-api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/page-rule"},"type":"array"}}}]},"pagerule_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single-ktIvFt8K"},{"properties":{"result":{"type":"object"}}}]},"pagerule_settings_response_collection":{"allOf":[{"$ref":"#/components/schemas/schemas-api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/settings"}}}]},"pageviews":{"description":"Breakdown of totals for pageviews.","properties":{"all":{"description":"The total number of pageviews served within the time range.","type":"integer"},"search_engine":{"description":"A variable list of key/value pairs representing the search engine and number of hits.","example":{"baidubot":1345,"bingbot":5372,"googlebot":35272,"pingdom":13435},"type":"object"}},"type":"object"},"parameter_schemas":{"properties":{"parameter_schemas":{"properties":{"last_updated":{"$ref":"#/components/schemas/timestamp"},"parameter_schemas":{"$ref":"#/components/schemas/parameter_schemas_definition"}},"type":"object"}},"readOnly":true,"required":["parameter_schemas","last_updated"],"type":"object"},"parameter_schemas_definition":{"description":"An operation schema object containing a response.","example":{"parameters":[{"description":"Sufficient requests have been observed for this parameter to provide high confidence in this parameter schema.","in":"path","name":"var1","required":true,"schema":{"maximum":10,"minimum":1,"type":"integer"}}],"responses":null},"properties":{"parameters":{"description":"An array containing the learned parameter schemas.","example":[{"description":"Sufficient requests have been observed for this parameter to provide high confidence in this parameter schema.","in":"path","name":"var1","required":true,"schema":{"maximum":10,"minimum":1,"type":"integer"}}],"items":{},"readOnly":true,"type":"array"},"responses":{"description":"An empty response object. This field is required to yield a valid operation schema.","readOnly":true,"type":"object"}},"readOnly":true,"type":"object"},"passive-dns-by-ip":{"properties":{"count":{"description":"Total results returned based on your search parameters.","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results.","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results.","example":20,"type":"number"},"reverse_records":{"description":"Reverse DNS look-ups observed during the time period.","items":{"properties":{"first_seen":{"description":"First seen date of the DNS record during the time period.","example":"2021-04-01","format":"date","type":"string"},"hostname":{"description":"Hostname that the IP was observed resolving to."},"last_seen":{"description":"Last seen date of the DNS record during the time period.","example":"2021-04-30","format":"date","type":"string"}},"type":"object"},"type":"array"}}},"passive-dns-by-ip_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/passive-dns-by-ip"}}}]},"patch":{"description":"Update enablement of Argo Smart Routing","properties":{"value":{"$ref":"#/components/schemas/schemas-value"}},"required":["value"],"type":"object"},"patch_pools_notification_email":{"description":"The email address to send health status notifications to. This field is now deprecated in favor of Cloudflare Notifications for Load Balancing, so only resetting this field with an empty string `\"\"` is accepted.","enum":["\"\""],"example":"","type":"string"},"patch_rule":{"properties":{"action":{"$ref":"#/components/schemas/rule_action"},"description":{"$ref":"#/components/schemas/rule_description"},"enabled":{"$ref":"#/components/schemas/rule_enabled"},"expression":{"$ref":"#/components/schemas/rule_expression"},"position":{"$ref":"#/components/schemas/rule_position"}},"required":["action","expression"]},"path":{"default":"/","description":"Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported.","example":"/shop/checkout","type":"string"},"path-I0p9X4oI":{"default":"/","description":"The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors.","example":"/health","type":"string"},"path-N56b8ntG":{"default":"/","description":"The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors.","example":"/health","type":"string"},"path_cookie_attribute":{"default":false,"description":"Enables cookie paths to scope an application's JWT to the application path. If disabled, the JWT will scope to the hostname by default","example":true,"type":"boolean"},"pattern":{"description":"A pattern that matches an entry","properties":{"regex":{"description":"The regex pattern.","example":"^4[0-9]{6,14}$","type":"string"},"validation":{"description":"Validation algorithm for the pattern. This algorithm will get run on potential matches, and if it returns false, the entry will not be matched.","enum":["luhn"],"example":"luhn","type":"string"}},"required":["regex"],"title":"Pattern","type":"object"},"pattern-prw776lg":{"example":"example.net/*","title":"Route pattern","type":"string"},"paused":{"default":false,"description":"Indicates whether the zone is only using Cloudflare DNS services. A\ntrue value means the zone will not receive security or performance\nbenefits.\n","readOnly":true,"type":"boolean"},"paused-jas4Z8f1":{"description":"When true, indicates that the WAF package is currently paused.","type":"boolean"},"pcaps_byte_limit":{"description":"The maximum number of bytes to capture. This field only applies to `full` packet captures.","example":500000,"maximum":1000000000,"minimum":1,"type":"number"},"pcaps_collection_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"anyOf":[{"$ref":"#/components/schemas/pcaps_response_simple"},{"$ref":"#/components/schemas/pcaps_response_full"}]},"type":"array"}}}]},"pcaps_colo_name":{"description":"The name of the data center used for the packet capture. This can be a specific colo (ord02) or a multi-colo name (ORD). This field only applies to `full` packet captures.","example":"ord02","type":"string"},"pcaps_destination_conf":{"description":"The full URI for the bucket. This field only applies to `full` packet captures.","example":"s3://pcaps-bucket?region=us-east-1","type":"string"},"pcaps_error_message":{"description":"An error message that describes why the packet capture failed. This field only applies to `full` packet captures.","example":"No packets matched the filter in the time limit given. Please modify the filter or try again.","type":"string"},"pcaps_filter_v1":{"description":"The packet capture filter. When this field is empty, all packets are captured.","properties":{"destination_address":{"description":"The destination IP address of the packet.","example":"1.2.3.4","type":"string"},"destination_port":{"description":"The destination port of the packet.","example":80,"type":"number"},"protocol":{"description":"The protocol number of the packet.","example":6,"type":"number"},"source_address":{"description":"The source IP address of the packet.","example":"1.2.3.4","type":"string"},"source_port":{"description":"The source port of the packet.","example":123,"type":"number"}},"type":"object"},"pcaps_id":{"description":"The ID for the packet capture.","example":"66802ca5668e47a2b82c2e6746e45037","maxLength":32,"minLength":32,"type":"string"},"pcaps_ownership_challenge":{"description":"The ownership challenge filename stored in the bucket.","example":"ownership-challenge-9883874ecac311ec8475433579a6bf5f.txt","type":"string"},"pcaps_ownership_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/pcaps_ownership_response"},"nullable":true,"type":"array"}}}]},"pcaps_ownership_request":{"properties":{"destination_conf":{"$ref":"#/components/schemas/pcaps_destination_conf"}},"required":["destination_conf"],"type":"object"},"pcaps_ownership_response":{"properties":{"destination_conf":{"$ref":"#/components/schemas/pcaps_destination_conf"},"filename":{"$ref":"#/components/schemas/pcaps_ownership_challenge"},"id":{"description":"The bucket ID associated with the packet captures API.","example":"9883874ecac311ec8475433579a6bf5f","maxLength":32,"minLength":32,"type":"string"},"status":{"description":"The status of the ownership challenge. Can be pending, success or failed.","enum":["pending","success","failed"],"example":"success","type":"string"},"submitted":{"description":"The RFC 3339 timestamp when the bucket was added to packet captures API.","example":"2020-01-01T08:00:00Z","type":"string"},"validated":{"description":"The RFC 3339 timestamp when the bucket was validated.","example":"2020-01-01T08:00:00Z","type":"string"}},"required":["id","status","submitted","destination_conf","filename"],"type":"object"},"pcaps_ownership_single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/pcaps_ownership_response"}}}]},"pcaps_ownership_validate_request":{"properties":{"destination_conf":{"$ref":"#/components/schemas/pcaps_destination_conf"},"ownership_challenge":{"$ref":"#/components/schemas/pcaps_ownership_challenge"}},"required":["destination_conf","ownership_challenge"],"type":"object"},"pcaps_packet_limit":{"description":"The limit of packets contained in a packet capture.","example":10000,"maximum":10000,"minimum":1,"type":"number"},"pcaps_request_full":{"properties":{"byte_limit":{"$ref":"#/components/schemas/pcaps_byte_limit"},"colo_name":{"$ref":"#/components/schemas/pcaps_colo_name"},"destination_conf":{"$ref":"#/components/schemas/pcaps_destination_conf"},"filter_v1":{"$ref":"#/components/schemas/pcaps_filter_v1"},"packet_limit":{"$ref":"#/components/schemas/pcaps_packet_limit"},"system":{"$ref":"#/components/schemas/pcaps_system"},"time_limit":{"$ref":"#/components/schemas/pcaps_time_limit"},"type":{"$ref":"#/components/schemas/pcaps_type"}},"required":["time_limit","type","system","colo_name","destination_conf"],"type":"object"},"pcaps_request_pcap":{"anyOf":[{"$ref":"#/components/schemas/pcaps_request_simple"},{"$ref":"#/components/schemas/pcaps_request_full"}]},"pcaps_request_simple":{"properties":{"filter_v1":{"$ref":"#/components/schemas/pcaps_filter_v1"},"packet_limit":{"$ref":"#/components/schemas/pcaps_packet_limit"},"system":{"$ref":"#/components/schemas/pcaps_system"},"time_limit":{"$ref":"#/components/schemas/pcaps_time_limit"},"type":{"$ref":"#/components/schemas/pcaps_type"}},"required":["time_limit","packet_limit","type","system"],"type":"object"},"pcaps_response_full":{"properties":{"byte_limit":{"$ref":"#/components/schemas/pcaps_byte_limit"},"colo_name":{"$ref":"#/components/schemas/pcaps_colo_name"},"destination_conf":{"$ref":"#/components/schemas/pcaps_destination_conf"},"error_message":{"$ref":"#/components/schemas/pcaps_error_message"},"filter_v1":{"$ref":"#/components/schemas/pcaps_filter_v1"},"id":{"$ref":"#/components/schemas/pcaps_id"},"status":{"$ref":"#/components/schemas/pcaps_status"},"submitted":{"$ref":"#/components/schemas/pcaps_submitted"},"system":{"$ref":"#/components/schemas/pcaps_system"},"time_limit":{"$ref":"#/components/schemas/pcaps_time_limit"},"type":{"$ref":"#/components/schemas/pcaps_type"}},"type":"object"},"pcaps_response_simple":{"properties":{"filter_v1":{"$ref":"#/components/schemas/pcaps_filter_v1"},"id":{"$ref":"#/components/schemas/pcaps_id"},"status":{"$ref":"#/components/schemas/pcaps_status"},"submitted":{"$ref":"#/components/schemas/pcaps_submitted"},"system":{"$ref":"#/components/schemas/pcaps_system"},"time_limit":{"$ref":"#/components/schemas/pcaps_time_limit"},"type":{"$ref":"#/components/schemas/pcaps_type"}},"type":"object"},"pcaps_single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"anyOf":[{"$ref":"#/components/schemas/pcaps_response_simple"},{"$ref":"#/components/schemas/pcaps_response_full"}]}}}]},"pcaps_status":{"description":"The status of the packet capture request.","enum":["unknown","success","pending","running","conversion_pending","conversion_running","complete","failed"],"example":"success","type":"string"},"pcaps_submitted":{"description":"The RFC 3339 timestamp when the packet capture was created.","example":"2020-01-01T08:00:00Z","type":"string"},"pcaps_system":{"description":"The system used to collect packet captures.","enum":["magic-transit"],"example":"magic-transit","type":"string"},"pcaps_time_limit":{"description":"The packet capture duration in seconds.","example":300,"maximum":300,"minimum":1,"type":"number"},"pcaps_type":{"description":"The type of packet capture. `Simple` captures sampled packets, and `full` captures entire payloads and non-sampled packets.","enum":["simple","full"],"example":"simple","type":"string"},"pctComplete":{"description":"Indicates the size of the entire upload in bytes. The value must be a non-negative integer.","maximum":100,"minimum":0,"readOnly":true,"type":"string"},"peer":{"properties":{"id":{"$ref":"#/components/schemas/components-schemas-identifier"},"ip":{"$ref":"#/components/schemas/ip-anO5UL8J"},"ixfr_enable":{"$ref":"#/components/schemas/ixfr_enable"},"name":{"$ref":"#/components/schemas/components-schemas-name-0v75iZSQ"},"port":{"$ref":"#/components/schemas/port"},"tsig_id":{"$ref":"#/components/schemas/tsig_id"}},"required":["id","name"],"type":"object"},"peers":{"description":"A list of peer tags.","example":["23ff594956f20c2a721606e94745a8aa","00920f38ce07c2e2f4df50b1f61d4194"],"items":{},"type":"array"},"pem":{"description":"The signing key in PEM format.","example":"LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQpNSUlFcGdJQkFBS0NBUUVBMFRqd2pPaVpXbUo0M3ZmM1RvNERvWG1YV3RKR05HeVhmaHl0dExhQmdGMStFUVdRCkRLaG9LYm9hS21xakNBc21za3V0YkxVN1BVOGRrUU5ER1p3S3VWczA4elNaNGt4aTR0RWdQUFp5dDdkWEMrbFkKUllveXJBR0Y0QVhoeTMyOWJIQ1AxSWxyQkIvQWtHZ25kTEFndW54WTByUmdjdk96aWF3NktKeEZuYzJVSzBXVQo4YjBwNEtLSEdwMUtMOWRrMFdUOGRWWXFiZVJpSmpDbFVFbWg4eXY5Q2xPVmFTNEt4aVg2eFRRNERadzZEYUpmCklWM1F0Tmd2cG1ieWxOSmFQSG5zc3JodDJHS1A5NjJlS2poUVJsaWd2SFhKTE9uSm9KZkxlSUVIWitpeFdmY1QKRE1IOTJzR3ZvdzFET2p4TGlDTjF6SEsraDdiTG9YVGlMZ2M0a3dJREFRQUJBb0lCQVFEQ0lCclNJMTlteGNkdwoycExVaUdCR0N4T3NhVDVLbGhkYUpESG9ZdzUxbEVuTWNXVGUyY01NTkdqaXdsN1NyOFlQMkxmcERaOFJtNzdMCk5rT2tGMnk3M3l5YUhFeEw5S1FyMys0Um9ubCtqTlp2YnV0QVdxSDVodEE0dER4MUd3NE85OEg4YWlTcGh1eWQKRUliTGRrQm54OGlDZUdxbFBnbHZ6Q1dLV0xVZlhGbXplMkF5UjBzaWMyYXZRLzZyclYwb3pDdGQ1T0Vod093agphaCs3N1dZV1l0bkEraDhXZVZreWcvdG44UTJJOXo5ZVJYdlZxR2sxMDZLcWRtZFdiU2tIZzA4cFRUSGhVM2paCnMvZGNjdEdOMWFFanlUQWY0QzdHT2lrcUd1MGFTaW1aeDFOM2RWQzBobngySjJtdlhNQ0VtZ0g3TjVnZUxWUFAKOWdkQjdBQkJBb0dCQU5sT2hGQVhaTHV6Y0Ftczl1K3AxM05STWRFOHpIK2ZFaFBrbk9zZ21Xb3VqUzkxQTRtZgpuK01oN3d5bTZoVU1DbDk2WUNMNGtPM0RUMmlYWlRqTXZuMHBoVEx1MXNYcGxWNDJuamRnZGd3cFBEM0FnL1Y5ClVvV2hxdVhoa1I3RFpsUGg5Nmk1aEE0M1BvbTVPQm9BektJbEcrT3ZKUkhhZEVveC9jSmZScFd2QW9HQkFQWjUKNnNmWDdESElCNEtBczRmMWRuNGZJUkMweUF2WVdCL1R3UzZHUWVoNFRFbDVuSkQwWk9ZRVdUbVVBK3pPanZTNApuM09tZ2xNQTU5SGd1ZW13QXVRcEtwWFBOcFUvTERJaThtNnpmTUpvL3E5M0NOQlFQZngzZGh4ZVh4OXE2Mzg3Cm84QWxkOE42RGs4TThjRis3SlNaeUVJODJzLzdpdGRseXA2bFdLaGRBb0dCQUtnU0VrUGYxQWxZdjA2OGVFRGwKRzc0VkRuTEdrMlFobzltKzk1N2psOFNJUEtwMzFrU2JNUTU3TUdpWXNIT1czRzc4TjE3VTRVTUR6R2NZc1RFOQpLaGVrQldGZldMMjU2OHp5Y1d4akx1bzQrbDdJaDBkWHBudTBqbms5L1AvT0lWYS9iczBRcnhKUHFBN2RNb2JxCkYxdFJXRURCTmVxWkMxaFhVZTBEdzVRQkFvR0JBSjdBQ2NNcnhKcVBycDZVakkyK1FOS2M5Q3dSZEdPRXRjWFMKR3JQL2owWE83YnZKVTFsZHYvc1N3L0U4NzRZL3lIM0F5QnF5SFhDZXZiRkZZQmt1MzczYThlM0pwK3RhNC9scQozdUVFUkEvbmxscW5mWXJHbEJZZlQzaVlKQVpWVkZiL3I4bWJtRmJVTDVFazBqV0JyWmxNcjFwU1hkRGx3QmhhCkhMWXY0em1WQW9HQkFLQmw0cFNnbkNSTEJMUU9jWjhXQmhRSjAwZDZieFNrTGNpZ0xUNFJvY3RwNTY1SHJPMDAKSVFLdElTaEg1a2s3SVRHdUYvOERXZEN2djBMYnhvZVBJc2NFaStTaXk5WDZwWENPaS8xa2FyYVU5U3BpZ3czago3YjVlUVV0UlovTkIycVJwc3EzMEdCUENqanhudEVmK2lqelhUS0xNRndyUDhBMTlQNzRONGVTMAotLS0tLUVORCBSU0EgUFJJVkFURSBLRVktLS0tLQo=","readOnly":true,"type":"string"},"per_page":{"default":20,"description":"Maximum number of results per page.","maximum":50,"minimum":5,"type":"number"},"period":{"description":"The time in seconds (an integer value) to count matching traffic. If the count exceeds the configured threshold within this period, Cloudflare will perform the configured action.","example":900,"maximum":86400,"minimum":10,"type":"number"},"period_seconds":{"description":"The period over which this threshold is suggested.","readOnly":true,"type":"integer"},"permission_group":{"description":"A named group of permissions that map to a group of operations against resources.","properties":{"id":{"description":"Identifier of the group.","example":"6d7f2f5f5b1d4a0e9081fdc98d432fd1","readOnly":true,"type":"string"},"name":{"description":"Name of the group.","example":"Load Balancers Write","readOnly":true,"type":"string"}},"required":["id"],"type":"object"},"permission_groups":{"description":"A set of permission groups that are specified to the policy.","example":[{"id":"c8fed203ed3043cba015a93ad1616f1f","name":"Zone Read"},{"id":"82e64a83756745bbbb1c9c2701bf816b","name":"DNS Read"}],"items":{"$ref":"#/components/schemas/permission_group"},"type":"array"},"permissions":{"example":{"analytics":{"read":true,"write":false},"zones":{"read":true,"write":true}},"properties":{"analytics":{"$ref":"#/components/schemas/grants"},"billing":{"$ref":"#/components/schemas/grants"},"cache_purge":{"$ref":"#/components/schemas/grants"},"dns":{"$ref":"#/components/schemas/grants"},"dns_records":{"$ref":"#/components/schemas/grants"},"lb":{"$ref":"#/components/schemas/grants"},"logs":{"$ref":"#/components/schemas/grants"},"organization":{"$ref":"#/components/schemas/grants"},"ssl":{"$ref":"#/components/schemas/grants"},"waf":{"$ref":"#/components/schemas/grants"},"zone_settings":{"$ref":"#/components/schemas/grants"},"zones":{"$ref":"#/components/schemas/grants"}},"type":"object"},"phase":{"description":"The phase of the ruleset.","example":"http_request_firewall_managed","pattern":"^[a-z_]+$","type":"string"},"phishing-url-info":{"properties":{"categorizations":{"description":"List of categorizations applied to this submission.","items":{"properties":{"category":{"description":"Name of the category applied.","example":"PHISHING","type":"string"},"verification_status":{"description":"Result of human review for this categorization.","example":"confirmed","type":"string"}},"type":"object"},"type":"array"},"model_results":{"description":"List of model results for completed scans.","items":{"properties":{"model_name":{"description":"Name of the model.","example":"MACHINE_LEARNING_v2","type":"string"},"model_score":{"description":"Score output by the model for this submission.","example":0.024,"type":"number"}},"type":"object"},"type":"array"},"rule_matches":{"description":"List of signatures that matched against site content found when crawling the URL.","items":{"properties":{"banning":{"description":"For internal use.","type":"boolean"},"blocking":{"description":"For internal use.","type":"boolean"},"description":{"description":"Description of the signature that matched.","example":"Match frequently used social followers phishing kit","type":"string"},"name":{"description":"Name of the signature that matched.","example":"phishkit.social_followers","type":"string"}},"type":"object"},"type":"array"},"scan_status":{"description":"Status of the most recent scan found.","properties":{"last_processed":{"description":"Timestamp of when the submission was processed.","example":"Wed, 26 Oct 2022 16:04:51 GMT","type":"string"},"scan_complete":{"description":"For internal use.","type":"boolean"},"status_code":{"description":"Status code that the crawler received when loading the submitted URL.","type":"integer"},"submission_id":{"description":"ID of the most recent submission.","type":"integer"}},"type":"object"},"screenshot_download_signature":{"description":"For internal use.","type":"string"},"screenshot_path":{"description":"For internal use.","type":"string"},"url":{"description":"URL that was submitted.","example":"https://www.cloudflare.com","type":"string"}}},"phishing-url-info_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/phishing-url-info"}}}]},"phishing-url-submit":{"properties":{"excluded_urls":{"description":"URLs that were excluded from scanning because their domain is in our no-scan list.","items":{"properties":{"url":{"description":"URL that was excluded.","example":"https://developers.cloudflare.com","type":"string"}},"type":"object"},"type":"array"},"skipped_urls":{"description":"URLs that were skipped because the same URL is currently being scanned","items":{"properties":{"url":{"description":"URL that was skipped.","example":"https://www.cloudflare.com/developer-week/","type":"string"},"url_id":{"description":"ID of the submission of that URL that is currently scanning.","example":2,"type":"integer"}},"type":"object"},"type":"array"},"submitted_urls":{"description":"URLs that were successfully submitted for scanning.","items":{"properties":{"url":{"description":"URL that was submitted.","example":"https://www.cloudflare.com","type":"string"},"url_id":{"description":"ID assigned to this URL submission. Used to retrieve scanning results.","example":1,"type":"integer"}},"type":"object"},"type":"array"}}},"phishing-url-submit_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/phishing-url-submit"}}}]},"pingone":{"allOf":[{"$ref":"#/components/schemas/identity-provider"},{"properties":{"config":{"allOf":[{"$ref":"#/components/schemas/generic-oauth-config"},{"properties":{"ping_env_id":{"description":"Your PingOne environment identifier","example":"342b5660-0c32-4936-a5a4-ce21fae57b0a","type":"string"}},"type":"object"}]}},"type":"object"}],"title":"PingOne","type":"object"},"plan_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/schemas-rate-plan"},"type":"array"}},"type":"object"}]},"platform":{"enum":["windows","mac","linux","android","ios"],"example":"windows","type":"string"},"playback":{"properties":{"dash":{"description":"DASH Media Presentation Description for the video.","example":"https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/manifest/video.mpd","readOnly":true,"type":"string"},"hls":{"description":"The HLS manifest for the video.","example":"https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/manifest/video.m3u8","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"},"playback_rtmps":{"description":"Details for playback from an live input using RTMPS.","properties":{"streamKey":{"$ref":"#/components/schemas/playback_rtmps_stream_key"},"url":{"$ref":"#/components/schemas/playback_rtmps_url"}},"type":"object"},"playback_rtmps_stream_key":{"description":"The secret key to use for playback via RTMPS.","example":"2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada","readOnly":true,"type":"string"},"playback_rtmps_url":{"description":"The URL used to play live video over RTMPS.","example":"rtmps://live.cloudflare.com:443/live/","readOnly":true,"type":"string"},"playback_srt":{"description":"Details for playback from an live input using SRT.","properties":{"passphrase":{"$ref":"#/components/schemas/playback_srt_stream_passphrase"},"streamId":{"$ref":"#/components/schemas/playback_srt_stream_id"},"url":{"$ref":"#/components/schemas/playback_srt_url"}},"type":"object"},"playback_srt_stream_id":{"description":"The identifier of the live input to use for playback via SRT.","example":"f256e6ea9341d51eea64c9454659e576","readOnly":true,"type":"string"},"playback_srt_stream_passphrase":{"description":"The secret key to use for playback via SRT.","example":"2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada","readOnly":true,"type":"string"},"playback_srt_url":{"description":"The URL used to play live video over SRT.","example":"rtmps://live.cloudflare.com:443/live/","readOnly":true,"type":"string"},"playback_webrtc":{"description":"Details for playback from a live input using WebRTC.","properties":{"url":{"$ref":"#/components/schemas/playback_webrtc_url"}},"type":"object"},"playback_webrtc_url":{"description":"The URL used to play live video over WebRTC.","example":"https://customer-m033z5x00ks6nunl.cloudflarestream.com/b236bde30eb07b9d01318940e5fc3edake34a3efb3896e18f2dc277ce6cc993ad/webRTC/play","readOnly":true,"type":"string"},"policies":{"properties":{"approval_groups":{"$ref":"#/components/schemas/approval_groups"},"approval_required":{"$ref":"#/components/schemas/approval_required"},"created_at":{"$ref":"#/components/schemas/timestamp"},"decision":{"$ref":"#/components/schemas/decision"},"exclude":{"$ref":"#/components/schemas/schemas-exclude"},"id":{"$ref":"#/components/schemas/components-schemas-uuid"},"include":{"$ref":"#/components/schemas/include"},"name":{"$ref":"#/components/schemas/policies_components-schemas-name"},"precedence":{"$ref":"#/components/schemas/precedence-GXhj5toi"},"purpose_justification_prompt":{"$ref":"#/components/schemas/purpose_justification_prompt"},"purpose_justification_required":{"$ref":"#/components/schemas/purpose_justification_required"},"require":{"$ref":"#/components/schemas/schemas-require"},"updated_at":{"$ref":"#/components/schemas/timestamp"}},"type":"object"},"policies-iecjppBc":{"description":"List of access policies assigned to the token.","items":{"$ref":"#/components/schemas/access-policy"},"type":"array"},"policies_components-schemas-description":{"description":"Optional description for the Notification policy.","example":"Something describing the policy.","type":"string"},"policies_components-schemas-enabled":{"default":true,"description":"Whether or not the Notification policy is enabled.","example":true,"type":"boolean"},"policies_components-schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/components-schemas-uuid"}},"type":"object"}}}]},"policies_components-schemas-id_response-2":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/uuid-s0SXln0q"}},"type":"object"}}}]},"policies_components-schemas-name":{"description":"The name of the Access policy.","example":"Allow devs","type":"string"},"policies_components-schemas-name-2":{"description":"Name of the policy.","example":"SSL Notification Event Policy","type":"string"},"policies_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/policies"},"type":"array"}}}]},"policies_components-schemas-response_collection-2":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/components-schemas-policies"},"type":"array"}}}]},"policies_components-schemas-response_collection-MqgLqMjN":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/schemas-policies"},"type":"array"}}}]},"policies_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/policies"}}}]},"policies_components-schemas-single_response-2":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/components-schemas-policies"}}}]},"policies_components-schemas-single_response-XqehVx27":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/schemas-policies"}}}]},"policy":{"description":"Specify the policy that determines the region where your private key will be held locally. HTTPS connections to any excluded data center will still be fully encrypted, but will incur some latency while Keyless SSL is used to complete the handshake with the nearest allowed data center. Any combination of countries, specified by their two letter country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) can be chosen, such as 'country: IN', as well as 'region: EU' which refers to the EU region. If there are too few data centers satisfying the policy, it will be rejected.","example":"(country: US) or (region: EU)","type":"string"},"policy_check_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"app_state":{"properties":{"app_uid":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"},"aud":{"example":"737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe389","type":"string"},"hostname":{"example":"test.com","type":"string"},"name":{"example":"Test App","type":"string"},"policies":{"example":[{"decision":"allow","exclude":[],"include":[{"_type":"email","email":"testuser@gmail.com"}],"precedence":0,"require":[],"status":"Success"}],"items":{},"type":"array"},"status":{"example":"Success","type":"string"}},"type":"object"},"user_identity":{"properties":{"account_id":{"example":"41ecfbb341f033e52b46742756aabb8b","type":"string"},"device_sessions":{"example":{},"type":"object"},"email":{"example":"testuser@gmail.com","type":"string"},"geo":{"properties":{"country":{"example":"US","type":"string"}},"type":"object"},"iat":{"type":"integer"},"id":{"example":"1164449231815010287495","type":"string"},"is_gateway":{"example":false,"type":"boolean"},"is_warp":{"example":false,"type":"boolean"},"name":{"example":"Test User","type":"string"},"user_uuid":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"},"version":{"type":"integer"}},"type":"object"}},"type":"object"}}}]},"policy_check_response-nLfQoCS8":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"app_state":{"properties":{"app_uid":{"$ref":"#/components/schemas/uuid-s0SXln0q"},"aud":{"example":"737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe389","type":"string"},"hostname":{"example":"test.com","type":"string"},"name":{"example":"Test App","type":"string"},"policies":{"example":[{"decision":"allow","exclude":[],"include":[{"_type":"email","email":"testuser@gmail.com"}],"precedence":0,"require":[],"status":"Success"}],"items":{},"type":"array"},"status":{"example":"Success","type":"string"}},"type":"object"},"user_identity":{"properties":{"account_id":{"example":"41ecfbb341f033e52b46742756aabb8b","type":"string"},"device_sessions":{"example":{},"type":"object"},"email":{"example":"testuser@gmail.com","type":"string"},"geo":{"properties":{"country":{"example":"US","type":"string"}},"type":"object"},"iat":{"type":"integer"},"id":{"example":"1164449231815010287495","type":"string"},"is_gateway":{"example":false,"type":"boolean"},"is_warp":{"example":false,"type":"boolean"},"name":{"example":"Test User","type":"string"},"user_uuid":{"$ref":"#/components/schemas/uuid-s0SXln0q"},"version":{"type":"integer"}},"type":"object"}},"type":"object"}}}]},"policy_with_permission_groups":{"properties":{"effect":{"$ref":"#/components/schemas/effect"},"id":{"$ref":"#/components/schemas/identifier-ECDhGQVO"},"permission_groups":{"$ref":"#/components/schemas/permission_groups"},"resources":{"$ref":"#/components/schemas/resources"}},"required":["id","effect","resources","permission_groups"],"title":"policy_with_permission_groups"},"polish":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["polish"],"example":"polish"},"value":{"$ref":"#/components/schemas/polish_value"}}}],"description":"Removes metadata and compresses your images for faster page load times. Basic (Lossless): Reduce the size of PNG, JPEG, and GIF files - no impact on visual quality. Basic + JPEG (Lossy): Further reduce the size of JPEG files for faster image loading. Larger JPEGs are converted to progressive images, loading a lower-resolution image first and ending in a higher-resolution version. Not recommended for hi-res photography sites.","title":"Polish Image Optimization"},"polish_value":{"default":"off","description":"Value of the zone setting.","enum":["off","lossless","lossy"],"type":"string"},"pool":{"properties":{"check_regions":{"$ref":"#/components/schemas/check_regions-fqlLEr38"},"created_on":{"$ref":"#/components/schemas/timestamp"},"description":{"$ref":"#/components/schemas/pool_components-schemas-description"},"disabled_at":{"$ref":"#/components/schemas/schemas-disabled_at"},"enabled":{"$ref":"#/components/schemas/pool_components-schemas-enabled"},"id":{"$ref":"#/components/schemas/pool_components-schemas-identifier"},"latitude":{"$ref":"#/components/schemas/latitude"},"load_shedding":{"$ref":"#/components/schemas/load_shedding"},"longitude":{"$ref":"#/components/schemas/longitude"},"minimum_origins":{"$ref":"#/components/schemas/minimum_origins"},"modified_on":{"$ref":"#/components/schemas/timestamp"},"monitor":{"$ref":"#/components/schemas/schemas-monitor"},"name":{"$ref":"#/components/schemas/pool_components-schemas-name"},"notification_email":{"$ref":"#/components/schemas/notification_email"},"notification_filter":{"$ref":"#/components/schemas/notification_filter"},"origin_steering":{"$ref":"#/components/schemas/origin_steering"},"origins":{"$ref":"#/components/schemas/origins"}},"type":"object"},"pool-Dw5V2rGp":{"properties":{"check_regions":{"$ref":"#/components/schemas/check_regions-q46IR1gk"},"created_on":{"$ref":"#/components/schemas/timestamp"},"description":{"$ref":"#/components/schemas/schemas-description-XvtZaN2T"},"disabled_at":{"$ref":"#/components/schemas/schemas-disabled_at"},"enabled":{"$ref":"#/components/schemas/enabled-WoQtkwsn"},"id":{"$ref":"#/components/schemas/schemas-identifier-LDS3pdXe"},"latitude":{"$ref":"#/components/schemas/latitude"},"load_shedding":{"$ref":"#/components/schemas/load_shedding"},"longitude":{"$ref":"#/components/schemas/longitude"},"minimum_origins":{"$ref":"#/components/schemas/minimum_origins"},"modified_on":{"$ref":"#/components/schemas/timestamp"},"monitor":{"$ref":"#/components/schemas/schemas-monitor"},"name":{"$ref":"#/components/schemas/name-Pky1OOiR"},"notification_email":{"$ref":"#/components/schemas/notification_email"},"notification_filter":{"$ref":"#/components/schemas/notification_filter"},"origin_steering":{"$ref":"#/components/schemas/origin_steering"},"origins":{"$ref":"#/components/schemas/origins-BzaDTSuG"}},"type":"object"},"pool_components-schemas-description":{"description":"A human-readable description of the pool.","example":"Primary data center - Provider XYZ","type":"string"},"pool_components-schemas-enabled":{"default":true,"description":"Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).","example":false,"type":"boolean"},"pool_components-schemas-identifier":{"example":"17b5962d775c646f3f9725cbc7a53df4"},"pool_components-schemas-name":{"description":"A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.","example":"primary-dc-1","type":"string"},"pool_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/pool"},"type":"array"}}}]},"pool_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/pool"}}}]},"pool_name":{"description":"The name for the pool to filter.","example":"primary-dc","type":"string"},"pop_pools":{"description":"(Enterprise only): A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding country_pool, then region_pool mapping if it exists else to default_pools.","example":{"LAX":["de90f38ced07c2e2f4df50b1f61d4194","9290f38c5d07c2e2f4df57b1f61d4196"],"LHR":["abd90f38ced07c2e2f4df50b1f61d4194","f9138c5d07c2e2f4df57b1f61d4196"],"SJC":["00920f38ce07c2e2f4df50b1f61d4194"]},"type":"object"},"popularity_rank":{"description":"Global Cloudflare 100k ranking for the last 30 days, if available for the hostname. The top ranked domain is 1, the lowest ranked domain is 100,000.","type":"integer"},"port":{"description":"DNS port of primary or secondary nameserver, depending on what zone this peer is linked to.","example":53,"type":"number"},"port-0Rcq4sy6":{"default":24008,"description":"The keyless SSL port used to commmunicate between Cloudflare and the client's Keyless SSL server.","example":24008,"maxLength":65535,"type":"number"},"port-WXwz9tIV":{"default":0,"description":"Port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).","type":"integer"},"port-z0PISaVA":{"default":24008,"description":"The keyless SSL port used to communicate between Cloudflare and the client's Keyless SSL server.","example":24008,"maxLength":65535,"type":"number"},"position":{"default":"upperRight","description":"The location of the image. Valid positions are: `upperRight`, `upperLeft`, `lowerLeft`, `lowerRight`, and `center`. Note that `center` ignores the `padding` parameter.","example":"center","readOnly":true,"type":"string"},"precedence":{"description":"Precedence sets the ordering of the rules. Lower values indicate higher precedence. At each processing phase, applicable rules are evaluated in ascending order of this value.","type":"integer"},"precedence-3goMFnFD":{"description":"The order of execution for this policy. Must be unique for each policy.","type":"integer"},"precedence-GXhj5toi":{"description":"The order of execution for this policy. Must be unique for each policy.","type":"integer"},"precedence-HZLvpi3q":{"description":"The precedence of the policy. Lower values indicate higher precedence. Policies will be evaluated in ascending order of this field.","example":100,"type":"number"},"predefined_entry":{"description":"A predefined entry that matches a profile","properties":{"enabled":{"description":"Whether the entry is enabled or not.","example":true,"type":"boolean"},"id":{"$ref":"#/components/schemas/entry_id-A2p6ZYit"},"name":{"description":"The name of the entry.","example":"Credit card (Visa)","type":"string"},"profile_id":{"description":"ID of the parent profile"}},"title":"Predefined entry","type":"object"},"predefined_profile":{"properties":{"allowed_match_count":{"$ref":"#/components/schemas/allowed_match_count"},"entries":{"description":"The entries for this profile.","items":{"$ref":"#/components/schemas/predefined_entry"},"type":"array"},"id":{"$ref":"#/components/schemas/profile_id-JwqwymCp"},"name":{"description":"The name of the profile.","example":"Generic CVV Card Number","type":"string"},"type":{"description":"The type of the profile.","enum":["predefined"],"example":"predefined","type":"string"}},"title":"Predefined profile","type":"object"},"predefined_profile_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/predefined_profile"}]}}}]},"prefetch_preload":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["prefetch_preload"],"example":"prefetch_preload"},"value":{"$ref":"#/components/schemas/prefetch_preload_value"}}}],"default":"off","description":"Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones.","title":"Prefetch preload"},"prefetch_preload_value":{"default":"off","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"prefix":{"description":"IP Prefix in Classless Inter-Domain Routing format.","example":"192.0.2.0/24","type":"string"},"preview":{"description":"The video's preview page URI. This field is omitted until encoding is complete.","example":"https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/watch","format":"uri","readOnly":true,"type":"string"},"preview_id":{"example":"f1aba936b94213e5b8dca0c0dbf1f9cc"},"preview_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"preview_url":{"$ref":"#/components/schemas/preview_url"}},"type":"object"}}}]},"preview_response-Cnz4PS5L":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"pools":{"additionalProperties":true,"example":{"abwlnp5jbqn45ecgxd03erbgtxtqai0d":"WNAM Datacenter","ve8h9lrcip5n5bbga9yqmdws28ay5d0l":"EEU Datacenter"},"type":"object","x-patternProperties":{"^[a-z0-9]{32}$":{"type":"string"}}},"preview_id":{"$ref":"#/components/schemas/monitor_components-schemas-identifier"}},"type":"object"}}}]},"preview_response-ZWQ9Fl0k":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"pools":{"additionalProperties":{"description":"The pool name associated with the pool ID.","type":"string"},"description":"Monitored pool IDs mapped to their respective names.","example":{"abwlnp5jbqn45ecgxd03erbgtxtqai0d":"WNAM Datacenter","ve8h9lrcip5n5bbga9yqmdws28ay5d0l":"EEU Datacenter"},"type":"object"},"preview_id":{"$ref":"#/components/schemas/identifier-FZThz4k7"}},"type":"object"}}}]},"preview_result":{"additionalProperties":true,"description":"Resulting health data from a preview operation.","example":{"abwlnp5jbqn45ecgxd03erbgtxtqai0d":{"healthy":true,"origins":[{"originone.example.com.":{"$ref":"#/components/schemas/origin_health_data/example"}}]}},"type":"object"},"preview_result-FY42S4cy":{"additionalProperties":{"properties":{"healthy":{"type":"boolean"},"origins":{"items":{"additionalProperties":{"$ref":"#/components/schemas/origin_health_data"},"maxProperties":1,"minProperties":1,"type":"object"},"type":"array"}},"type":"object"},"description":"Resulting health data from a preview operation.","example":{"abwlnp5jbqn45ecgxd03erbgtxtqai0d":{"healthy":true,"origins":[{"originone.example.com.":{"failure_reason":"No failures","healthy":true,"response_code":200,"rtt":"66ms"}}]}},"type":"object"},"preview_result_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/preview_result"}]},"preview_result_response-181bkyJU":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/preview_result-FY42S4cy"}}}]},"preview_url":{"description":"URL where the custom waiting room page can temporarily be previewed.","example":"http://waitingrooms.dev/preview/35af8c12-6d68-4608-babb-b53435a5ddfb","type":"string"},"price":{"description":"The price of the subscription that will be billed, in US dollars.","example":20,"readOnly":true,"type":"number"},"priority":{"description":"Priority of the static route.","type":"integer"},"priority-21tFu5p5":{"default":1,"description":"The priority of the rule, used to define which Page Rule is processed over another. A higher number indicates a higher priority. For example, if you have a catch-all Page Rule (rule A: `/images/*`) but want a more specific Page Rule to take precedence (rule B: `/images/special/*`), specify a higher priority for rule B so it overrides rule A.","type":"integer"},"priority-Cl6RAKfI":{"default":20,"description":"The order/priority in which the certificate will be used in a request. The higher priority will break ties across overlapping 'legacy_custom' certificates, but 'legacy_custom' certificates will always supercede 'sni_custom' certificates.","example":1,"type":"number"},"priority-eLZLlpCp":{"default":20,"description":"The order/priority in which the certificate will be used in a request. The higher priority will break ties across overlapping 'legacy_custom' certificates, but 'legacy_custom' certificates will always supercede 'sni_custom' certificates.","example":1,"type":"number"},"priority-hJRwn9f1":{"description":"Required for MX, SRV and URI records; unused by other record types. Records with lower priorities are preferred.","example":10,"maximum":65535,"minimum":0,"type":"number"},"privacy":{"description":"Privacy option controls redacting WHOIS information.","example":true,"type":"boolean"},"privacy_pass":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["privacy_pass"],"example":"privacy_pass"},"value":{"$ref":"#/components/schemas/privacy_pass_value"}}}],"description":"Privacy Pass is a browser extension developed by the Privacy Pass Team to improve the browsing experience for your visitors. Enabling Privacy Pass will reduce the number of CAPTCHAs shown to your visitors. (https://support.cloudflare.com/hc/en-us/articles/115001992652-Privacy-Pass).","title":"Privacy Pass"},"privacy_pass_value":{"default":"on","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"private_key":{"description":"The zone's private key.","example":"-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n","type":"string"},"probe_zone":{"description":"Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors.","example":"example.com","type":"string"},"products":{"items":{"description":"A list of products to bypass for a request when using the `bypass` action.","enum":["zoneLockdown","uaBlock","bic","hot","securityLevel","rateLimit","waf"],"example":"waf","type":"string"},"type":"array"},"profile_id":{"allOf":[{"$ref":"#/components/schemas/uuid-lbOWhPVX"}],"description":"The ID for this profile","example":"384e129d-25bd-403c-8019-bc19eb7a8a5f"},"profile_id-JwqwymCp":{"allOf":[{"$ref":"#/components/schemas/uuid-s0SXln0q"}],"description":"The ID for this profile","example":"384e129d-25bd-403c-8019-bc19eb7a8a5f"},"profiles":{"anyOf":[{"$ref":"#/components/schemas/predefined_profile"},{"$ref":"#/components/schemas/custom_profile"},{"$ref":"#/components/schemas/integration_profile"}]},"profiles-JBe4cw2h":{"anyOf":[{"$ref":"#/components/schemas/predefined_profile"},{"$ref":"#/components/schemas/custom_profile"}]},"profiles_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/profiles-JBe4cw2h"},"type":"array"}}}]},"project-patch":{"example":{"deployment_configs":{"production":{"compatibility_date":"2022-01-01","compatibility_flags":["url_standard"],"env_vars":{"BUILD_VERSION":{"value":"3.3"},"delete_this_env_var":null,"secret_var":{"type":"secret_text","value":"A_CMS_API_TOKEN"}}}}}},"project-response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/projects"}}}]},"project_name":{"description":"Name of the project.","example":"this-is-my-project-01","pattern":"^[a-z0-9][a-z0-9-]*$","type":"string"},"projects":{"properties":{"build_config":{"$ref":"#/components/schemas/build_config"},"canonical_deployment":{"description":"Most recent deployment to the repo.","oneOf":[{"nullable":true},{"$ref":"#/components/schemas/deployments"}],"readOnly":true},"created_on":{"description":"When the project was created.","example":"2017-01-01T00:00:00Z","format":"date-time","readOnly":true,"type":"string"},"deployment_configs":{"$ref":"#/components/schemas/deployment_configs"},"domains":{"description":"A list of associated custom domains for the project.","example":["customdomain.com","customdomain.org"],"items":{},"readOnly":true,"type":"array"},"id":{"description":"Id of the project.","example":"7b162ea7-7367-4d67-bcde-1160995d5","readOnly":true,"type":"string"},"latest_deployment":{"description":"Most recent deployment to the repo.","oneOf":[{"nullable":true},{"$ref":"#/components/schemas/deployments"}],"readOnly":true},"name":{"description":"Name of the project.","example":"NextJS Blog","type":"string"},"production_branch":{"description":"Production branch of the project. Used to identify production deployments.","example":"main","type":"string"},"source":{"readOnly":true},"subdomain":{"description":"The Cloudflare subdomain associated with the project.","example":"helloworld.pages.dev","readOnly":true,"type":"string"}},"type":"object"},"projects-response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result_info":{"properties":{"count":{"example":1},"page":{"example":1},"per_page":{"example":100},"total_count":{"example":1}},"type":"object"}}},{"properties":{"result":{"items":{"$ref":"#/components/schemas/deployments"},"type":"array"}}}]},"properties":{"description":"Requests information about certain properties.","example":["auth_id_characteristics"],"items":{"enum":["auth_id_characteristics"],"example":"auth_id_characteristics","type":"string"},"type":"array","uniqueItems":true},"properties-name":{"description":"Account name","example":"Demo Account","maxLength":100,"type":"string"},"protocol":{"description":"The port configuration at Cloudflare’s edge. May specify a single port, for example `\"tcp/1000\"`, or a range of ports, for example `\"tcp/1000-2000\"`.","example":"tcp/22","type":"string"},"provider_name":{"description":"The name of provider. Usually cloudflare.","example":"Cloudflare","type":"string"},"proxied":{"description":"Whether the record is receiving the performance and security benefits of Cloudflare.","example":false,"type":"boolean"},"proxied-ZGed5Tdg":{"default":false,"description":"Whether the hostname should be gray clouded (false) or orange clouded (true).","example":true,"type":"boolean"},"proxied-ZJJb2RTk":{"default":false,"description":"Whether the hostname should be gray clouded (false) or orange clouded (true).","example":true,"type":"boolean"},"proxy-endpoints":{"properties":{"created_at":{"$ref":"#/components/schemas/timestamp"},"id":{"$ref":"#/components/schemas/schemas-uuid"},"ips":{"$ref":"#/components/schemas/ips"},"name":{"$ref":"#/components/schemas/proxy-endpoints_components-schemas-name"},"subdomain":{"$ref":"#/components/schemas/schemas-subdomain"},"updated_at":{"$ref":"#/components/schemas/timestamp"}},"type":"object"},"proxy-endpoints_components-schemas-name":{"description":"The name of the Proxy Endpoint.","example":"Devops team","type":"string"},"proxy-endpoints_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/proxy-endpoints"},"type":"array"}}}]},"proxy-endpoints_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/proxy-endpoints"}}}]},"proxy_protocol":{"default":"off","description":"Enables Proxy Protocol to the origin. Refer to [Enable Proxy protocol](https://developers.cloudflare.com/spectrum/getting-started/proxy-protocol/) for implementation details on PROXY Protocol V1, PROXY Protocol V2, and Simple Proxy Protocol.","enum":["off","v1","v2","simple"],"example":"off","type":"string"},"proxy_read_timeout":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["proxy_read_timeout"],"example":"proxy_read_timeout"},"value":{"$ref":"#/components/schemas/proxy_read_timeout_value"}}}],"description":"Maximum time between two read operations from origin.","title":"Proxy Read Timeout"},"proxy_read_timeout_value":{"default":100,"description":"Value of the zone setting.\nNotes: Value must be between 1 and 6000","type":"number"},"pseudo_ipv4":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"default":"pseudo_ipv4","description":"Value of the Pseudo IPv4 setting.","enum":["pseudo_ipv4"]},"value":{"$ref":"#/components/schemas/pseudo_ipv4_value"}}}],"description":"The value set for the Pseudo IPv4 setting.","title":"Pseudo IPv4 Value"},"pseudo_ipv4_value":{"default":"off","description":"Value of the Pseudo IPv4 setting.","enum":["off","add_header","overwrite_header"],"type":"string"},"psk":{"description":"A randomly generated or provided string for use in the IPsec tunnel.","example":"O3bwKSjnaoCxDoUxjcq4Rk8ZKkezQUiy","type":"string"},"psk_generation_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"ipsec_tunnel_id":{"$ref":"#/components/schemas/identifier-5dNKLCP5"},"psk":{"$ref":"#/components/schemas/psk"},"psk_metadata":{"$ref":"#/components/schemas/psk_metadata"}}}}}]},"psk_metadata":{"description":"The PSK metadata that includes when the PSK was generated.","properties":{"last_generated_on":{"$ref":"#/components/schemas/schemas-modified_on"}},"type":"object"},"public_key":{"description":"Public key for DS record.","example":"oXiGYrSTO+LSCJ3mohc8EP+CzF9KxBj8/ydXJ22pKuZP3VAC3/Md/k7xZfz470CoRyZJ6gV6vml07IC3d8xqhA==","nullable":true,"readOnly":true,"type":"string"},"public_key-Qrh0Mu1M":{"description":"The public key to add to your SSH server configuration.","example":"ecdsa-sha2-nistp256 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= open-ssh-ca@cloudflareaccess.org","readOnly":true,"type":"string"},"public_key-xgmH3SVX":{"description":"The public key to add to your SSH server configuration.","example":"ecdsa-sha2-nistp256 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= open-ssh-ca@cloudflareaccess.org","readOnly":true,"type":"string"},"purpose_justification_prompt":{"description":"A custom message that will appear on the purpose justification screen.","example":"Please enter a justification for entering this protected domain.","type":"string"},"purpose_justification_required":{"default":false,"description":"Require users to enter a justification when they log in to the application.","example":true,"type":"boolean"},"query":{"properties":{"dimensions":{"description":"Array of dimension names.","example":["responseCode","queryName"],"items":{"description":"Dimension name.","example":"responseCode","type":"string"},"type":"array"},"filters":{"$ref":"#/components/schemas/filters-6K6BiPDe"},"limit":{"$ref":"#/components/schemas/limit"},"metrics":{"description":"Array of metric names.","example":["queryCount","responseTimeAvg"],"items":{"description":"Metric name.","example":"queries","type":"string"},"type":"array"},"since":{"$ref":"#/components/schemas/since"},"sort":{"description":"Array of dimensions to sort by, where each dimension may be prefixed by - (descending) or + (ascending).","example":["+responseCode","-queryName"],"items":{"description":"Dimension name (may be prefixed by - (descending) or + (ascending).","example":"+responseCode","type":"string"},"type":"array"},"until":{"$ref":"#/components/schemas/until"}},"required":["dimensions","metrics","since","until","limit"],"type":"object"},"query-ju6G02HL":{"description":"For specifying result metrics.","properties":{"dimensions":{"default":"[]","description":"Can be used to break down the data by given attributes.","items":{"description":"For drilling down on metrics.","type":"string"},"type":"array"},"filters":{"default":"\"\"","description":"Used to filter rows by one or more dimensions. Filters can be combined using OR and AND boolean logic. AND takes precedence over OR in all the expressions. The OR operator is defined using a comma (,) or OR keyword surrounded by whitespace. The AND operator is defined using a semicolon (;) or AND keyword surrounded by whitespace. Note that the semicolon is a reserved character in URLs (rfc1738) and needs to be percent-encoded as %3B. Comparison options are: \n\nOperator | Name | URL Encoded\n--------------------------|---------------------------------|--------------------------\n== | Equals | %3D%3D\n!= | Does not equals | !%3D\n\u003e | Greater Than | %3E\n\u003c | Less Than | %3C\n\u003e= | Greater than or equal to | %3E%3D\n\u003c= | Less than or equal to | %3C%3D .","type":"string"},"limit":{"default":10000,"description":"Limit number of returned metrics.","type":"integer"},"metrics":{"description":"One or more metrics to compute.","items":{"description":"A quantitative measurement of KV usage.","type":"string"},"type":"array"},"since":{"default":"\u003c6 hours ago\u003e","description":"Start of time interval to query, defaults to 6 hours before request received.","example":"2019-01-02T02:20:00Z","format":"date-time","type":"string"},"sort":{"default":"[]","description":"Array of dimensions or metrics to sort by, each dimension/metric may be prefixed by - (descending) or + (ascending).","items":{},"type":"array"},"until":{"default":"\u003cnow\u003e","description":"End of time interval to query, defaults to current time.","example":"2019-01-02T03:20:00Z","format":"date-time","type":"string"}},"type":"object"},"query_event":{"properties":{"custom_page_html":{"$ref":"#/components/schemas/event_custom_page_html"},"description":{"$ref":"#/components/schemas/event_description"},"disable_session_renewal":{"$ref":"#/components/schemas/event_disable_session_renewal"},"event_end_time":{"$ref":"#/components/schemas/event_end_time"},"event_start_time":{"$ref":"#/components/schemas/event_start_time"},"name":{"$ref":"#/components/schemas/event_name"},"new_users_per_minute":{"$ref":"#/components/schemas/event_new_users_per_minute"},"prequeue_start_time":{"$ref":"#/components/schemas/event_prequeue_start_time"},"queueing_method":{"$ref":"#/components/schemas/event_queueing_method"},"session_duration":{"$ref":"#/components/schemas/event_session_duration"},"shuffle_at_event_start":{"$ref":"#/components/schemas/event_shuffle_at_event_start"},"suspended":{"$ref":"#/components/schemas/event_suspended"},"total_active_users":{"$ref":"#/components/schemas/event_total_active_users"}},"required":["name","event_start_time","event_end_time"],"type":"object"},"query_healthcheck":{"properties":{"address":{"$ref":"#/components/schemas/address"},"check_regions":{"$ref":"#/components/schemas/check_regions"},"consecutive_fails":{"$ref":"#/components/schemas/consecutive_fails"},"consecutive_successes":{"$ref":"#/components/schemas/consecutive_successes"},"description":{"$ref":"#/components/schemas/description-hRvlp2wh"},"http_config":{"$ref":"#/components/schemas/http_config"},"interval":{"$ref":"#/components/schemas/interval"},"name":{"$ref":"#/components/schemas/name-51RmM5yT"},"retries":{"$ref":"#/components/schemas/retries"},"suspended":{"$ref":"#/components/schemas/suspended"},"tcp_config":{"$ref":"#/components/schemas/tcp_config"},"timeout":{"$ref":"#/components/schemas/timeout"},"type":{"$ref":"#/components/schemas/type-Eu3SX4l3"}},"required":["name","address"],"type":"object"},"query_preview":{"properties":{"custom_html":{"$ref":"#/components/schemas/custom_page_html"}},"required":["custom_html"],"type":"object"},"query_response":{"description":"The exact parameters/timestamps the analytics service used to return data.","properties":{"since":{"$ref":"#/components/schemas/since-cRELaVYs"},"time_delta":{"description":"The amount of time (in minutes) that each data point in the timeseries represents. The granularity of the time-series returned (e.g. each bucket in the time series representing 1-minute vs 1-day) is calculated by the API based on the time-range provided to the API.","type":"integer"},"until":{"$ref":"#/components/schemas/until-HpHDrENT"}},"readOnly":true,"type":"object"},"query_waitingroom":{"properties":{"cookie_attributes":{"$ref":"#/components/schemas/cookie_attributes"},"custom_page_html":{"$ref":"#/components/schemas/custom_page_html"},"default_template_language":{"$ref":"#/components/schemas/default_template_language"},"description":{"$ref":"#/components/schemas/description-DIf6mz41"},"disable_session_renewal":{"$ref":"#/components/schemas/disable_session_renewal"},"host":{"$ref":"#/components/schemas/host"},"json_response_enabled":{"$ref":"#/components/schemas/json_response_enabled"},"name":{"$ref":"#/components/schemas/name-jYNmruXY"},"new_users_per_minute":{"$ref":"#/components/schemas/new_users_per_minute"},"path":{"$ref":"#/components/schemas/path"},"queue_all":{"$ref":"#/components/schemas/queue_all"},"queueing_method":{"$ref":"#/components/schemas/queueing_method"},"session_duration":{"$ref":"#/components/schemas/session_duration"},"suspended":{"$ref":"#/components/schemas/suspended-qdpN2ZN2"},"total_active_users":{"$ref":"#/components/schemas/total_active_users"}},"required":["name","host","new_users_per_minute","total_active_users"],"type":"object"},"queue":{"properties":{"consumers":{"readOnly":true},"consumers_total_count":{"readOnly":true},"created_on":{"readOnly":true},"modified_on":{"readOnly":true},"producers":{"readOnly":true},"producers_total_count":{"readOnly":true},"queue_id":{"readOnly":true},"queue_name":{"$ref":"#/components/schemas/queues_components-schemas-name"}},"type":"object"},"queue_all":{"default":false,"description":"If queue_all is `true`, all the traffic that is coming to a route will be sent to the waiting room. No new traffic can get to the route once this field is set and estimated time will become unavailable.","example":true,"type":"boolean"},"queue_created":{"properties":{"created_on":{"readOnly":true},"modified_on":{"readOnly":true},"queue_id":{"readOnly":true},"queue_name":{"$ref":"#/components/schemas/queues_components-schemas-name"}},"type":"object"},"queue_updated":{"properties":{"created_on":{"readOnly":true},"modified_on":{"readOnly":true},"queue_id":{"readOnly":true},"queue_name":{"$ref":"#/components/schemas/renamed_name"}},"type":"object"},"queueing_method":{"default":"fifo","description":"Sets the queueing method used by the waiting room. Changing this parameter from the **default** queueing method is only available for the Waiting Room Advanced subscription. Regardless of the queueing method, if `queue_all` is enabled or an event is prequeueing, users in the waiting room will not be accepted to the origin. These users will always see a waiting room page that refreshes automatically. The valid queueing methods are:\n1. `fifo` **(default)**: First-In-First-Out queue where customers gain access in the order they arrived.\n2. `random`: Random queue where customers gain access randomly, regardless of arrival time.\n3. `passthrough`: Users will pass directly through the waiting room and into the origin website. As a result, any configured limits will not be respected while this is enabled. This method can be used as an alternative to disabling a waiting room (with `suspended`) so that analytics are still reported. This can be used if you wish to allow all traffic normally, but want to restrict traffic during a waiting room event, or vice versa.\n4. `reject`: Users will be immediately rejected from the waiting room. As a result, no users will reach the origin website while this is enabled. This can be used if you wish to reject all traffic while performing maintenance, block traffic during a specified period of time (an event), or block traffic while events are not occurring. Consider a waiting room used for vaccine distribution that only allows traffic during sign-up events, and otherwise blocks all traffic. For this case, the waiting room uses `reject`, and its events override this with `fifo`, `random`, or `passthrough`. When this queueing method is enabled and neither `queueAll` is enabled nor an event is prequeueing, the waiting room page **will not refresh automatically**.","enum":["fifo","random","passthrough","reject"],"example":"fifo","type":"string"},"queues_components-schemas-name":{"example":"example-queue","type":"string"},"quota":{"properties":{"allocated":{"description":"Quantity Allocated.","type":"integer"},"used":{"description":"Quantity Used.","type":"integer"}},"type":"object"},"r2-single-bucket-operation-response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"type":"object"}}}]},"railgun":{"properties":{"activated_on":{"$ref":"#/components/schemas/activated_on"},"activation_key":{"$ref":"#/components/schemas/activation_key"},"build":{"$ref":"#/components/schemas/build"},"created_on":{"$ref":"#/components/schemas/components-schemas-created_on"},"enabled":{"$ref":"#/components/schemas/railgun_components-schemas-enabled"},"id":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"},"modified_on":{"$ref":"#/components/schemas/railgun_components-schemas-modified_on"},"name":{"$ref":"#/components/schemas/railgun_components-schemas-name"},"revision":{"$ref":"#/components/schemas/revision"},"status":{"$ref":"#/components/schemas/railgun_components-schemas-status"},"upgrade_info":{"$ref":"#/components/schemas/upgrade_info"},"version":{"$ref":"#/components/schemas/components-schemas-version"},"zones_connected":{"$ref":"#/components/schemas/zones_connected"}},"required":["id","name","status","enabled","zones_connected","build","version","revision","activation_key","activated_on","created_on","modified_on"],"type":"object"},"railgun_components-schemas-enabled":{"default":false,"description":"Flag to determine if the Railgun is accepting connections.","example":true,"type":"boolean"},"railgun_components-schemas-identifier":{"description":"Railgun identifier tag.","example":"e928d310693a83094309acf9ead50448","maxLength":32,"readOnly":true,"type":"string"},"railgun_components-schemas-identifier-2":{"description":"Railgun connection identifier tag.","example":"e928d310693a83094309acf9ead50448","maxLength":32,"readOnly":true,"type":"string"},"railgun_components-schemas-modified_on":{"description":"When the Railgun was last modified.","example":"2014-01-01T05:20:00Z","format":"date-time","readOnly":true,"type":"string"},"railgun_components-schemas-name":{"description":"Readable identifier of the Railgun.","example":"My Railgun.","maxLength":160,"type":"string"},"railgun_components-schemas-status":{"description":"Status of the Railgun.","enum":["initializing","active"],"example":"active","readOnly":true,"type":"string"},"railgun_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/railgun"},"type":"array"}}}]},"railgun_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"railgun_response_single_id":{"allOf":[{"$ref":"#/components/schemas/railgun_response_single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"}}}}}]},"random_steering":{"description":"Configures pool weights for random steering. When steering_policy is 'random', a random pool is selected with probability proportional to these pool weights.","properties":{"default_weight":{"default":1,"description":"The default weight for pools in the load balancer that are not specified in the pool_weights map.","example":0.2,"maximum":1,"minimum":0,"multipleOf":0.1,"type":"number"},"pool_weights":{"description":"A mapping of pool IDs to custom weights. The weight is relative to other pools in the load balancer.","example":{"9290f38c5d07c2e2f4df57b1f61d4196":0.5,"de90f38ced07c2e2f4df50b1f61d4194":0.3},"type":"object"}},"type":"object"},"rate-limits":{"allOf":[{"$ref":"#/components/schemas/ratelimit-OTTUtFnH"}],"type":"object"},"rate-limits_components-schemas-id":{"description":"The unique identifier of the rate limit.","example":"372e67954025e0ba6aaa6d586b9e0b59","maxLength":32,"readOnly":true,"type":"string"},"rate-plan":{"properties":{"components":{"$ref":"#/components/schemas/schemas-component_values"},"currency":{"$ref":"#/components/schemas/currency"},"duration":{"$ref":"#/components/schemas/duration"},"frequency":{"$ref":"#/components/schemas/schemas-frequency"},"id":{"$ref":"#/components/schemas/rate-plan_components-schemas-identifier"},"name":{"$ref":"#/components/schemas/rate-plan_components-schemas-name"}},"type":"object"},"rate-plan_components-schemas-identifier":{"description":"Plan identifier tag.","example":"free","readOnly":true,"type":"string"},"rate-plan_components-schemas-name":{"description":"The plan name.","example":"Free Plan","maxLength":80,"readOnly":true,"type":"string"},"rate_plan":{"description":"The rate plan applied to the subscription.","properties":{"currency":{"description":"The currency applied to the rate plan subscription.","example":"USD","type":"string"},"externally_managed":{"description":"Whether this rate plan is managed externally from Cloudflare.","example":false,"type":"boolean"},"id":{"description":"The ID of the rate plan.","example":"free"},"is_contract":{"description":"Whether a rate plan is enterprise-based (or newly adopted term contract).","example":false,"type":"boolean"},"public_name":{"description":"The full name of the rate plan.","example":"Business Plan","type":"string"},"scope":{"description":"The scope that this rate plan applies to.","example":"zone","type":"string"},"sets":{"description":"The list of sets this rate plan applies to.","items":{"type":"string"},"type":"array"}},"type":"object"},"ratelimit":{"description":"Ratelimit in queries per second per datacenter (applies to DNS queries sent to the origin nameservers configured on the cluster).","example":600,"maximum":1000000000,"minimum":100,"nullable":true,"type":"number"},"ratelimit-OTTUtFnH":{"properties":{"action":{"$ref":"#/components/schemas/schemas-action"},"bypass":{"$ref":"#/components/schemas/bypass"},"description":{"$ref":"#/components/schemas/components-schemas-description-Po1ZMHYz"},"disabled":{"$ref":"#/components/schemas/disabled"},"id":{"$ref":"#/components/schemas/rate-limits_components-schemas-id"},"match":{"$ref":"#/components/schemas/match"},"period":{"$ref":"#/components/schemas/period"},"threshold":{"$ref":"#/components/schemas/threshold"}}},"ratelimit_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/rate-limits"},"type":"array"}},"type":"object"}]},"ratelimit_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}},"type":"object"}]},"ray_id":{"description":"The unique identifier for the request to Cloudflare.","example":"187d944c61940c77","maxLength":16,"type":"string"},"ray_identifier":{"description":"Ray identifier.","example":"41ddf1740f67442d","maxLength":16,"readOnly":true,"type":"string"},"ready":{"description":"Beta flag. Users can create a policy with a mechanism that is not ready, but we cannot guarantee successful delivery of notifications.","example":true,"type":"boolean"},"readyToStream":{"description":"Indicates whether the video is ready for viewing.","example":true,"readOnly":true,"type":"boolean"},"ref":{"description":"A short reference tag. Allows you to select related firewall rules.","example":"MIR-31","maxLength":50,"type":"string"},"references_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"description":"List of resources that reference a given monitor.","example":[{"reference_type":"referrer","resource_id":"17b5962d775c646f3f9725cbc7a53df4","resource_name":"primary-dc-1","resource_type":"pool"}],"items":{"properties":{"reference_type":{"enum":["*","referral","referrer"],"type":"string"},"resource_id":{"type":"string"},"resource_name":{"type":"string"},"resource_type":{"type":"string"}},"type":"object"},"type":"array"}}}]},"region_code":{"description":"A list of Cloudflare regions. WNAM: Western North America, ENAM: Eastern North America, WEU: Western Europe, EEU: Eastern Europe, NSAM: Northern South America, SSAM: Southern South America, OC: Oceania, ME: Middle East, NAF: North Africa, SAF: South Africa, SAS: Southern Asia, SEAS: South East Asia, NEAS: North East Asia).","enum":["WNAM","ENAM","WEU","EEU","NSAM","SSAM","OC","ME","NAF","SAF","SAS","SEAS","NEAS"],"example":"WNAM","type":"string"},"region_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"region_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"description":"A list of countries and subdivisions mapped to a region.","example":{"iso_standard":"Country and subdivision codes follow ISO 3166-1 alpha-2 and ISO 3166-2","regions":[{"countries":[{"country_code_a2":"CA","country_name":"Canada","country_subdivisions":[{"subdivision_code_a2":"AB","subdivision_name":"Alberta"},{"subdivision_code_a2":"BC","subdivision_name":"British Columbia"}]},{"country_code_a2":"HT","country_name":"Haiti"},{"country_code_a2":"MX","country_name":"Mexico"},{"country_code_a2":"US","country_name":"United States","country_subdivisions":[{"subdivision_code_a2":"AZ","subdivision_name":"Arizona"},{"subdivision_code_a2":"CA","subdivision_name":"California"},{"subdivision_code_a2":"CO","subdivision_name":"Colorado"},{"subdivision_code_a2":"HI","subdivision_name":"Hawaii"},{"subdivision_code_a2":"MN","subdivision_name":"Minnesota"},{"subdivision_code_a2":"MO","subdivision_name":"Missouri"},{"subdivision_code_a2":"NV","subdivision_name":"Nevada"},{"subdivision_code_a2":"OR","subdivision_name":"Oregon"},{"subdivision_code_a2":"TX","subdivision_name":"Texas"},{"subdivision_code_a2":"UT","subdivision_name":"Utah"},{"subdivision_code_a2":"WA","subdivision_name":"Washington"}]}],"region_code":"WNAM"}]},"type":"object"}}}]},"region_pools":{"description":"A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.","example":{"ENAM":["00920f38ce07c2e2f4df50b1f61d4194"],"WNAM":["de90f38ced07c2e2f4df50b1f61d4194","9290f38c5d07c2e2f4df57b1f61d4196"]},"type":"object"},"regions":{"description":"Comma-separated list of regions.","example":"eu","maxLength":256,"pattern":"^[a-z,]*$","type":"string"},"registrant_contact":{"allOf":[{"$ref":"#/components/schemas/contacts"}],"description":"Shows contact information for domain registrant."},"registry_statuses":{"description":"A comma-separated list of registry status codes. A full list of status codes can be found at [EPP Status Codes](https://www.icann.org/resources/pages/epp-status-codes-2014-06-16-en).","example":"ok,serverTransferProhibited","type":"string"},"remote_config":{"description":"If `true`, the tunnel can be configured remotely from the Zero Trust dashboard. If `false`, the tunnel must be configured locally on the origin machine.","example":true,"type":"boolean"},"renamed_name":{"example":"renamed-example-queue","type":"string"},"report":{"allOf":[{"$ref":"#/components/schemas/result"},{"properties":{"data":{"items":{"properties":{"metrics":{"description":"Array with one item per requested metric. Each item is a single value.","items":{"description":"Nominal metric value.","type":"number"},"type":"array"}},"required":["metrics"]}}},"required":["data"]}]},"report_bytime":{"allOf":[{"$ref":"#/components/schemas/result"},{"properties":{"data":{"items":{"properties":{"metrics":{"description":"Array with one item per requested metric. Each item is an array of values, broken down by time interval.","items":{"description":"Nominal metric values, broken down by time interval.","properties":{"items":{"description":"Nominal metric value.","type":"number"}},"type":"array"},"type":"array"}},"required":["metrics"]}},"query":{"properties":{"time_delta":{"$ref":"#/components/schemas/time_delta"}},"required":["time_delta"],"type":"object"},"time_intervals":{"description":"Array of time intervals in the response data. Each interval is represented as an array containing two values: the start time, and the end time.\n","items":{"description":"Array with exactly two items, representing the start and end time (respectively) of this time interval.","items":{"description":"Time value.","example":"2023-11-11T12:00:00Z","format":"date-time","type":"string"},"type":"array"},"type":"array"}},"required":["time_intervals","query","data"]}]},"request-tracer":{"type":"object"},"request.ip":{"description":"Client IP restrictions.","example":{"in":["123.123.123.0/24","2606:4700::/32"],"not_in":["123.123.123.100/24","2606:4700:4700::/48"]},"properties":{"in":{"$ref":"#/components/schemas/cidr_list"},"not_in":{"$ref":"#/components/schemas/cidr_list"}},"type":"object"},"request_list":{"items":{"$ref":"#/components/schemas/request_model"},"type":"array"},"request_model":{"properties":{"enabled":{"$ref":"#/components/schemas/managed_headers_components-schemas-enabled"},"id":{"$ref":"#/components/schemas/managed_headers_components-schemas-id"}},"type":"object"},"request_type":{"description":"Signature type desired on certificate (\"origin-rsa\" (rsa), \"origin-ecc\" (ecdsa), or \"keyless-certificate\" (for Keyless SSL servers).","enum":["origin-rsa","origin-ecc","keyless-certificate"],"example":"origin-rsa","type":"string"},"requested_validity":{"default":5475,"description":"The number of days for which the certificate should be valid.","enum":[7,30,90,365,730,1095,5475],"example":5475,"type":"number"},"requests":{"description":"The estimated number of requests covered by these calculations.","readOnly":true,"type":"integer"},"requests_by_colo":{"description":"Breakdown of totals for requests.","properties":{"all":{"description":"Total number of requests served.","type":"integer"},"cached":{"description":"Total number of cached requests served.","type":"integer"},"country":{"additionalProperties":true,"description":"Key/value pairs where the key is a two-digit country code and the value is the number of requests served to that country.","example":{"AG":37298,"GI":293846,"US":4181364},"type":"object"},"http_status":{"description":"A variable list of key/value pairs where the key is a HTTP status code and the value is the number of requests with that code served.","example":{"200":13496983,"301":283,"400":187936,"402":1828,"404":1293},"type":"object"},"uncached":{"description":"Total number of requests served from the origin.","type":"integer"}},"type":"object"},"require":{"description":"Rules evaluated with an AND logical operator. To match a policy, a user must meet all of the Require rules.","items":{"$ref":"#/components/schemas/rule"},"type":"array"},"require-SpDpRST8":{"description":"Rules evaluated with an AND logical operator. To match a policy, a user must meet all of the Require rules.","items":{"$ref":"#/components/schemas/rule_components-schemas-rule"},"type":"array"},"requireAll":{"description":"Whether to check all disks for encryption.","example":true,"type":"boolean"},"requireSignedURLs":{"default":false,"description":"Indicates whether the image can be a accessed only using it's UID. If set to true, a signed token needs to be generated with a signing key to view the image.","example":true,"type":"boolean"},"requireSignedURLs-9DKWYMwu":{"default":false,"description":"Indicates whether the video can be a accessed using the UID. When set to `true`, a signed token must be generated with a signing key to view the video.","example":true,"readOnly":true,"type":"boolean"},"resolves_to_ref":{"properties":{"id":{"$ref":"#/components/schemas/stix_identifier"},"value":{"description":"IP address or domain name.","example":"192.0.2.0","type":"string"}},"type":"object"},"resolves_to_refs":{"description":"Specifies a list of references to one or more IP addresses or domain names that the domain name currently resolves to.","items":{"$ref":"#/components/schemas/resolves_to_ref"},"type":"array"},"resource_reference":{"description":"A reference to a load balancer resource.","properties":{"reference_type":{"description":"When listed as a reference, the type (direction) of the reference.","enum":["referral","referrer"],"type":"string"},"references":{"description":"A list of references to (referrer) or from (referral) this resource.","example":[{"reference_type":"referrer","resource_id":"699d98642c564d2e855e9661899b7252","resource_name":"www.example.com","resource_type":"load_balancer"},{"reference_type":"referral","resource_id":"f1aba936b94213e5b8dca0c0dbf1f9cc","resource_name":"Login page monitor","resource_type":"monitor"}],"items":{"description":"A reference to a load balancer resource.","type":"object"},"type":"array"},"resource_id":{"example":"17b5962d775c646f3f9725cbc7a53df4"},"resource_name":{"description":"The human-identifiable name of the resource.","example":"primary-dc-1","type":"string"},"resource_type":{"description":"The type of the resource.","enum":["load_balancer","monitor","pool"],"example":"pool","type":"string"}},"type":"object"},"resources":{"description":"A list of resource names that the policy applies to.","example":{"com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43":"*","com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4":"*"},"type":"object"},"response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/domain-history"},"type":"array"}}}]},"response_buffering":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["response_buffering"],"example":"response_buffering"},"value":{"$ref":"#/components/schemas/response_buffering_value"}}}],"default":"off","description":"Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones.","title":"Response Buffering"},"response_buffering_value":{"default":"off","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/lists"},"type":"array"}}}]},"response_collection-7voDH8b3":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/tsig"},"type":"array"}}}]},"response_collection-AZRlrYzF":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/waitingroom"},"type":"array"}}}]},"response_collection-Etn1LwEn":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/profiles"},"type":"array"}}}]},"response_collection-IG638TJE":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/monitor-FBAH67XY"},"type":"array"}}}]},"response_collection-MecJdTin":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/healthchecks"},"type":"array"}}}]},"response_collection-NcnbjEgN":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"type":"object"},"type":"array"}},"type":"object"}]},"response_collection-Oi5s0tkV":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/device-posture-rules-gduy4mTZ"},"type":"array"}}}]},"response_collection-oP3HzZox":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"anyOf":[{"$ref":"#/components/schemas/azureAD"},{"$ref":"#/components/schemas/centrify"},{"$ref":"#/components/schemas/facebook"},{"$ref":"#/components/schemas/github"},{"$ref":"#/components/schemas/google"},{"$ref":"#/components/schemas/google-apps"},{"$ref":"#/components/schemas/linkedin"},{"$ref":"#/components/schemas/oidc"},{"$ref":"#/components/schemas/okta"},{"$ref":"#/components/schemas/onelogin"},{"$ref":"#/components/schemas/pingone"},{"$ref":"#/components/schemas/saml"},{"$ref":"#/components/schemas/yandex"}]},"type":"array"}},"type":"object"}],"type":"object"},"response_collection-wEgS8Oby":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/ipam-prefixes"},"type":"array"}}}]},"response_collection_hostnames":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/settings-s418OBZp"},"type":"array"}}}]},"response_create":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"allOf":[{"type":"object"},{"properties":{"value":{"$ref":"#/components/schemas/value-V4GUo1Bz"}},"type":"object"}]}},"type":"object"}]},"response_list":{"items":{"$ref":"#/components/schemas/response_model"},"type":"array"},"response_model":{"properties":{"available":{"$ref":"#/components/schemas/available"},"enabled":{"$ref":"#/components/schemas/managed_headers_components-schemas-enabled"},"id":{"$ref":"#/components/schemas/managed_headers_components-schemas-id"}},"type":"object"},"response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}},"type":"object"}]},"response_single_origin_dns":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"argo_smart_routing":{"$ref":"#/components/schemas/argo_smart_routing"},"created_on":{"$ref":"#/components/schemas/created"},"dns":{"$ref":"#/components/schemas/dns"},"edge_ips":{"$ref":"#/components/schemas/edge_ips"},"id":{"$ref":"#/components/schemas/app_id-yTGvAfYO"},"ip_firewall":{"$ref":"#/components/schemas/ip_firewall"},"modified_on":{"$ref":"#/components/schemas/modified"},"origin_dns":{"$ref":"#/components/schemas/origin_dns"},"origin_port":{"$ref":"#/components/schemas/origin_port"},"protocol":{"$ref":"#/components/schemas/protocol"},"proxy_protocol":{"$ref":"#/components/schemas/proxy_protocol"},"tls":{"$ref":"#/components/schemas/tls"},"traffic_type":{"$ref":"#/components/schemas/traffic_type"}}}}}]},"response_single_segment":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"expires_on":{"$ref":"#/components/schemas/expires_on-dkbMDCaD"},"id":{"$ref":"#/components/schemas/components-schemas-identifier-vS0Y8rdw"},"not_before":{"$ref":"#/components/schemas/not_before"},"status":{"$ref":"#/components/schemas/status-8gYjapkg"}},"required":["id","status"]}},"type":"object"}]},"response_single_value":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/value-V4GUo1Bz"}},"type":"object"}]},"result":{"properties":{"data":{"$ref":"#/components/schemas/data"},"data_lag":{"description":"Number of seconds between current time and last processed event, in another words how many seconds of data could be missing.","example":60,"minimum":0,"type":"number"},"max":{"description":"Maximum results for each metric (object mapping metric names to values). Currently always an empty object.","type":"object"},"min":{"description":"Minimum results for each metric (object mapping metric names to values). Currently always an empty object.","type":"object"},"query":{"$ref":"#/components/schemas/query"},"rows":{"description":"Total number of rows in the result.","example":100,"minimum":0,"type":"number"},"totals":{"description":"Total results for metrics across all data (object mapping metric names to values).","type":"object"}},"required":["rows","totals","min","max","data_lag","query","data"],"type":"object"},"result-iSgQlUWZ":{"description":"Metrics on Workers KV requests.","properties":{"data":{"items":{"properties":{"metrics":{"description":"List of metrics returned by the query.","items":{},"type":"array"}},"required":["metrics"],"type":"object"},"nullable":true,"type":"array"},"data_lag":{"description":"Number of seconds between current time and last processed event, i.e. how many seconds of data could be missing.","example":0,"minimum":0,"type":"number"},"max":{"description":"Maximum results for each metric."},"min":{"description":"Minimum results for each metric."},"query":{"$ref":"#/components/schemas/query-ju6G02HL"},"rows":{"description":"Total number of rows in the result.","example":2,"minimum":0,"type":"number"},"totals":{"description":"Total results for metrics across all data."}},"required":["rows","data","data_lag","min","max","totals","query"],"type":"object"},"result_info":{"properties":{"count":{"description":"Total number of results for the requested service","example":1,"type":"number"},"page":{"description":"Current page within paginated list of results","example":1,"type":"number"},"per_page":{"description":"Number of results per page of results","example":20,"type":"number"},"total_count":{"description":"Total results available without any search parameters","example":2000,"type":"number"}},"type":"object"},"retries":{"default":2,"description":"The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.","type":"integer"},"retries-w39sVXcQ":{"default":2,"description":"Number of retries for fetching DNS responses from origin nameservers (not counting the initial attempt).","example":2,"maximum":2,"minimum":0,"type":"number"},"revision":{"description":"The revision of the Railgun receiver.","example":"123","readOnly":true,"type":"string"},"revoke_devices_request":{"description":"A list of device ids to revoke.","items":{"$ref":"#/components/schemas/uuid-s0SXln0q"},"maxLength":200,"type":"array"},"revoke_devices_request-zLb49AXe":{"description":"A list of device ids to revoke.","items":{"$ref":"#/components/schemas/schemas-uuid-lt6l49Ob"},"maxLength":200,"type":"array"},"revoked_at":{"description":"When the device was revoked.","example":"2017-06-14T00:00:00Z","format":"date-time","type":"string"},"rewrite_action":{"description":"Specifies that, when a WAF rule matches, its configured action will be replaced by the action configured in this object.","properties":{"block":{"$ref":"#/components/schemas/waf_rewrite_action"},"challenge":{"example":"block"},"default":{"example":"block"},"disable":{"$ref":"#/components/schemas/waf_rewrite_action"},"simulate":{"example":"disable"}},"type":"object"},"risk_score":{"description":"Hostname risk score, which is a value between 0 (lowest risk) to 1 (highest risk).","type":"number"},"risk_types":{"example":[]},"rocket_loader":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["rocket_loader"],"example":"rocket_loader"},"value":{"$ref":"#/components/schemas/rocket_loader_value"}}}],"description":"Rocket Loader is a general-purpose asynchronous JavaScript optimisation that prioritises rendering your content while loading your site's Javascript asynchronously. Turning on Rocket Loader will immediately improve a web page's rendering time sometimes measured as Time to First Paint (TTFP), and also the `window.onload` time (assuming there is JavaScript on the page). This can have a positive impact on your Google search ranking. When turned on, Rocket Loader will automatically defer the loading of all Javascript referenced in your HTML, with no configuration required. Refer to [Understanding Rocket Loader](https://support.cloudflare.com/hc/articles/200168056) for more information.","title":"Rocket Loader"},"rocket_loader_value":{"default":"off","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"role":{"properties":{"description":{"description":"Description of role's permissions.","example":"Administrative access to the entire Account","readOnly":true,"type":"string"},"id":{"$ref":"#/components/schemas/role_components-schemas-identifier"},"name":{"description":"Role name.","example":"Account Administrator","maxLength":120,"readOnly":true,"type":"string"},"permissions":{"$ref":"#/components/schemas/permissions"}},"required":["id","name","description","permissions"],"type":"object"},"role_components-schemas-identifier":{"description":"Role identifier tag.","example":"3536bcfad5faccb999b47003c79917fb","maxLength":32,"readOnly":true,"type":"string"},"roles":{"description":"List of role names for the user at the account.","items":{"example":"Account Administrator","maxLength":120,"type":"string"},"readOnly":true,"type":"array"},"route":{"properties":{"created_on":{"$ref":"#/components/schemas/created_on"},"description":{"$ref":"#/components/schemas/description-dSE9ExYP"},"id":{"$ref":"#/components/schemas/identifier-5dNKLCP5"},"modified_on":{"$ref":"#/components/schemas/modified_on"},"nexthop":{"$ref":"#/components/schemas/nexthop"},"prefix":{"$ref":"#/components/schemas/prefix"},"priority":{"$ref":"#/components/schemas/priority"},"scope":{"$ref":"#/components/schemas/scope"},"weight":{"$ref":"#/components/schemas/weight"}},"required":["prefix","nexthop","priority"],"type":"object"},"route-k62zYPUS":{"properties":{"modified_on":{"description":"The timestamp of when the override was last modified.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string"},"name":{"description":"The type of route.","enum":["forward_url"],"example":"forward_url"},"value":{"properties":{"type":{"description":"The response type for the URL redirect.","enum":["temporary","permanent"],"example":"temporary"},"url":{"description":"The URL to redirect the request to.\nNotes: ${num} refers to the position of '*' in the constraint value.","example":"http://www.example.com/somewhere/$1/astring/$2/anotherstring/$3","type":"string"}}}},"type":"object"},"route-no-id":{"properties":{"pattern":{"$ref":"#/components/schemas/pattern-prw776lg"},"script":{"$ref":"#/components/schemas/schemas-script_name"}},"required":["pattern"]},"route-response-collection":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/routes"},"type":"array"}}}]},"route-response-single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/routes"}}}]},"route_add_single_request":{"properties":{"description":{"$ref":"#/components/schemas/description-dSE9ExYP"},"nexthop":{"$ref":"#/components/schemas/nexthop"},"prefix":{"$ref":"#/components/schemas/prefix"},"priority":{"$ref":"#/components/schemas/priority"},"scope":{"$ref":"#/components/schemas/scope"},"weight":{"$ref":"#/components/schemas/weight"}},"required":["prefix","nexthop","priority"],"type":"object"},"route_delete_id":{"allOf":[{"properties":{"id":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}},"required":["id"]}]},"route_delete_many_request":{"properties":{"routes":{"items":{"$ref":"#/components/schemas/route_delete_id"},"type":"array"}},"required":["routes"],"type":"object"},"route_deleted_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"deleted":{"example":true,"type":"boolean"},"deleted_route":{"type":"object"}}}}}]},"route_modified_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"modified":{"example":true,"type":"boolean"},"modified_route":{"type":"object"}}}}}]},"route_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/teamnet"},"type":"array"}},"type":"object"}]},"route_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}},"type":"object"}]},"route_single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"route":{"type":"object"}}}}}]},"route_update_many_request":{"properties":{"routes":{"items":{"$ref":"#/components/schemas/route_update_single_request"},"type":"array"}},"required":["routes"],"type":"object"},"route_update_request":{"allOf":[{"$ref":"#/components/schemas/route_add_single_request"}]},"route_update_single_request":{"allOf":[{"properties":{"id":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}},"required":["id"]},{"$ref":"#/components/schemas/route_add_single_request"}]},"routes":{"properties":{"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"pattern":{"$ref":"#/components/schemas/pattern-prw776lg"},"script":{"$ref":"#/components/schemas/schemas-script_name"}},"required":["id","pattern","script"],"type":"object"},"routes_collection_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"routes":{"items":{"$ref":"#/components/schemas/route"},"type":"array"}}}}}]},"rule":{"oneOf":[{"$ref":"#/components/schemas/email_rule"},{"$ref":"#/components/schemas/domain_rule"},{"$ref":"#/components/schemas/everyone_rule"},{"$ref":"#/components/schemas/ip_rule"},{"$ref":"#/components/schemas/ip_list_rule"},{"$ref":"#/components/schemas/certificate_rule"},{"$ref":"#/components/schemas/access_group_rule"},{"$ref":"#/components/schemas/azure_group_rule"},{"$ref":"#/components/schemas/github_organization_rule"},{"$ref":"#/components/schemas/gsuite_group_rule"},{"$ref":"#/components/schemas/okta_group_rule"},{"$ref":"#/components/schemas/saml_group_rule"}],"type":"object"},"rule-VtwDyToZ":{"properties":{"allowed_modes":{"description":"The available actions that a rule can apply to a matched request.","example":["whitelist","block","challenge","js_challenge","managed_challenge"],"items":{"$ref":"#/components/schemas/schemas-mode"},"readOnly":true,"type":"array"},"configuration":{"$ref":"#/components/schemas/schemas-configuration"},"created_on":{"description":"The timestamp of when the rule was created.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string"},"id":{"$ref":"#/components/schemas/rule_components-schemas-identifier"},"mode":{"$ref":"#/components/schemas/schemas-mode"},"modified_on":{"description":"The timestamp of when the rule was last modified.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string"},"notes":{"$ref":"#/components/schemas/notes"}},"required":["id","mode","allowed_modes","configuration"],"type":"object"},"rule-settings":{"description":"Additional settings that modify the rule's action.","properties":{"add_headers":{"description":"Add custom headers to allowed requests, in the form of key-value pairs. Keys are header names, pointing to an array with its header value(s).","example":{"My-Next-Header":["foo","bar"],"X-Custom-Header-Name":["somecustomvalue"]},"type":"object"},"allow_child_bypass":{"description":"Set by parent MSP accounts to enable their children to bypass this rule.","example":false,"type":"boolean"},"audit_ssh":{"description":"Audit ssh action settings","properties":{"command_logging":{"description":"Turn on SSH command logging.","example":false,"type":"boolean"}},"type":"object"},"biso_admin_controls":{"description":"Configure how browser isolation behaves.","properties":{"dcp":{"description":"Disable copy-paste.","example":false,"type":"boolean"},"dd":{"description":"Disable download.","example":false,"type":"boolean"},"dk":{"description":"Disable keyboard usage.","example":false,"type":"boolean"},"dp":{"description":"Disable printing.","example":false,"type":"boolean"},"du":{"description":"Disable upload.","example":false,"type":"boolean"}},"type":"object"},"block_page_enabled":{"description":"Enable the custom block page.","example":true,"type":"boolean"},"block_reason":{"description":"The text describing why this block occurred that will be displayed on the custom block page (if enabled).","example":"This website is a security risk","type":"string"},"bypass_parent_rule":{"description":"Set by children MSP accounts to bypass their parent's rules.","example":false,"type":"boolean"},"check_session":{"description":"Configure how session check behaves.","properties":{"duration":{"description":"Configure how fresh the session needs to be to be considered valid.","example":"300s","type":"string"},"enforce":{"description":"Enable session enforcement for this fule.","example":true,"type":"boolean"}},"type":"object"},"egress":{"description":"Configure how Proxy traffic egresses. Can be set for rules with Egress action and Egress filter. Can be omitted to indicate local egress via Warp IPs","properties":{"ipv4":{"description":"The IPv4 address to be used for egress.","example":"192.0.2.2","type":"string"},"ipv4_fallback":{"description":"The IPv4 address to be used for egress in the event of an error egressing with the primary IPv4. Can be '0.0.0.0' to indicate local egreass via Warp IPs.","example":"192.0.2.3","type":"string"},"ipv6":{"description":"The IPv6 range to be used for egress.","example":"2001:DB8::/64","type":"string"}},"type":"object"},"insecure_disable_dnssec_validation":{"description":"INSECURE - disable DNSSEC validation (for allow actions).","example":false,"type":"boolean"},"ip_categories":{"description":"Include IPs in DNS resolver category blocks. By default categories only block on domain names.","example":true,"type":"boolean"},"l4override":{"description":"Send matching traffic to the supplied destination IP address and port.","properties":{"ip":{"description":"IPv4 or IPv6 address.","example":"1.1.1.1","type":"string"},"port":{"description":"A port number to use for TCP/UDP overrides.","type":"integer"}},"type":"object"},"override_host":{"description":"Override matching DNS queries with this.","example":"example.com","type":"string"},"override_ips":{"description":"Override matching DNS queries with this.","example":["1.1.1.1","2.2.2.2"],"items":{"description":"IPv4 or IPv6 address.","example":"1.1.1.1","type":"string"},"type":"array"},"payload_log":{"description":"Configure DLP payload logging.","properties":{"enabled":{"description":"Enable DLP payload logging for this rule.","example":true,"type":"boolean"}},"type":"object"},"untrusted_cert":{"description":"Configure behavior when an upstream cert is invalid / an SSL error occurs.","properties":{"action":{"description":"The action to perform upon seeing an untrusted certificate. Default action is error with HTTP code 526.","enum":["pass_through","block","error"],"example":"error","type":"string"}},"type":"object"}},"type":"object"},"rule_action":{"description":"The action to take when the expression matches.","enum":["bypass_waiting_room"],"example":"bypass_waiting_room","type":"string"},"rule_action-nbqjzWP9":{"description":"Actions pattern.","properties":{"type":{"description":"Type of supported action.","enum":["forward","worker"],"example":"forward","type":"string"},"value":{"items":{"description":"Value for action.","example":"destinationaddress@example.net","maxLength":90,"type":"string"},"type":"array"}},"required":["type","value"],"type":"object"},"rule_actions":{"description":"List actions patterns.","items":{"$ref":"#/components/schemas/rule_action-nbqjzWP9"},"type":"array"},"rule_catchall-action":{"description":"Action for the catch-all routing rule.","properties":{"type":{"description":"Type of action for catch-all rule.","enum":["drop","forward","worker"],"example":"forward","type":"string"},"value":{"items":{"description":"Input value for action.","example":"destinationaddress@example.net","maxLength":90,"type":"string"},"type":"array"}},"required":["type"],"type":"object"},"rule_catchall-actions":{"description":"List actions for the catch-all routing rule.","items":{"$ref":"#/components/schemas/rule_catchall-action"},"type":"array"},"rule_catchall-matcher":{"description":"Matcher for catch-all routing rule.","properties":{"type":{"description":"Type of matcher. Default is 'all'.","enum":["all"],"example":"all","type":"string"}},"required":["type"],"type":"object"},"rule_catchall-matchers":{"description":"List of matchers for the catch-all routing rule.","items":{"$ref":"#/components/schemas/rule_catchall-matcher"},"type":"array"},"rule_collection_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/rule-VtwDyToZ"},"type":"array"}}}]},"rule_components-schemas-base":{"properties":{"description":{"$ref":"#/components/schemas/rule_components-schemas-description"},"group":{"description":"The rule group to which the current WAF rule belongs.","properties":{"id":{"$ref":"#/components/schemas/group_components-schemas-identifier"},"name":{"$ref":"#/components/schemas/group_components-schemas-name"}},"readOnly":true,"type":"object"},"id":{"$ref":"#/components/schemas/rule_components-schemas-identifier-2"},"package_id":{"$ref":"#/components/schemas/package_components-schemas-identifier"},"priority":{"$ref":"#/components/schemas/schemas-priority"}}},"rule_components-schemas-base-2":{"allOf":[{"$ref":"#/components/schemas/rule_components-schemas-base"}]},"rule_components-schemas-description":{"description":"The public description of the WAF rule.","example":"SQL injection prevention for SELECT statements","readOnly":true,"type":"string"},"rule_components-schemas-identifier":{"description":"The unique identifier of the IP Access rule.","example":"92f17202ed8bd63d69a66b86a49a8f6b","maxLength":32,"readOnly":true,"type":"string"},"rule_components-schemas-identifier-2":{"description":"The unique identifier of the WAF rule.","example":"f939de3be84e66e757adcdcb87908023","maxLength":32,"readOnly":true,"type":"string"},"rule_components-schemas-rule":{"oneOf":[{"$ref":"#/components/schemas/email_rule"},{"$ref":"#/components/schemas/domain_rule"},{"$ref":"#/components/schemas/everyone_rule"},{"$ref":"#/components/schemas/ip_rule"},{"$ref":"#/components/schemas/ip_list_rule"},{"$ref":"#/components/schemas/certificate_rule"},{"$ref":"#/components/schemas/access_group_rule"},{"$ref":"#/components/schemas/azure_group_rule"},{"$ref":"#/components/schemas/github_organization_rule"},{"$ref":"#/components/schemas/gsuite_group_rule"},{"$ref":"#/components/schemas/okta_group_rule"},{"$ref":"#/components/schemas/saml_group_rule"}],"type":"object"},"rule_description":{"default":"","description":"The description of the rule.","example":"allow all traffic from 10.20.30.40","type":"string"},"rule_enabled":{"default":true,"description":"When set to true, the rule is enabled.","example":true,"type":"boolean"},"rule_enabled-VMnvyEOL":{"default":true,"description":"Routing rule status.","enum":[true,false],"example":true,"type":"boolean"},"rule_expression":{"description":"Criteria defining when there is a match for the current rule.","example":"ip.src in {10.20.30.40}","type":"string"},"rule_group_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/schemas-group"},"type":"array"}}}]},"rule_group_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"rule_id":{"description":"The ID of the rule.","example":"25756b2dfe6e378a06b033b670413757","type":"string"},"rule_identifier":{"example":"2890e6fa406311ed9b5a23f70f6fb8cf"},"rule_identifier-wpFBeqHF":{"description":"Routing rule identifier.","example":"a7e6fb77503c41d8a7f3113c6918f10c","maxLength":32,"readOnly":true,"type":"string"},"rule_matcher":{"description":"Matching pattern to forward your actions.","properties":{"field":{"description":"Field for type matcher.","enum":["to"],"example":"to","type":"string"},"type":{"description":"Type of matcher.","enum":["literal"],"example":"literal","type":"string"},"value":{"description":"Value for matcher.","example":"test@example.com","maxLength":90,"type":"string"}},"required":["type","field","value"],"type":"object"},"rule_matchers":{"description":"Matching patterns to forward to your actions.","items":{"$ref":"#/components/schemas/rule_matcher"},"type":"array"},"rule_name":{"description":"Routing rule name.","example":"Send to user@example.net rule.","maxLength":256,"type":"string"},"rule_position":{"description":"Reorder the position of a rule","oneOf":[{"properties":{"index":{"description":" Places the rule in the exact position specified by the integer number \u003cPOSITION_NUMBER\u003e. Position numbers start with 1. Existing rules in the ruleset from the specified position number onward are shifted one position (no rule is overwritten).","type":"integer"}},"type":"object"},{"properties":{"before":{"description":" Places the rule before rule \u003cRULE_ID\u003e. Use this argument with an empty rule ID value (\"\") to set the rule as the first rule in the ruleset.","example":"\u003cRULE_ID\u003e","type":"string"}},"type":"object"},{"properties":{"after":{"description":"Places the rule after rule \u003cRULE_ID\u003e. Use this argument with an empty rule ID value (\"\") to set the rule as the last rule in the ruleset.","example":"\u003cRULE_ID\u003e","type":"string"}},"type":"object"}],"type":"object"},"rule_priority":{"default":0,"description":"Priority of the routing rule.","minimum":0,"type":"number"},"rule_properties":{"properties":{"actions":{"$ref":"#/components/schemas/rule_actions"},"enabled":{"$ref":"#/components/schemas/rule_enabled-VMnvyEOL"},"matchers":{"$ref":"#/components/schemas/rule_matchers"},"name":{"$ref":"#/components/schemas/rule_name"},"priority":{"$ref":"#/components/schemas/rule_priority"},"tag":{"$ref":"#/components/schemas/rule_identifier-wpFBeqHF"}},"type":"object"},"rule_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/components-schemas-rule"},"type":"array"}}}]},"rule_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"rule_response_single-rvlRijjw":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/rules-lDrBq79x"}}}]},"rule_result":{"properties":{"action":{"$ref":"#/components/schemas/rule_action"},"description":{"$ref":"#/components/schemas/rule_description"},"enabled":{"$ref":"#/components/schemas/rule_enabled"},"expression":{"$ref":"#/components/schemas/rule_expression"},"id":{"$ref":"#/components/schemas/rule_id"},"last_updated":{"$ref":"#/components/schemas/timestamp"},"version":{"$ref":"#/components/schemas/rule_version"}},"type":"object"},"rule_single_id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/rule_components-schemas-identifier"}},"type":"object"}}}]},"rule_single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/rule-VtwDyToZ"}}}]},"rule_version":{"description":"The version of the rule.","example":"1","type":"string"},"rules":{"properties":{"action":{"$ref":"#/components/schemas/action"},"created_at":{"$ref":"#/components/schemas/timestamp"},"deleted_at":{"$ref":"#/components/schemas/deleted_at"},"description":{"$ref":"#/components/schemas/schemas-description"},"device_posture":{"$ref":"#/components/schemas/device_posture"},"enabled":{"$ref":"#/components/schemas/enabled"},"filters":{"$ref":"#/components/schemas/filters"},"id":{"$ref":"#/components/schemas/uuid"},"identity":{"$ref":"#/components/schemas/identity"},"name":{"$ref":"#/components/schemas/components-schemas-name"},"precedence":{"$ref":"#/components/schemas/precedence"},"rule_settings":{"$ref":"#/components/schemas/rule-settings"},"schedule":{"$ref":"#/components/schemas/schedule"},"traffic":{"$ref":"#/components/schemas/traffic"},"updated_at":{"$ref":"#/components/schemas/timestamp"}},"type":"object"},"rules-8L4eu614":{"description":"BETA Field Not General Access: A list of rules for this load balancer to execute.","items":{"additionalProperties":false,"description":"A rule object containing conditions and overrides for this load balancer to evaluate.","properties":{"condition":{"description":"The condition expressions to evaluate. If the condition evaluates to true, the overrides or fixed_response in this rule will be applied. An empty condition is always true. For more details on condition expressions, please see https://developers.cloudflare.com/load-balancing/understand-basics/load-balancing-rules/expressions.","example":"http.request.uri.path contains \"/testing\"","type":"string"},"disabled":{"default":false,"description":"Disable this specific rule. It will no longer be evaluated by this load balancer.","type":"boolean"},"fixed_response":{"description":"A collection of fields used to directly respond to the eyeball instead of routing to a pool. If a fixed_response is supplied the rule will be marked as terminates.","properties":{"content_type":{"description":"The http 'Content-Type' header to include in the response.","example":"application/json","maxLength":32,"type":"string"},"location":{"description":"The http 'Location' header to include in the response.","example":"www.example.com","maxLength":2048,"type":"string"},"message_body":{"description":"Text to include as the http body.","example":"Testing Hello","maxLength":1024,"type":"string"},"status_code":{"description":"The http status code to respond with.","type":"integer"}},"type":"object"},"name":{"description":"Name of this rule. Only used for human readability.","example":"route the path /testing to testing datacenter.","maxLength":200,"type":"string"},"overrides":{"description":"A collection of overrides to apply to the load balancer when this rule's condition is true. All fields are optional.","properties":{"adaptive_routing":{"$ref":"#/components/schemas/adaptive_routing"},"country_pools":{"$ref":"#/components/schemas/country_pools"},"default_pools":{"$ref":"#/components/schemas/default_pools"},"fallback_pool":{"$ref":"#/components/schemas/fallback_pool"},"location_strategy":{"$ref":"#/components/schemas/location_strategy"},"pop_pools":{"$ref":"#/components/schemas/pop_pools"},"random_steering":{"$ref":"#/components/schemas/random_steering"},"region_pools":{"$ref":"#/components/schemas/region_pools"},"session_affinity":{"$ref":"#/components/schemas/session_affinity"},"session_affinity_attributes":{"$ref":"#/components/schemas/session_affinity_attributes"},"session_affinity_ttl":{"$ref":"#/components/schemas/session_affinity_ttl"},"steering_policy":{"$ref":"#/components/schemas/steering_policy"},"ttl":{"$ref":"#/components/schemas/ttl-0jCBhfJ2"}},"type":"object"},"priority":{"default":0,"description":"The order in which rules should be executed in relation to each other. Lower values are executed first. Values do not need to be sequential. If no value is provided for any rule the array order of the rules field will be used to assign a priority.","type":"integer"},"terminates":{"default":false,"description":"If this rule's condition is true, this causes rule evaluation to stop after processing this rule.","type":"boolean"}},"type":"object"},"type":"array"},"rules-YnuEBjzV":{"additionalProperties":{"allOf":[{"$ref":"#/components/schemas/waf_action"}],"example":"default"},"description":"An object that allows you to override the action of specific WAF rules. Each key of this object must be the ID of a WAF rule, and each value must be a valid WAF action. Unless you are disabling a rule, ensure that you also enable the rule group that this WAF rule belongs to. When creating a new URI-based WAF override, you must provide a `groups` object or a `rules` object.","example":{"100015":"disable"},"type":"object"},"rules-lDrBq79x":{"allOf":[{"$ref":"#/components/schemas/rule_properties"}],"type":"object"},"rules_components-schemas-account_identifier":{"example":"6f91088a406011ed95aed352566e8d4c"},"rules_components-schemas-action":{"description":"The action to perform when the rule matches.","example":"execute","pattern":"^[a-z_]+$","type":"string"},"rules_components-schemas-description":{"default":"","description":"An informative description of the rule.","example":"Execute the OWASP ruleset when the IP address is not 1.1.1.1","type":"string"},"rules_components-schemas-enabled":{"default":"true","description":"Whether the rule should be executed.","example":true,"type":"boolean"},"rules_components-schemas-id":{"description":"The unique ID of the rule.","example":"3a03d665bac047339bb530ecb439a90d","type":"string"},"rules_components-schemas-rule":{"description":"A rule object.","properties":{"action":{"$ref":"#/components/schemas/rules_components-schemas-action"},"action_parameters":{"$ref":"#/components/schemas/action_parameters"},"categories":{"$ref":"#/components/schemas/categories-YFgu3d0j"},"description":{"$ref":"#/components/schemas/rules_components-schemas-description"},"enabled":{"$ref":"#/components/schemas/rules_components-schemas-enabled"},"expression":{"$ref":"#/components/schemas/schemas-expression"},"id":{"$ref":"#/components/schemas/rules_components-schemas-id"},"last_updated":{"$ref":"#/components/schemas/schemas-last_updated"},"logging":{"$ref":"#/components/schemas/logging"},"ref":{"$ref":"#/components/schemas/components-schemas-ref"},"version":{"$ref":"#/components/schemas/schemas-version"}},"type":"object"},"rules_count":{"default":0,"description":"The number of rules in the current rule group.","example":10,"readOnly":true,"type":"number"},"rules_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/rule_result"},"type":"array"}}}]},"rules_response_collection-Fgtzw0xK":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/rules-lDrBq79x"},"type":"array"},"result_info":{"properties":{"count":{"example":1},"page":{"example":1},"per_page":{"example":20},"total_count":{"example":1}},"type":"object"}}}]},"ruleset":{"description":"A ruleset object.","properties":{"description":{"$ref":"#/components/schemas/rulesets_components-schemas-description"},"id":{"$ref":"#/components/schemas/rulesets_components-schemas-id"},"kind":{"$ref":"#/components/schemas/schemas-kind"},"last_updated":{"$ref":"#/components/schemas/last_updated"},"name":{"$ref":"#/components/schemas/rulesets_components-schemas-name"},"phase":{"$ref":"#/components/schemas/phase"},"rules":{"$ref":"#/components/schemas/schemas-rules"},"version":{"$ref":"#/components/schemas/version-VHkxmcSG"}},"type":"object"},"ruleset_response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"$ref":"#/components/schemas/ruleset"}},"type":"object"}]},"ruleset_without_rules":{"description":"A ruleset object.","properties":{"description":{"$ref":"#/components/schemas/rulesets_components-schemas-description"},"id":{"$ref":"#/components/schemas/rulesets_components-schemas-id"},"kind":{"$ref":"#/components/schemas/schemas-kind"},"last_updated":{"$ref":"#/components/schemas/last_updated"},"name":{"$ref":"#/components/schemas/rulesets_components-schemas-name"},"phase":{"$ref":"#/components/schemas/phase"},"version":{"$ref":"#/components/schemas/version-VHkxmcSG"}},"type":"object"},"rulesets_components-schemas-description":{"default":"","description":"An informative description of the ruleset.","example":"My ruleset to execute managed rulesets","type":"string"},"rulesets_components-schemas-id":{"description":"The unique ID of the ruleset.","example":"2f2feab2026849078ba485f918791bdc","pattern":"^[0-9a-f]{32}$","type":"string"},"rulesets_components-schemas-name":{"description":"The human-readable name of the ruleset.","example":"My ruleset","type":"string"},"rulesets_response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"description":"A list of rulesets. The returned information will not include the rules in each ruleset.","items":{"$ref":"#/components/schemas/ruleset_without_rules"},"type":"array"}},"type":"object"}]},"run_at":{"description":"Timestamp of when the tunnel connection was started.","example":"2009-11-10T23:00:00Z","format":"date-time","type":"string"},"saas_app":{"properties":{"consumer_service_url":{"description":"The service provider's endpoint that is responsible for receiving and parsing a SAML assertion.","example":"https://example.com","type":"string"},"created_at":{"$ref":"#/components/schemas/timestamp"},"custom_attributes":{"properties":{"name":{"description":"The name of the attribute.","example":"family_name","type":"string"},"name_format":{"description":"A globally unique name for an identity or service provider.","enum":["urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified","urn:oasis:names:tc:SAML:2.0:attrname-format:basic","urn:oasis:names:tc:SAML:2.0:attrname-format:uri"],"example":"urn:oasis:names:tc:SAML:2.0:attrname-format:basic","type":"string"},"source":{"properties":{"name":{"description":"The name of the IdP attribute.","example":"last_name","type":"string"}},"type":"object"}},"type":"object"},"idp_entity_id":{"description":"The unique identifier for your SaaS application.","example":"https://example.cloudflareaccess.com","type":"string"},"name_id_format":{"description":"The format of the name identifier sent to the SaaS application.","enum":["id","email"],"example":"id","type":"string"},"public_key":{"description":"The Access public certificate that will be used to verify your identity.","example":"example unique name","type":"string"},"sp_entity_id":{"description":"A globally unique name for an identity or service provider.","example":"example unique name","type":"string"},"sso_endpoint":{"description":"The endpoint where your SaaS application will send login requests.","example":"https://example.cloudflareaccess.com/cdn-cgi/access/sso/saml/b3f58a2b414e0b51d45c8c2af26fccca0e27c63763c426fa52f98dcf0b3b3bfd","type":"string"},"updated_at":{"$ref":"#/components/schemas/timestamp"}},"type":"object"},"saas_props":{"properties":{"allowed_idps":{"$ref":"#/components/schemas/allowed_idps"},"app_launcher_visible":{"$ref":"#/components/schemas/app_launcher_visible"},"auto_redirect_to_identity":{"$ref":"#/components/schemas/schemas-auto_redirect_to_identity"},"logo_url":{"$ref":"#/components/schemas/logo_url"},"name":{"$ref":"#/components/schemas/apps_components-schemas-name"},"saas_app":{"$ref":"#/components/schemas/saas_app"},"type":{"description":"The application type.","example":"saas","type":"string"}},"title":"SaaS Application","type":"object"},"saas_props-3mDdjpPa":{"properties":{"allowed_idps":{"$ref":"#/components/schemas/allowed_idps"},"app_launcher_visible":{"$ref":"#/components/schemas/app_launcher_visible"},"auto_redirect_to_identity":{"$ref":"#/components/schemas/auto_redirect_to_identity-zRTYoQOC"},"logo_url":{"$ref":"#/components/schemas/logo_url"},"name":{"$ref":"#/components/schemas/apps_components-schemas-name"},"saas_app":{"$ref":"#/components/schemas/saas_app"},"type":{"description":"The application type.","example":"saas","type":"string"}},"title":"SaaS Application","type":"object"},"same_site_cookie_attribute":{"description":"Sets the SameSite cookie setting, which provides increased security against CSRF attacks.","example":"strict","type":"string"},"saml":{"allOf":[{"$ref":"#/components/schemas/identity-provider"},{"properties":{"config":{"properties":{"attributes":{"description":"A list of SAML attribute names that will be added to your signed JWT token and can be used in SAML policy rules.","example":["group","department_code","divison"],"items":{"type":"string"},"type":"array"},"email_attribute_name":{"description":"The attribute name for email in the SAML response.","example":"Email","type":"string"},"header_attributes":{"description":"Add a list of attribute names that will be returned in the response header from the Access callback.","items":{"properties":{"attribute_name":{"description":"attribute name from the IDP","type":"string"},"header_name":{"description":"header that will be added on the request to the origin","type":"string"}},"type":"object"},"type":"array"},"idp_public_certs":{"description":"X509 certificate to verify the signature in the SAML authentication response","items":{"type":"string"},"type":"array"},"issuer_url":{"description":"IdP Entity ID or Issuer URL","example":"https://whoami.com","type":"string"},"sign_request":{"description":"Sign the SAML authentication request with Access credentials. To verify the signature, use the public key from the Access certs endpoints.","type":"boolean"},"sso_target_url":{"description":"URL to send the SAML authentication requests to","example":"https://edgeaccess.org/idp/saml/login","type":"string"}},"type":"object"}},"type":"object"}],"title":"Generic SAML","type":"object"},"saml_group_rule":{"description":"Matches a SAML group.\nRequires a SAML identity provider.","properties":{"saml":{"properties":{"attribute_name":{"description":"The name of the SAML attribute.","example":"group","type":"string"},"attribute_value":{"description":"The SAML attribute value to look for.","example":"devs@cloudflare.com","type":"string"}},"required":["attribute_name","attribute_value"],"type":"object"}},"required":["saml"],"title":"SAML group","type":"object"},"sample":{"description":"The sample parameter is the sample rate of the records set by the client: \"sample\": 1 is 100% of records \"sample\": 10 is 10% and so on.","example":1,"type":"integer"},"sample-qlwBkrnD":{"description":"When `?sample=` is provided, a sample of matching records is returned. If `sample=0.1` then 10% of records will be returned. Sampling is random: repeated calls will not only return different records, but likely will also vary slightly in number of returned records. When `?count=` is also specified, `count` is applied to the number of returned records, not the sampled records. So, with `sample=0.05` and `count=7`, when there is a total of 100 records available, approximately five will be returned. When there are 1000 records, seven will be returned. When there are 10,000 records, seven will be returned.","example":0.1,"maximum":1,"minimum":0,"type":"number"},"scale":{"default":0.15,"description":"The size of the image relative to the overall size of the video. This parameter will adapt to horizontal and vertical videos automatically. `0.0` indicates no scaling (use the size of the image as-is), and `1.0 `fills the entire video.","example":0.1,"maximum":1,"minimum":0,"readOnly":true,"type":"number"},"schedule":{"description":"Schedule for activating DNS policies. Does not apply to HTTP or network policies.","properties":{"fri":{"description":"The time intervals when the rule will be active on Fridays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Fridays.","example":"08:00-12:30,13:30-17:00","type":"string"},"mon":{"description":"The time intervals when the rule will be active on Mondays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Mondays.","example":"08:00-12:30,13:30-17:00","type":"string"},"sat":{"description":"The time intervals when the rule will be active on Saturdays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Saturdays.","example":"08:00-12:30,13:30-17:00","type":"string"},"sun":{"description":"The time intervals when the rule will be active on Sundays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Sundays.","example":"08:00-12:30,13:30-17:00","type":"string"},"thu":{"description":"The time intervals when the rule will be active on Thursdays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Thursdays.","example":"08:00-12:30,13:30-17:00","type":"string"},"time_zone":{"description":"The time zone the rule will be evaluated against. If a [valid time zone city name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) is provided, Gateway will always use the current time at that time zone. If this parameter is omitted, then the time zone inferred from the user's source IP is used to evaluate the rule. If Gateway cannot determine the time zone from the IP, we will fall back to the time zone of the user's connected data center.","example":"America/New York","type":"string"},"tue":{"description":"The time intervals when the rule will be active on Tuesdays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Tuesdays.","example":"08:00-12:30,13:30-17:00","type":"string"},"wed":{"description":"The time intervals when the rule will be active on Wednesdays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Wednesdays.","example":"08:00-12:30,13:30-17:00","type":"string"}},"type":"object"},"schedule-6SyTxxBD":{"description":"Polling frequency for the WARP client posture check. Default: `5m` (poll every five minutes). Minimum: `1m`.","example":"1h","type":"string"},"schedule-kOC57cA0":{"description":"Polling frequency for the WARP client posture check. Default: `5m` (poll every five minutes). Minimum: `1m`.","example":"1h","type":"string"},"schema_response_discovery":{"allOf":[{"$ref":"#/components/schemas/default_response"},{"properties":{"result":{"properties":{"schemas":{"items":{"$ref":"#/components/schemas/openapi"},"type":"array"},"timestamp":{"type":"string"}},"type":"object"}}}]},"schema_response_with_thresholds":{"allOf":[{"$ref":"#/components/schemas/default_response"},{"properties":{"result":{"properties":{"schemas":{"items":{"$ref":"#/components/schemas/openapiwiththresholds"},"type":"array"},"timestamp":{"type":"string"}},"type":"object"}}}]},"schemas-access_seat":{"description":"True if the user has authenticated with Cloudflare Access.","example":false,"type":"boolean"},"schemas-account":{"allOf":[{"$ref":"#/components/schemas/account"}],"readOnly":true},"schemas-account_identifier":{"description":"Account identifier tag.","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"schemas-action":{"anyOf":[{"properties":{"mode":{"$ref":"#/components/schemas/mode"},"response":{"$ref":"#/components/schemas/custom_response"},"timeout":{"$ref":"#/components/schemas/timeout-QN7vNkTu"}},"type":"object"}],"description":"The action to perform when the threshold of matched traffic within the configured period is exceeded.","type":"object"},"schemas-action_parameters":{"description":"The parameters configuring the action.","oneOf":[{"$ref":"#/components/schemas/action_parameters_route"}],"type":"object"},"schemas-address":{"description":"Address.","example":"123 Sesame St.","type":"string"},"schemas-advertised":{"description":"Enablement of prefix advertisement to the Internet.","example":true,"type":"boolean"},"schemas-alert_type":{"description":"Type of notification that has been dispatched.","example":"universal_ssl_event_type","type":"string"},"schemas-allowed":{"default":false,"description":"The result of the authentication event.","type":"boolean"},"schemas-api-response-common":{"properties":{"errors":{"$ref":"#/components/schemas/messages"},"messages":{"$ref":"#/components/schemas/messages"},"result":{"anyOf":[{"type":"object"},{"items":{},"type":"array"},{"type":"string"}]},"success":{"description":"Whether the API call was successful","enum":[true],"example":true,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"schemas-api-response-common-failure":{"properties":{"errors":{"allOf":[{"$ref":"#/components/schemas/messages"}],"example":[{"code":7003,"message":"No route for the URI"}],"minLength":1},"messages":{"allOf":[{"$ref":"#/components/schemas/messages"}],"example":[]},"result":{"enum":[null],"nullable":true,"type":"object"},"success":{"description":"Whether the API call was successful","enum":[false],"example":false,"type":"boolean"}},"required":["success","errors","messages","result"],"type":"object"},"schemas-api-response-single-id":{"allOf":[{"$ref":"#/components/schemas/schemas-api-response-common"},{"properties":{"result":{"nullable":true,"properties":{"id":{"$ref":"#/components/schemas/schemas-identifier"}},"required":["id"],"type":"object"}}}],"type":"object"},"schemas-app_launcher_visible":{"description":"Displays the application in the App Launcher.","example":true,"type":"boolean"},"schemas-apps":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/schemas-self_hosted_props"}],"title":"Self Hosted Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/saas_props"}],"title":"SaaS Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/schemas-ssh_props"}],"title":"Browser SSH Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/schemas-vnc_props"}],"title":"Browser VNC Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/app_launcher_props"}],"title":"App Launcher Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/warp_props"}],"title":"Device Enrollment Permissions Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/biso_props"}],"title":"Browser Isolation Permissions Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/schemas-bookmark_props"}],"title":"Bookmark application","type":"object"}],"type":"object"},"schemas-apps-DgI9Bh95":{"anyOf":[{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props-4oEch10U"},{"$ref":"#/components/schemas/self_hosted_props-pFu7lQyL"}],"title":"Self Hosted Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props-4oEch10U"},{"$ref":"#/components/schemas/saas_props-3mDdjpPa"}],"title":"SaaS Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props-4oEch10U"},{"$ref":"#/components/schemas/ssh_props"}],"title":"Browser SSH Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props-4oEch10U"},{"$ref":"#/components/schemas/vnc_props"}],"title":"Browser VNC Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props-4oEch10U"},{"$ref":"#/components/schemas/app_launcher_props"}],"title":"App Launcher Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props-4oEch10U"},{"$ref":"#/components/schemas/warp_props"}],"title":"Device Enrollment Permissions Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props-4oEch10U"},{"$ref":"#/components/schemas/biso_props"}],"title":"Browser Isolation Permissions Application","type":"object"},{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props-4oEch10U"},{"$ref":"#/components/schemas/schemas-bookmark_props-ygkj2JJN"}],"title":"Bookmark application","type":"object"}],"type":"object"},"schemas-asn":{"description":"AS number associated with the node object.","type":"string"},"schemas-aud":{"description":"Audience tag.","example":"737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893","maxLength":64,"readOnly":true,"type":"string"},"schemas-auto_redirect_to_identity":{"default":false,"description":"When set to `true`, users skip the identity provider selection step during login. You must specify only one identity provider in allowed_idps.","type":"boolean"},"schemas-automatic_platform_optimization":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["automatic_platform_optimization"],"example":"automatic_platform_optimization"},"value":{"$ref":"#/components/schemas/automatic_platform_optimization"}}}],"description":"[Automatic Platform Optimization for WordPress](https://developers.cloudflare.com/automatic-platform-optimization/) serves your WordPress site from Cloudflare's edge network and caches third-party fonts.","title":"Automatic Platform Optimization for WordPress"},"schemas-available":{"description":"Shows if a domain is available for transferring into Cloudflare Registrar.","example":false,"type":"boolean"},"schemas-azureAD":{"allOf":[{"$ref":"#/components/schemas/schemas-identity-provider"},{"properties":{"config":{"allOf":[{"$ref":"#/components/schemas/generic-oauth-config"},{"properties":{"directory_id":{"description":"Your Azure directory uuid","example":"\u003cyour azure directory uuid\u003e","type":"string"},"support_groups":{"description":"Should Cloudflare try to load groups from your account","type":"boolean"}},"type":"object"}]}},"type":"object"}],"title":"Azure AD","type":"object"},"schemas-base":{"properties":{"id":{"description":"Identifier of the zone setting.","example":"development_mode","type":"string"},"modified_on":{"description":"last time this setting was modified.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"}},"required":["id","modified_on"]},"schemas-bookmark_props":{"properties":{"app_launcher_visible":{"default":true},"domain":{"description":"The URL or domain of the bookmark.","example":"https://mybookmark.com"},"logo_url":{"$ref":"#/components/schemas/logo_url"},"name":{"$ref":"#/components/schemas/apps_components-schemas-name"},"type":{"description":"The application type.","example":"bookmark","type":"string"}},"required":["type","domain"],"title":"Bookmark Application","type":"object"},"schemas-bookmark_props-ygkj2JJN":{"properties":{"app_launcher_visible":{"default":true},"domain":{"description":"The URL or domain of the bookmark.","example":"https://mybookmark.com"},"logo_url":{"$ref":"#/components/schemas/logo_url"},"name":{"$ref":"#/components/schemas/apps_components-schemas-name"},"type":{"description":"The application type.","example":"bookmark","type":"string"}},"title":"Bookmark Application","type":"object"},"schemas-ca":{"properties":{"aud":{"$ref":"#/components/schemas/aud"},"id":{"$ref":"#/components/schemas/ca_components-schemas-id"},"public_key":{"$ref":"#/components/schemas/public_key-xgmH3SVX"}},"type":"object"},"schemas-can_delete":{"description":"Controls whether the membership can be deleted via the API or not.","example":true,"type":"boolean"},"schemas-centrify":{"allOf":[{"$ref":"#/components/schemas/schemas-identity-provider"},{"properties":{"config":{"allOf":[{"$ref":"#/components/schemas/generic-oauth-config"},{"properties":{"centrify_account":{"description":"Your centrify account url","example":"https://abc123.my.centrify.com/","type":"string"},"centrify_app_id":{"description":"Your centrify app id","example":"exampleapp","type":"string"}},"type":"object"}]}},"type":"object"}],"title":"Centrify","type":"object"},"schemas-certificate":{"description":"The zone's SSL certificate or SSL certificate and intermediate(s).","example":"-----BEGIN CERTIFICATE----- MIIDtTCCAp2gAwIBAgIJAM15n7fdxhRtMA0GCSqGSIb3DQEBBQUAMEUxCzAJBgNV BAYTAlVTMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX aWRnaXRzIFB0eSBMdGQwHhcNMTQwMzExMTkyMTU5WhcNMTQwNDEwMTkyMTU5WjBF MQswCQYDVQQGEwJVUzETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50 ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB CgKCAQEAvq3sKsHpeduJHimOK+fvQdKsI8z8A05MZyyLp2/R/GE8FjNv+hkVY1WQ LIyTNNQH7CJecE1nbTfo8Y56S7x/rhxC6/DJ8MIulapFPnorq46KU6yRxiM0MQ3N nTJHlHA2ozZta6YBBfVfhHWl1F0IfNbXCLKvGwWWMbCx43OfW6KTkbRnE6gFWKuO fSO5h2u5TaWVuSIzBvYs7Vza6m+gtYAvKAJV2nSZ+eSEFPDo29corOy8+huEOUL8 5FAw4BFPsr1TlrlGPFitduQUHGrSL7skk1ESGza0to3bOtrodKei2s9bk5MXm7lZ qI+WZJX4Zu9+mzZhc9pCVi8r/qlXuQIDAQABo4GnMIGkMB0GA1UdDgQWBBRvavf+ sWM4IwKiH9X9w1vl6nUVRDB1BgNVHSMEbjBsgBRvavf+sWM4IwKiH9X9w1vl6nUV RKFJpEcwRTELMAkGA1UEBhMCVVMxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV BAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAM15n7fdxhRtMAwGA1UdEwQF MAMBAf8wDQYJKoZIhvcNAQEFBQADggEBABY2ZzBaW0dMsAAT7tPJzrVWVzQx6KU4 UEBLudIlWPlkAwTnINCWR/8eNjCCmGA4heUdHmazdpPa8RzwOmc0NT1NQqzSyktt vTqb4iHD7+8f9MqJ9/FssCfTtqr/Qst/hGH4Wmdf1EJ/6FqYAAb5iRlPgshFZxU8 uXtA8hWn6fK6eISD9HBdcAFToUvKNZ1BIDPvh9f95Ine8ar6yGd56TUNrHR8eHBs ESxz5ddVR/oWRysNJ+aGAyYqHS8S/ttmC7r4XCAHqXptkHPCGRqkAhsterYhd4I8 /cBzejUobNCjjHFbtkAL/SjxZOLW+pNkZwfeYdM8iPkD54Uua1v2tdw= -----END CERTIFICATE-----","type":"string"},"schemas-certificateObject":{"properties":{"certificate":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate"},"expires_on":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-expires_on"},"id":{"$ref":"#/components/schemas/identifier-tZwYoMuc"},"issuer":{"$ref":"#/components/schemas/issuer"},"serial_number":{"$ref":"#/components/schemas/serial_number"},"signature":{"$ref":"#/components/schemas/signature"},"status":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-status"},"uploaded_on":{"$ref":"#/components/schemas/components-schemas-uploaded_on"}}},"schemas-certificateObject-otmSOZma":{"properties":{"certificate":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate"},"expires_on":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-expires_on"},"id":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier"},"issuer":{"$ref":"#/components/schemas/issuer"},"serial_number":{"$ref":"#/components/schemas/serial_number"},"signature":{"$ref":"#/components/schemas/signature"},"status":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-status"},"uploaded_on":{"$ref":"#/components/schemas/components-schemas-uploaded_on"}}},"schemas-certificate_authority":{"description":"Certificate Authority selected for the order. Selecting Let's Encrypt will reduce customization of other fields: validation_method must be 'txt', validity_days must be 90, cloudflare_branding must be omitted, and hosts must contain only 2 entries, one for the zone name and one for the subdomain wildcard of the zone name (e.g. example.com, *.example.com).","enum":["digicert","google","lets_encrypt"],"example":"digicert","type":"string"},"schemas-certificate_authority-mu8utRU0":{"description":"The Certificate Authority that Total TLS certificates will be issued through.","enum":["google","lets_encrypt"],"example":"google","type":"string"},"schemas-certificate_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/certificates-M6ivZ4vU"},"type":"array"}},"type":"object"}]},"schemas-certificate_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}},"type":"object"}]},"schemas-certificates":{"description":"The uploaded root CA certificate.","example":"-----BEGIN CERTIFICATE-----\nMIIDmDCCAoCgAwIBAgIUKTOAZNjcXVZRj4oQt0SHsl1c1vMwDQYJKoZIhvcNAQELBQAwUTELMAkGA1UEBhMCVVMxFjAUBgNVBAgMDVNhbiBGcmFuY2lzY28xEzARBgNVBAcMCkNhbGlmb3JuaWExFTATBgNVBAoMDEV4YW1wbGUgSW5jLjAgFw0yMjExMjIxNjU5NDdaGA8yMTIyMTAyOTE2NTk0N1owUTELMAkGA1UEBhMCVVMxFjAUBgNVBAgMDVNhbiBGcmFuY2lzY28xEzARBgNVBAcMCkNhbGlmb3JuaWExFTATBgNVBAoMDEV4YW1wbGUgSW5jLjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMRcORwgJFTdcG/2GKI+cFYiOBNDKjCZUXEOvXWY42BkH9wxiMT869CO+enA1w5pIrXow6kCM1sQspHHaVmJUlotEMJxyoLFfA/8Kt1EKFyobOjuZs2SwyVyJ2sStvQuUQEosULZCNGZEqoH5g6zhMPxaxm7ZLrrsDZ9maNGVqo7EWLWHrZ57Q/5MtTrbxQL+eXjUmJ9K3kS+3uEwMdqR6Z3BluU1ivanpPc1CN2GNhdO0/hSY4YkGEnuLsqJyDd3cIiB1MxuCBJ4ZaqOd2viV1WcP3oU3dxVPm4MWyfYIldMWB14FahScxLhWdRnM9YZ/i9IFcLypXsuz7DjrJPtPUCAwEAAaNmMGQwHQYDVR0OBBYEFP5JzLUawNF+c3AXsYTEWHh7z2czMB8GA1UdIwQYMBaAFP5JzLUawNF+c3AXsYTEWHh7z2czMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMBAf8ECDAGAQH/AgEBMA0GCSqGSIb3DQEBCwUAA4IBAQBc+Be7NDhpE09y7hLPZGRPl1cSKBw4RI0XIv6rlbSTFs5EebpTGjhx/whNxwEZhB9HZ7111Oa1YlT8xkI9DshB78mjAHCKBAJ76moK8tkG0aqdYpJ4ZcJTVBB7l98Rvgc7zfTii7WemTy72deBbSeiEtXavm4EF0mWjHhQ5Nxpnp00Bqn5g1x8CyTDypgmugnep+xG+iFzNmTdsz7WI9T/7kDMXqB7M/FPWBORyS98OJqNDswCLF8bIZYwUBEe+bRHFomoShMzaC3tvim7WCb16noDkSTMlfKO4pnvKhpcVdSgwcruATV7y+W+Lvmz2OT/Gui4JhqeoTewsxndhDDE\n-----END CERTIFICATE-----","type":"string"},"schemas-cidr_configuration":{"properties":{"target":{"description":"The configuration target. You must set the target to `ip_range` when specifying an IP address range in the Zone Lockdown rule.","enum":["ip_range"],"example":"ip_range"},"value":{"description":"The IP address range to match. You can only use prefix lengths `/16` and `/24`.","example":"198.51.100.4/16","type":"string"}},"title":"An IP address range configuration."},"schemas-collection_invite_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/schemas-invite"},"type":"array"}},"type":"object"}]},"schemas-collection_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"properties":{"additional_information":{"$ref":"#/components/schemas/additional_information"},"application":{"$ref":"#/components/schemas/application-WiomAg5h"},"content_categories":{"$ref":"#/components/schemas/content_categories"},"domain":{"$ref":"#/components/schemas/schemas-domain_name"},"popularity_rank":{"$ref":"#/components/schemas/popularity_rank"},"risk_score":{"$ref":"#/components/schemas/risk_score"},"risk_types":{"$ref":"#/components/schemas/risk_types"}}},"type":"array"}}}]},"schemas-colo_name":{"description":"The Cloudflare data center used for this connection.","example":"DFW","type":"string"},"schemas-comment":{"description":"Optional remark describing the virtual network.","example":"Staging VPC for data science","type":"string"},"schemas-component_values":{"description":"Array of available components values for the plan.","items":{"$ref":"#/components/schemas/component-value"},"type":"array"},"schemas-config":{"description":"The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).","type":"object"},"schemas-config_request":{"description":"The configuration object containing information for the WARP client to detect the managed network.","example":{"sha256":"b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c","tls_sockaddr":"foo.bar:1234"},"oneOf":[{"$ref":"#/components/schemas/tls_config_request"}],"type":"object"},"schemas-config_response":{"description":"The configuration object containing information for the WARP client to detect the managed network.","example":{"sha256":"b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c","tls_sockaddr":"foo.bar:1234"},"oneOf":[{"$ref":"#/components/schemas/tls_config_response"}],"type":"object"},"schemas-configuration":{"description":"The rule configuration.","oneOf":[{"$ref":"#/components/schemas/ip_configuration"},{"$ref":"#/components/schemas/ipv6_configuration"},{"$ref":"#/components/schemas/cidr_configuration"},{"$ref":"#/components/schemas/asn_configuration"},{"$ref":"#/components/schemas/country_configuration"}],"type":"object"},"schemas-connection":{"description":"The IdP used to authenticate.","example":"saml","type":"string"},"schemas-created":{"description":"When the device was created.","example":"2017-06-14T00:00:00Z","format":"date-time","type":"string"},"schemas-created_at":{"description":"The time when the certificate was created.","example":"2100-01-01T05:20:00Z","format":"date-time","readOnly":true,"type":"string"},"schemas-created_on":{"description":"The date and time the tunnel was created.","example":"2017-06-14T00:00:00Z","format":"date-time","readOnly":true,"type":"string"},"schemas-created_on-KZj9IpMd":{"description":"The RFC 3339 timestamp of when the list was created.","example":"2020-01-01T08:00:00Z","type":"string"},"schemas-csr":{"description":"The Certificate Signing Request (CSR). Must be newline-encoded.","example":"-----BEGIN CERTIFICATE REQUEST-----\\nMIICY....\\n-----END CERTIFICATE REQUEST-----\\n","type":"string"},"schemas-cursor":{"description":"Opaque token indicating the position from which to continue when requesting the next set of records. A valid value for the cursor can be obtained from the cursors object in the result_info structure.","example":"AAAAANuhDN7SjacTnSVsDu3WW1Lvst6dxJGTjRY5BhxPXdf6L6uTcpd_NVtjhn11OUYRsVEykxoUwF-JQU4dn6QylZSKTOJuG0indrdn_MlHpMRtsxgXjs-RPdHYIVm3odE_uvEQ_dTQGFm8oikZMohns34DLBgrQpc","type":"string"},"schemas-default":{"description":"Whether the policy is the default policy for an account.","example":false,"type":"boolean"},"schemas-deleted":{"description":"True if the device was deleted.","example":true,"type":"boolean"},"schemas-description":{"description":"The description of the Rule.","example":"Block the bad websites based on host name","type":"string"},"schemas-description-Fsn87iOz":{"description":"An optional description field which may be used to describe the types of IPs or zones on the map.","example":"My Ecommerce zones","nullable":true,"type":"string"},"schemas-description-MUzoo3Z3":{"description":"The billing item description.","example":"The billing item description","maxLength":255,"readOnly":true,"type":"string"},"schemas-description-SitV9b51":{"description":"An optional description of the GRE tunnel.","example":"Tunnel for ISP X","type":"string"},"schemas-description-XvtZaN2T":{"description":"A human-readable description of the pool.","example":"Primary data center - Provider XYZ","type":"string"},"schemas-description-jdg4o19i":{"description":"A description of the policy.","example":"Policy for test teams.","maxLength":500,"type":"string"},"schemas-description_search":{"description":"A string to search for in the description of existing rules.","example":"endpoints","type":"string"},"schemas-destination_conf":{"description":"Unique WebSocket address that will receive messages from Cloudflare’s edge.","example":"wss://logs.cloudflare.com/instant-logs/ws/sessions/99d471b1ca3c23cc8e30b6acec5db987","format":"uri","maxLength":4096,"type":"string"},"schemas-disabled_at":{"description":"This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at.","format":"date-time","readOnly":true,"type":"string"},"schemas-dns-firewall":{"allOf":[{"$ref":"#/components/schemas/dns-firewall"}],"type":"object"},"schemas-domain":{"description":"The domain of the Bookmark application.","example":"example.com","type":"string"},"schemas-domain-N8byIUtr":{"description":"The domain and path that Access will secure.","example":"test.example.com/admin","type":"string"},"schemas-domain_identifier":{"description":"Domain identifier.","example":"ea95132c15732412d22c1476fa83f27a","maxLength":32,"readOnly":true,"type":"string"},"schemas-domain_name":{"example":"cloudflare.com","type":"string"},"schemas-email":{"description":"The email of the user.","example":"jdoe@example.com","format":"email","type":"string"},"schemas-email-EQUZrKsL":{"description":"The email address of the authenticating user.","example":"user@example.com","format":"email","type":"string"},"schemas-empty_response":{"allOf":[{"properties":{"result":{"nullable":true,"type":"object"},"success":{"enum":[true,false],"example":true,"type":"boolean"}}}]},"schemas-empty_response-raiSSReB":{"allOf":[{"properties":{"result":{"nullable":true},"success":{"enum":[true,false],"example":true,"type":"boolean"}}}]},"schemas-enabled":{"description":"Disabling Universal SSL removes any currently active Universal SSL certificates for your zone from the edge and prevents any future Universal SSL certificates from being ordered. If there are no advanced certificates or custom certificates uploaded for the domain, visitors will be unable to access the domain over HTTPS.\n\nBy disabling Universal SSL, you understand that the following Cloudflare settings and preferences will result in visitors being unable to visit your domain unless you have uploaded a custom certificate or purchased an advanced certificate.\n\n* HSTS\n* Always Use HTTPS\n* Opportunistic Encryption\n* Onion Routing\n* Any Page Rules redirecting traffic to HTTPS\n\nSimilarly, any HTTP redirect to HTTPS at the origin while the Cloudflare proxy is enabled will result in users being unable to visit your site without a valid certificate at Cloudflare's edge.\n\nIf you do not have a valid custom or advanced certificate at Cloudflare's edge and are unsure if any of the above Cloudflare settings are enabled, or if any HTTP redirects exist at your origin, we advise leaving Universal SSL enabled for your domain.","example":true,"type":"boolean"},"schemas-enabled-ItkBt4kJ":{"default":true,"description":"Whether to enable (the default) this origin within the pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool.","example":true,"type":"boolean"},"schemas-exclude":{"description":"Rules evaluated with a NOT logical operator. To match the policy, a user cannot meet any of the Exclude rules.","items":{"$ref":"#/components/schemas/rule"},"type":"array"},"schemas-exclude-NRBuYW2u":{"description":"Rules evaluated with a NOT logical operator. To match the policy, a user cannot meet any of the Exclude rules.","items":{"$ref":"#/components/schemas/rule_components-schemas-rule"},"type":"array"},"schemas-expected_codes":{"default":"200","description":"The expected HTTP response codes or code ranges of the health check, comma-separated. This parameter is only valid for HTTP and HTTPS monitors.","example":"2xx","type":"string"},"schemas-expiration":{"description":"Sets the expiration time for a posture check result. If empty, the result remains valid until it is overwritten by new data from the WARP client.","example":"1h","type":"string"},"schemas-expires_on":{"description":"When the certificate will expire.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string"},"schemas-expires_on-SFzDZ8Kt":{"description":"When the invite is no longer active.","example":"2014-01-01T05:20:00Z","format":"date-time","readOnly":true,"type":"string"},"schemas-expression":{"description":"The expression defining which traffic will match the rule.","example":"ip.src ne 1.1.1.1","type":"string"},"schemas-facebook":{"allOf":[{"$ref":"#/components/schemas/schemas-identity-provider"},{"properties":{"config":{"$ref":"#/components/schemas/generic-oauth-config"}},"type":"object"}],"title":"Facebook","type":"object"},"schemas-features":{"description":"Features enabled for the Cloudflare Tunnel.","items":{"example":"ha-origin","type":"string"},"type":"array"},"schemas-filter-response-collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"allOf":[{"$ref":"#/components/schemas/filter-k8oSIkrx"},{"required":["id","expression","paused"],"type":"object"}]},"type":"array"}},"type":"object"}]},"schemas-filter-response-single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"oneOf":[{"allOf":[{"$ref":"#/components/schemas/filter-k8oSIkrx"},{"required":["id","expression","paused"],"type":"object"}]},{"nullable":true}]}},"required":["result"],"type":"object"}]},"schemas-filter_options":{"description":"Format of additional configuration options (filters) for the alert type. Data type of filters during policy creation: Array of strings.","example":[{"ComparisonOperator":"==","Key":"zones","Optional":false},{"ComparisonOperator":"\u003e=","Key":"slo","Optional":true}],"items":{},"type":"array"},"schemas-filters":{"properties":{"configuration.target":{"description":"The target to search in existing rules.","enum":["ip","ip_range","asn","country"],"example":"ip","type":"string"},"configuration.value":{"description":"The target value to search for in existing rules: an IP address, an IP address range, or a country code, depending on the provided `configuration.target`.\nNotes: You can search for a single IPv4 address, an IP address range with a subnet of '/16' or '/24', or a two-letter ISO-3166-1 alpha-2 country code.","example":"198.51.100.4","type":"string"},"match":{"default":"all","description":"When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match.","enum":["any","all"],"type":"string"},"mode":{"$ref":"#/components/schemas/schemas-mode"},"notes":{"description":"The string to search for in the notes of existing IP Access rules.\nNotes: For example, the string 'attack' would match IP Access rules with notes 'Attack 26/02' and 'Attack 27/02'. The search is case insensitive.","example":"my note","type":"string"}},"type":"object"},"schemas-force_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/schemas-force_result"}}}]},"schemas-force_result":{"description":"When force_notify query parameter is set to true, the response is a simple string","example":"OK","type":"string"},"schemas-frequency":{"description":"The frequency at which you will be billed for this plan.","enum":["weekly","monthly","quarterly","yearly"],"example":"monthly","readOnly":true,"type":"string"},"schemas-gateway_seat":{"description":"True if the user has logged into the WARP client.","example":false,"type":"boolean"},"schemas-github":{"allOf":[{"$ref":"#/components/schemas/schemas-identity-provider"},{"properties":{"config":{"$ref":"#/components/schemas/generic-oauth-config"}},"type":"object"}],"title":"GitHub","type":"object"},"schemas-google":{"allOf":[{"$ref":"#/components/schemas/schemas-identity-provider"},{"properties":{"config":{"$ref":"#/components/schemas/generic-oauth-config"}},"type":"object"}],"title":"Google","type":"object"},"schemas-google-apps":{"allOf":[{"$ref":"#/components/schemas/schemas-identity-provider"},{"properties":{"config":{"allOf":[{"$ref":"#/components/schemas/generic-oauth-config"},{"properties":{"apps_domain":{"description":"Your companies TLD","example":"mycompany.com","type":"string"}},"type":"object"}]}},"type":"object"}],"title":"Google Workspace","type":"object"},"schemas-group":{"allOf":[{"$ref":"#/components/schemas/group"},{"properties":{"allowed_modes":{"$ref":"#/components/schemas/allowed_modes"},"mode":{"$ref":"#/components/schemas/components-schemas-mode"}}}],"required":["id","name","description","mode","rules_count"],"type":"object"},"schemas-groups":{"properties":{"created_at":{"$ref":"#/components/schemas/timestamp"},"exclude":{"$ref":"#/components/schemas/exclude-TaQDb77a"},"id":{"$ref":"#/components/schemas/schemas-uuid-vgvRNXQL"},"include":{"$ref":"#/components/schemas/include-6K7SmqAm"},"name":{"$ref":"#/components/schemas/groups_components-schemas-name"},"require":{"$ref":"#/components/schemas/require-SpDpRST8"},"updated_at":{"$ref":"#/components/schemas/timestamp"}},"type":"object"},"schemas-header":{"description":"The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'.","properties":{"Host":{"$ref":"#/components/schemas/Host"}},"type":"object"},"schemas-health_check":{"properties":{"enabled":{"default":true,"description":"Determines whether to run healthchecks for a tunnel.","example":true,"type":"boolean"},"rate":{"default":"mid","description":"How frequent the health check is run. The default value is `mid`.","enum":["low","mid","high"],"example":"low","type":"string"},"target":{"description":"The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`.","example":"203.0.113.1","type":"string"},"type":{"default":"reply","description":"The type of healthcheck to run, reply or request. The default value is `reply`.","enum":["reply","request"],"example":"request","type":"string"}},"type":"object"},"schemas-host":{"description":"The keyless SSL name.","example":"example.com","format":"hostname","maxLength":253,"type":"string"},"schemas-hostname":{"description":"The hostname on the origin for which the client certificate uploaded will be used.","example":"app.example.com","maxLength":255,"type":"string"},"schemas-hosts":{"description":"Comma separated list of valid host names for the certificate packs. Must contain the zone apex, may not contain more than 50 hosts, and may not be empty.","example":["example.com","*.example.com","www.example.com"],"items":{"type":"string"},"type":"array"},"schemas-id":{"description":"The ID of the user.","example":"f3b12456-80dd-4e89-9f5f-ba3dfff12365"},"schemas-id-OWr6ZoMG":{"description":"Identifier for the tail.","example":"03dc9f77817b488fb26c5861ec18f791","type":"string"},"schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/schemas-identifier-03kXbNiE"}},"type":"object"}}}]},"schemas-id_response-77ATe4Eu":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/id-e2D1eWah"}},"type":"object"}}}]},"schemas-id_response-CtbIGMqm":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/pool_components-schemas-identifier"}},"type":"object"}}}]},"schemas-id_response-ZaI3kQGy":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"nullable":true}}}]},"schemas-id_response-n8mMAIdf":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/schemas-identifier-LDS3pdXe"}},"type":"object"}}}]},"schemas-identifier":{"description":"Identifier","example":"023e105f4ecef8ad9ca31a8372d0c353","maxLength":32,"readOnly":true,"type":"string"},"schemas-identifier-03kXbNiE":{"example":"69cd1e104af3e6ed3cb344f263fd0d5a","readOnly":true},"schemas-identifier-3n9sRq0H":{},"schemas-identifier-67y1Mk1I":{"description":"Tunnel identifier tag.","example":"c4a7362d577a6c3019a474fd6f485821","maxLength":32,"readOnly":true,"type":"string"},"schemas-identifier-LDS3pdXe":{"example":"17b5962d775c646f3f9725cbc7a53df4"},"schemas-identifier-f8xN4YrK":{"description":"Keyless certificate identifier tag.","example":"4d2844d2ce78891c34d0b6c0535a291e","maxLength":32,"readOnly":true,"type":"string"},"schemas-identity-provider":{"properties":{"config":{"description":"The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).","type":"object"},"id":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"},"name":{"$ref":"#/components/schemas/schemas-name-QA00iN6H"},"scim_config":{"description":"The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.","properties":{"enabled":{"description":"A flag to enable or disable SCIM for the identity provider.","type":"boolean"},"group_member_deprovision":{"description":"A flag to revoke a user's session in Access and force a reauthentication on the user's Gateway session when they have been added or removed from a group in the Identity Provider.","type":"boolean"},"seat_deprovision":{"description":"A flag to remove a user's seat in Zero Trust when they have been deprovisioned in the Identity Provider. This cannot be enabled unless user_deprovision is also enabled.","type":"boolean"},"secret":{"description":"A read-only token generated when the SCIM integration is enabled for the first time. It is redacted on subsequent requests. If you lose this you will need to refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.","type":"string"},"user_deprovision":{"description":"A flag to enable revoking a user's session in Access and Gateway when they have been deprovisioned in the Identity Provider.","type":"boolean"}},"type":"object"},"type":{"description":"The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).","example":"onetimepin","type":"string"}},"required":["name","type","config"],"type":"object"},"schemas-identity-providers":{"oneOf":[{"$ref":"#/components/schemas/schemas-azureAD"},{"$ref":"#/components/schemas/schemas-centrify"},{"$ref":"#/components/schemas/schemas-facebook"},{"$ref":"#/components/schemas/schemas-github"},{"$ref":"#/components/schemas/schemas-google"},{"$ref":"#/components/schemas/schemas-google-apps"},{"$ref":"#/components/schemas/schemas-linkedin"},{"$ref":"#/components/schemas/schemas-oidc"},{"$ref":"#/components/schemas/schemas-okta"},{"$ref":"#/components/schemas/schemas-onelogin"},{"$ref":"#/components/schemas/schemas-pingone"},{"$ref":"#/components/schemas/schemas-saml"},{"$ref":"#/components/schemas/schemas-yandex"}]},"schemas-include":{"items":{"$ref":"#/components/schemas/split_tunnel_include"},"type":"array"},"schemas-interval":{"description":"The interval between each posture check with the third party API. Use \"m\" for minutes (e.g. \"5m\") and \"h\" for hours (e.g. \"12h\").","example":"10m","type":"string"},"schemas-invite":{"allOf":[{"$ref":"#/components/schemas/user_invite"}],"type":"object"},"schemas-ip":{"description":"The IP address of the authenticating user.","example":"198.41.129.166","type":"string"},"schemas-ip_configuration":{"properties":{"target":{"description":"The configuration target. You must set the target to `ip` when specifying an IP address in the Zone Lockdown rule.","enum":["ip"],"example":"ip"},"value":{"description":"The IP address to match. This address will be compared to the IP address of incoming requests.","example":"198.51.100.4","type":"string"}},"title":"An IP address configuration."},"schemas-ips":{"description":"The set of IPs on the Address Map.","items":{"$ref":"#/components/schemas/address-maps-ip"},"type":"array"},"schemas-issuer":{"description":"The certificate authority that issued the certificate.","example":"O=Example Inc.,L=California,ST=San Francisco,C=US","readOnly":true,"type":"string"},"schemas-key":{"description":"The device's public key.","example":"yek0SUYoOQ10vMGsIYAevozXUQpQtNFJFfFGqER/BGc=","type":"string"},"schemas-kind":{"description":"The kind of the ruleset.","enum":["custom","root","zone"],"example":"root","type":"string"},"schemas-last_updated":{"description":"The timestamp of when the rule was last modified.","example":"2000-01-01T00:00:00.000000Z","type":"string"},"schemas-linkedin":{"allOf":[{"$ref":"#/components/schemas/schemas-identity-provider"},{"properties":{"config":{"$ref":"#/components/schemas/generic-oauth-config"}},"type":"object"}],"title":"LinkedIn","type":"object"},"schemas-match":{"description":"The conditions that the client must match to run the rule.","items":{"$ref":"#/components/schemas/match_item"},"type":"array"},"schemas-match-ImQchlrH":{"description":"The wirefilter expression to match devices.","example":"user.identity == \"test@cloudflare.com\"","maxLength":500,"type":"string"},"schemas-member":{"allOf":[{"$ref":"#/components/schemas/member"}]},"schemas-metadata":{"description":"What EXIF data should be preserved in the output image.","enum":["keep","copyright","none"],"example":"none","type":"string"},"schemas-method":{"default":"GET","description":"The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.","example":"GET","type":"string"},"schemas-mode":{"description":"The action to apply to a matched request.","enum":["block","challenge","whitelist","js_challenge","managed_challenge"],"example":"challenge","type":"string"},"schemas-modified_on":{"description":"The date and time the tunnel was last modified.","example":"2017-06-14T05:20:00Z","format":"date-time","readOnly":true,"type":"string"},"schemas-modified_on-DUFYxWOX":{"description":"The timestamp of when the Page Rule was last modified.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string"},"schemas-modified_on-lfwlFlJl":{"description":"When the certificate was last modified.","example":"2014-01-01T05:20:00Z","format":"date-time","readOnly":true,"type":"string"},"schemas-modified_tunnels_collection_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"modified":{"example":true,"type":"boolean"},"modified_ipsec_tunnels":{"items":{"$ref":"#/components/schemas/ipsec-tunnel"},"type":"array"}}}}}]},"schemas-monitor":{"description":"The ID of the Monitor to use for checking the health of origins within this pool."},"schemas-mtu":{"default":1476,"description":"The Maximum Transmission Unit (MTU) in bytes for the interconnect. The minimum value is 576.","type":"integer"},"schemas-name":{"description":"The name of the Location.","example":"Austin Office Location","type":"string"},"schemas-name-1UDkXCXq":{"description":"The device name.","example":"My mobile device","type":"string"},"schemas-name-F4rYvN2r":{"description":"Optional unique name for the certificate. Only used for human readability.","example":"example_ca_cert","type":"string"},"schemas-name-QA00iN6H":{"description":"The name of the identity provider, shown to users on the login page.","example":"Widget Corps IDP","type":"string"},"schemas-name-Tf4rbdAh":{"description":"A human-identifiable name for the origin.","example":"app-server-1","type":"string"},"schemas-name-Usb6SCq8":{"description":"Organization name.","example":"Cloudflare, Inc.","maxLength":100,"type":"string"},"schemas-name-m2fEJLlJ":{"description":"The name of the IPsec tunnel. The name cannot share a name with other tunnels.","example":"IPsec_1","type":"string"},"schemas-name-rmJQq4HY":{"description":"TSIG key name.","example":"tsig.customer.cf.","type":"string"},"schemas-namespace":{"properties":{"class":{"readOnly":true},"id":{"readOnly":true},"name":{"readOnly":true},"script":{"readOnly":true}},"type":"object"},"schemas-oidc":{"allOf":[{"$ref":"#/components/schemas/schemas-identity-provider"},{"properties":{"config":{"allOf":[{"$ref":"#/components/schemas/generic-oauth-config"},{"properties":{"auth_url":{"description":"The authorization_endpoint URL of your IdP","example":"https://accounts.google.com/o/oauth2/auth","type":"string"},"certs_url":{"description":"The jwks_uri endpoint of your IdP to allow the IdP keys to sign the tokens","example":"https://www.googleapis.com/oauth2/v3/certs","type":"string"},"claims":{"description":"List of custom claims that will be pulled from your id_token and added to your signed Access JWT token.","example":["given_name","locale"],"items":{"type":"string"},"type":"array"},"scopes":{"description":"OAuth scopes","example":["openid","email","profile"],"items":{"type":"string"},"type":"array"},"token_url":{"description":"The token_endpoint URL of your IdP","example":"https://accounts.google.com/o/oauth2/token","type":"string"}},"type":"object"}]}},"type":"object"}],"title":"Generic OAuth","type":"object"},"schemas-okta":{"allOf":[{"$ref":"#/components/schemas/schemas-identity-provider"},{"properties":{"config":{"allOf":[{"$ref":"#/components/schemas/generic-oauth-config"},{"properties":{"okta_account":{"description":"Your okta account url","example":"https://dev-abc123.oktapreview.com","type":"string"}},"type":"object"}]}},"type":"object"}],"title":"Okta","type":"object"},"schemas-onelogin":{"allOf":[{"$ref":"#/components/schemas/schemas-identity-provider"},{"properties":{"config":{"allOf":[{"$ref":"#/components/schemas/generic-oauth-config"},{"properties":{"onelogin_account":{"description":"Your OneLogin account url","example":"https://mycompany.onelogin.com","type":"string"}},"type":"object"}]}},"type":"object"}],"title":"OneLogin","type":"object"},"schemas-operation":{"properties":{"completed":{"description":"The RFC 3339 timestamp of when the operation was completed.","example":"2020-01-01T08:00:00Z","readOnly":true,"type":"string"},"error":{"description":"A message describing the error when the status is `failed`.","example":"This list is at the maximum number of items","readOnly":true,"type":"string"},"id":{"$ref":"#/components/schemas/operation_id"},"status":{"description":"The current status of the asynchronous operation.","enum":["pending","running","completed","failed"],"example":"failed","readOnly":true,"type":"string"}},"required":["id","status"],"type":"object"},"schemas-options":{"example":{"max_ttl":15,"packet_type":"icmp"},"properties":{"max_ttl":{"$ref":"#/components/schemas/max_ttl"},"packet_type":{"$ref":"#/components/schemas/packet_type"},"packets_per_ttl":{"$ref":"#/components/schemas/packets_per_ttl"},"port":{"$ref":"#/components/schemas/traceroute_components-schemas-port"},"wait_time":{"$ref":"#/components/schemas/wait_time"}}},"schemas-organization":{"description":"Name of organization.","example":"Cloudflare, Inc.","type":"string"},"schemas-origin":{"properties":{"address":{"$ref":"#/components/schemas/address-SVXLSyuc"},"disabled_at":{"$ref":"#/components/schemas/disabled_at"},"enabled":{"$ref":"#/components/schemas/origin_components-schemas-enabled"},"header":{"$ref":"#/components/schemas/schemas-header"},"name":{"$ref":"#/components/schemas/origin_components-schemas-name"},"virtual_network_id":{"$ref":"#/components/schemas/virtual_network_id"},"weight":{"$ref":"#/components/schemas/weight-9aFRWjMy"}},"type":"object"},"schemas-patch":{"description":"Update enablement of Tiered Caching","properties":{"value":{"$ref":"#/components/schemas/components-schemas-value"}},"required":["value"],"type":"object"},"schemas-pattern":{"example":"example.net/*","title":"Filter pattern","type":"string"},"schemas-paused":{"description":"When true, indicates that the rule is currently paused.","example":false,"type":"boolean"},"schemas-per_page":{"description":"Number of results to display.","minimum":1,"type":"number"},"schemas-permissions":{"description":"Access permissions for this User.","items":{"example":"#zones:read","maxLength":160,"type":"string"},"readOnly":true,"type":"array"},"schemas-phase":{"description":"The phase where the ruleset is executed.","enum":["http_request_transform","http_request_late_transform","http_response_headers_transform"],"type":"string"},"schemas-pingone":{"allOf":[{"$ref":"#/components/schemas/schemas-identity-provider"},{"properties":{"config":{"allOf":[{"$ref":"#/components/schemas/generic-oauth-config"},{"properties":{"ping_env_id":{"description":"Your PingOne environment identifier","example":"342b5660-0c32-4936-a5a4-ce21fae57b0a","type":"string"}},"type":"object"}]}},"type":"object"}],"title":"PingOne","type":"object"},"schemas-policies":{"properties":{"approval_groups":{"$ref":"#/components/schemas/approval_groups"},"approval_required":{"$ref":"#/components/schemas/approval_required"},"created_at":{"$ref":"#/components/schemas/timestamp"},"decision":{"$ref":"#/components/schemas/decision"},"exclude":{"$ref":"#/components/schemas/schemas-exclude-NRBuYW2u"},"id":{"$ref":"#/components/schemas/components-schemas-uuid"},"include":{"$ref":"#/components/schemas/include-6K7SmqAm"},"name":{"$ref":"#/components/schemas/policies_components-schemas-name"},"precedence":{"$ref":"#/components/schemas/precedence-3goMFnFD"},"purpose_justification_prompt":{"$ref":"#/components/schemas/purpose_justification_prompt"},"purpose_justification_required":{"$ref":"#/components/schemas/purpose_justification_required"},"require":{"$ref":"#/components/schemas/schemas-require-0qS7IZb9"},"updated_at":{"$ref":"#/components/schemas/timestamp"}},"type":"object"},"schemas-port":{"default":0,"description":"Port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).","type":"integer"},"schemas-port-uAxZ6zJW":{"default":0,"description":"The port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).","type":"integer"},"schemas-precedence":{"description":"The precedence of the policy. Lower values indicate higher precedence. Policies will be evaluated in ascending order of this field.","example":100,"type":"number"},"schemas-preview_id":{"example":"p1aba936b94213e5b8dca0c0dbf1f9cc"},"schemas-price":{"description":"The amount you will be billed for this plan.","example":0,"type":"number"},"schemas-priority":{"description":"The order in which the individual WAF rule is executed within its rule group.","readOnly":true,"type":"string"},"schemas-private_key":{"description":"The hostname certificate's private key.","example":"-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n","type":"string"},"schemas-railgun":{"properties":{"activation":{"$ref":"#/components/schemas/activation"},"created_on":{"$ref":"#/components/schemas/components-schemas-created_on"},"enabled":{"$ref":"#/components/schemas/railgun_components-schemas-enabled"},"id":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"},"modified_on":{"$ref":"#/components/schemas/railgun_components-schemas-modified_on"},"name":{"$ref":"#/components/schemas/railgun_components-schemas-name"},"status":{"$ref":"#/components/schemas/railgun_components-schemas-status"},"upgrade_info":{"$ref":"#/components/schemas/upgrade_info"},"zones_connected":{"$ref":"#/components/schemas/zones_connected"}},"required":["id","name","status","enabled","zones_connected","activation"],"type":"object"},"schemas-railgun_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"type":"object"},"type":"array"}}}]},"schemas-rate-plan":{"allOf":[{"$ref":"#/components/schemas/rate-plan"}],"type":"object"},"schemas-ref":{"description":"A short reference tag. Allows you to select related filters.","example":"FIL-100","maxLength":50,"type":"string"},"schemas-references_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"description":"List of resources that reference a given pool.","example":[{"reference_type":"referrer","resource_id":"699d98642c564d2e855e9661899b7252","resource_name":"www.example.com","resource_type":"load_balancer"},{"reference_type":"referral","resource_id":"f1aba936b94213e5b8dca0c0dbf1f9cc","resource_name":"Login page monitor","resource_type":"monitor"}],"items":{"properties":{"reference_type":{"enum":["*","referral","referrer"],"type":"string"},"resource_id":{"type":"string"},"resource_name":{"type":"string"},"resource_type":{"type":"string"}},"type":"object"},"type":"array"}}}]},"schemas-request_model":{"properties":{"scope":{"$ref":"#/components/schemas/scope-6kSZmzRz"},"type":{"$ref":"#/components/schemas/url_normalization_components-schemas-type"}},"type":"object"},"schemas-requests":{"description":"Breakdown of totals for requests.","properties":{"all":{"description":"Total number of requests served.","type":"integer"},"cached":{"description":"Total number of cached requests served.","type":"integer"},"content_type":{"description":"A variable list of key/value pairs where the key represents the type of content served, and the value is the number of requests.","example":{"css":15343,"gif":23178,"html":1234213,"javascript":318236,"jpeg":1982048},"type":"object"},"country":{"description":"A variable list of key/value pairs where the key is a two-digit country code and the value is the number of requests served to that country.","example":{"AG":37298,"GI":293846,"US":4181364},"type":"object"},"http_status":{"additionalProperties":true,"description":"Key/value pairs where the key is a HTTP status code and the value is the number of requests served with that code.","example":{"200":13496983,"301":283,"400":187936,"402":1828,"404":1293},"type":"object"},"ssl":{"description":"A break down of requests served over HTTPS.","properties":{"encrypted":{"description":"The number of requests served over HTTPS.","type":"integer"},"unencrypted":{"description":"The number of requests served over HTTP.","type":"integer"}},"type":"object"},"ssl_protocols":{"description":"A breakdown of requests by their SSL protocol.","properties":{"TLSv1":{"description":"The number of requests served over TLS v1.0.","type":"integer"},"TLSv1.1":{"description":"The number of requests served over TLS v1.1.","type":"integer"},"TLSv1.2":{"description":"The number of requests served over TLS v1.2.","type":"integer"},"TLSv1.3":{"description":"The number of requests served over TLS v1.3.","type":"integer"},"none":{"description":"The number of requests served over HTTP.","type":"integer"}},"type":"object"},"uncached":{"description":"Total number of requests served from the origin.","type":"integer"}},"type":"object"},"schemas-require":{"description":"Rules evaluated with an AND logical operator. To match the policy, a user must meet all of the Require rules.","items":{"$ref":"#/components/schemas/rule"},"type":"array"},"schemas-require-0qS7IZb9":{"description":"Rules evaluated with an AND logical operator. To match the policy, a user must meet all of the Require rules.","items":{"$ref":"#/components/schemas/rule_components-schemas-rule"},"type":"array"},"schemas-response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/ip_components-schemas-ip"},"type":"array"}}}]},"schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/locations"},"type":"array"}}}]},"schemas-response_collection-4HEckTYK":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/groups"},"type":"array"}}}]},"schemas-response_collection-AREv1gR0":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/peer"},"type":"array"}}}]},"schemas-response_collection-CSlm0TuB":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/device-posture-integrations-Xb3lCexZ"},"type":"array"}}}]},"schemas-response_collection-NmAY72Ue":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/ipam-delegations"},"type":"array"}}}]},"schemas-response_collection-PNoWMjSR":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/pool-Dw5V2rGp"},"type":"array"}}}]},"schemas-response_collection-gsiDzBvh":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"example":[{"id":"7cf72faf220841aabcfdfab81c43c4f6","name":"Billing Read","scopes":["com.cloudflare.api.account"]},{"id":"9d24387c6e8544e2bc4024a03991339f","name":"Load Balancing: Monitors and Pools Read","scopes":["com.cloudflare.api.account"]},{"id":"d2a1802cc9a34e30852f8b33869b2f3c","name":"Load Balancing: Monitors and Pools Write","scopes":["com.cloudflare.api.account"]},{"id":"8b47d2786a534c08a1f94ee8f9f599ef","name":"Workers KV Storage Read","scopes":["com.cloudflare.api.account"]},{"id":"f7f0eda5697f475c90846e879bab8666","name":"Workers KV Storage Write","scopes":["com.cloudflare.api.account"]},{"id":"1a71c399035b4950a1bd1466bbe4f420","name":"Workers Scripts Read","scopes":["com.cloudflare.api.account"]},{"id":"e086da7e2179491d91ee5f35b3ca210a","name":"Workers Scripts Write","scopes":["com.cloudflare.api.account"]}],"items":{"type":"object"},"type":"array"}},"type":"object"}]},"schemas-response_model":{"properties":{"scope":{"$ref":"#/components/schemas/scope-6kSZmzRz"},"type":{"$ref":"#/components/schemas/url_normalization_components-schemas-type"}},"type":"object"},"schemas-response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}},"type":"object"}]},"schemas-result":{"allOf":[{"$ref":"#/components/schemas/result-iSgQlUWZ"},{"properties":{"data":{"example":[{"metrics":[[2,4],[16,32]]}]},"max":{"example":{"readKiB":32,"requests":4}},"min":{"example":{"readKiB":16,"requests":2}},"query":{"$ref":"#/components/schemas/query-ju6G02HL"},"totals":{"example":{"readKiB":48,"requests":6}}}}]},"schemas-role":{"properties":{"description":{"$ref":"#/components/schemas/description-gV3mXO2g"},"id":{"$ref":"#/components/schemas/role_components-schemas-identifier"},"name":{"$ref":"#/components/schemas/components-schemas-name-l3W5RvJP"},"permissions":{"$ref":"#/components/schemas/schemas-permissions"}},"required":["id","name","description","permissions"],"type":"object"},"schemas-rule":{"allOf":[{"$ref":"#/components/schemas/rule-VtwDyToZ"},{"properties":{"scope":{"description":"All zones owned by the user will have the rule applied.","properties":{"email":{"$ref":"#/components/schemas/email-sNyq81Xd"},"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"type":{"description":"The scope of the rule.","enum":["user","organization"],"example":"user","readOnly":true}},"readOnly":true,"type":"object"}}}],"required":["id","mode","allowed_modes","configuration","scope"],"type":"object"},"schemas-rules":{"description":"The list of rules in the ruleset.","items":{"$ref":"#/components/schemas/rules_components-schemas-rule"},"type":"array"},"schemas-ruleset":{"properties":{"description":{"example":""},"id":{"example":"2f2feab2026849078ba485f918791bdc"},"kind":{"example":"zone"},"name":{"example":"default"},"phase":{"example":"http_request_origin"},"rules":{"description":"The rules in the ruleset.","items":{"$ref":"#/components/schemas/origin-rules_components-schemas-rule"},"type":"array"}}},"schemas-saml":{"allOf":[{"$ref":"#/components/schemas/schemas-identity-provider"},{"properties":{"config":{"properties":{"attributes":{"description":"A list of SAML attribute names that will be added to your signed JWT token and can be used in SAML policy rules.","example":["group","department_code","divison"],"items":{"type":"string"},"type":"array"},"email_attribute_name":{"description":"The attribute name for email in the SAML response.","example":"Email","type":"string"},"header_attributes":{"description":"Add a list of attribute names that will be returned in the response header from the Access callback.","items":{"properties":{"attribute_name":{"description":"attribute name from the IDP","type":"string"},"header_name":{"description":"header that will be added on the request to the origin","type":"string"}},"type":"object"},"type":"array"},"idp_public_certs":{"description":"X509 certificate to verify the signature in the SAML authentication response","items":{"type":"string"},"type":"array"},"issuer_url":{"description":"IdP Entity ID or Issuer URL","example":"https://whoami.com","type":"string"},"sign_request":{"description":"Sign the SAML authentication request with Access credentials. To verify the signature, use the public key from the Access certs endpoints.","type":"boolean"},"sso_target_url":{"description":"URL to send the SAML authentication requests to","example":"https://edgeaccess.org/idp/saml/login","type":"string"}},"type":"object"}},"type":"object"}],"title":"Generic SAML","type":"object"},"schemas-script_name":{"description":"Name of the script to apply when the route is matched. The route is skipped when this is blank/missing.","example":"this-is_my_script-01","pattern":"^[a-z0-9_][a-z0-9-_]*$","type":"string"},"schemas-self_hosted_props":{"properties":{"allowed_idps":{"$ref":"#/components/schemas/allowed_idps"},"app_launcher_visible":{"$ref":"#/components/schemas/app_launcher_visible"},"auto_redirect_to_identity":{"$ref":"#/components/schemas/schemas-auto_redirect_to_identity"},"cors_headers":{"$ref":"#/components/schemas/cors_headers"},"custom_deny_message":{"$ref":"#/components/schemas/custom_deny_message"},"custom_deny_url":{"$ref":"#/components/schemas/custom_deny_url"},"domain":{"$ref":"#/components/schemas/domain"},"enable_binding_cookie":{"$ref":"#/components/schemas/enable_binding_cookie"},"http_only_cookie_attribute":{"$ref":"#/components/schemas/http_only_cookie_attribute"},"logo_url":{"$ref":"#/components/schemas/logo_url"},"name":{"$ref":"#/components/schemas/apps_components-schemas-name"},"same_site_cookie_attribute":{"$ref":"#/components/schemas/same_site_cookie_attribute"},"service_auth_401_redirect":{"$ref":"#/components/schemas/service_auth_401_redirect"},"session_duration":{"$ref":"#/components/schemas/session_duration-itWcJrO0"},"skip_interstitial":{"$ref":"#/components/schemas/skip_interstitial"},"type":{"description":"The application type.","example":"self_hosted","type":"string"}},"required":["type","domain"],"title":"Self Hosted Application","type":"object"},"schemas-serial_number":{"description":"The certificate serial number.","example":"235217144297995885180570755458463043449861756659","readOnly":true,"type":"string"},"schemas-service":{"description":"Worker service associated with the zone and hostname.","example":"foo","type":"string"},"schemas-signature":{"description":"Certificate's signature algorithm.","enum":["ECDSAWithSHA256","SHA1WithRSA","SHA256WithRSA"],"type":"string"},"schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/locations"}}}]},"schemas-single_response-CwUTnlnC":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/identity-providers"}}}]},"schemas-single_response-PJU34P3b":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/peer"}}}]},"schemas-single_response-aU3syxnr":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/device-posture-integrations-Xb3lCexZ"}}}]},"schemas-single_response-h7shsYQI":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/api-shield"}}}]},"schemas-single_response-uzr0CVkk":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/pool-Dw5V2rGp"}}}]},"schemas-single_response-xdmRbZer":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/ipam-delegations"}}}]},"schemas-ssh_props":{"allOf":[{"$ref":"#/components/schemas/schemas-self_hosted_props"},{"properties":{"type":{"description":"The application type.","example":"ssh","type":"string"}}}]},"schemas-state":{"description":"The custom page state.","enum":["default","customized"],"example":"default","type":"string"},"schemas-status":{"description":"Status of the Keyless SSL.","enum":["active","deleted"],"example":"active","readOnly":true,"type":"string"},"schemas-status-uJZPVtIE":{"description":"Status of this membership.","enum":["accepted","pending","rejected"],"example":"accepted","type":"string"},"schemas-subdomain":{"description":"The subdomain to be used as the destination in the proxy client.","example":"oli3n9zkz5.proxy.cloudflare-gateway.com","type":"string"},"schemas-target":{"description":"Target gateway of the hostname.","enum":["ethereum","ipfs","ipfs_universal_path","polygon"],"example":"ipfs","type":"string"},"schemas-timeout":{"default":5,"description":"The timeout (in seconds) before marking the health check as failed.","type":"integer"},"schemas-token":{"allOf":[{"$ref":"#/components/schemas/token"}]},"schemas-tunnel_add_single_request":{"properties":{"cloudflare_endpoint":{"$ref":"#/components/schemas/cloudflare_ipsec_endpoint"},"customer_endpoint":{"$ref":"#/components/schemas/customer_ipsec_endpoint"},"description":{"$ref":"#/components/schemas/components-schemas-description-EJnoLTyB"},"interface_address":{"$ref":"#/components/schemas/interface_address"},"name":{"$ref":"#/components/schemas/schemas-name-m2fEJLlJ"},"psk":{"$ref":"#/components/schemas/psk"}},"required":["name","cloudflare_endpoint","interface_address"],"type":"object"},"schemas-tunnel_deleted_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"deleted":{"example":true,"type":"boolean"},"deleted_ipsec_tunnel":{"type":"object"}}}}}]},"schemas-tunnel_id":{"description":"UUID of the Cloudflare Tunnel serving the route."},"schemas-tunnel_modified_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"modified":{"example":true,"type":"boolean"},"modified_ipsec_tunnel":{"type":"object"}}}}}]},"schemas-tunnel_name":{"description":"The user-friendly name of the Cloudflare Tunnel serving the route."},"schemas-tunnel_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/tunnel"},"type":"array"}},"type":"object"}]},"schemas-tunnel_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/tunnel"}},"type":"object"}]},"schemas-tunnel_single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"ipsec_tunnel":{"type":"object"}}}}}]},"schemas-tunnel_update_request":{"allOf":[{"$ref":"#/components/schemas/schemas-tunnel_add_single_request"}]},"schemas-tunnels_collection_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"ipsec_tunnels":{"items":{"$ref":"#/components/schemas/ipsec-tunnel"},"type":"array"}}}}}]},"schemas-type":{"description":"The type of characteristic.","enum":["header","cookie"],"example":"header","type":"string"},"schemas-type-BQBcyQpN":{"description":"The type of Device Posture Integration.","enum":["workspace_one","crowdstrike_s2s","uptycs","intune","kolide"],"example":"workspace_one","type":"string"},"schemas-until":{"description":"End of time interval to query, defaults to current time. Timestamp must be in RFC3339 format and uses UTC unless otherwise specified.","example":"2014-01-02T03:20:00Z","format":"date-time","type":"string"},"schemas-updated_at":{"description":"This is the time the certificate was updated.","example":"2022-11-22T17:32:30.467938Z","format":"date-time","type":"string"},"schemas-uploaded_on":{"description":"This is the time the certificate was uploaded.","example":"2019-10-28T18:11:23.37411Z","format":"date-time","type":"string"},"schemas-url":{"description":"The URL pattern to match, composed of a host and a path such as `example.org/path*`. Normalization is applied before the pattern is matched. `*` wildcards are expanded to match applicable traffic. Query strings are not matched. Set the value to `*` to match all traffic to your zone.","example":"*.example.org/path*","maxLength":1024,"type":"string"},"schemas-urls":{"description":"The URLs to include in the rule definition. You can use wildcards. Each entered URL will be escaped before use, which means you can only use simple wildcard patterns.","items":{"example":"api.mysite.com/some/endpoint*","type":"string"},"type":"array"},"schemas-uuid":{"example":"ed35569b41ce4d1facfe683550f54086"},"schemas-uuid-JmfIpL8C":{"description":"The unique identifier for the Access group."},"schemas-uuid-lt6l49Ob":{"description":"Device ID.","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36,"type":"string"},"schemas-uuid-vgvRNXQL":{"description":"The unique identifier for the Access group."},"schemas-validation_method":{"description":"Validation method in use for a certificate pack order.","enum":["http","cname","txt"],"example":"txt","type":"string"},"schemas-validity_days":{"description":"The validity period in days for the certificates ordered via Total TLS.","enum":[90],"type":"integer"},"schemas-value":{"description":"Enables Argo Smart Routing.","enum":["on","off"],"example":"on","type":"string"},"schemas-variants":{"description":"Object specifying available variants for an image.","example":["https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/thumbnail","https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/hero","https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/original"],"items":{"anyOf":[{"$ref":"#/components/schemas/thumbnail_url"},{"$ref":"#/components/schemas/hero_url"},{"$ref":"#/components/schemas/original_url"}]},"readOnly":true,"type":"array"},"schemas-version":{"description":"The version of the rule.","example":"1","pattern":"^[0-9]+$","type":"string"},"schemas-virtual_network_id":{"description":"UUID of the Tunnel Virtual Network this route belongs to. If no virtual networks are configured, the route is assigned to the default virtual network of the account."},"schemas-vnc_props":{"allOf":[{"$ref":"#/components/schemas/schemas-self_hosted_props"},{"properties":{"type":{"description":"The application type.","example":"vnc","type":"string"}}}]},"schemas-yandex":{"allOf":[{"$ref":"#/components/schemas/schemas-identity-provider"},{"properties":{"config":{"$ref":"#/components/schemas/generic-oauth-config"}},"type":"object"}],"title":"Yandex","type":"object"},"schemas-zone":{"properties":{"name":{"readOnly":true}},"type":"object"},"schemes":{"description":"The HTTP schemes to match. You can specify one scheme (`['HTTPS']`), both schemes (`['HTTP','HTTPS']`), or all schemes (`['_ALL_']`). This field is optional.","example":["HTTP","HTTPS"],"items":{"description":"An HTTP scheme or `_ALL_` to indicate all schemes.","example":"HTTPS","type":"string"},"type":"array"},"scope":{"description":"Used only for ECMP routes.","properties":{"colo_names":{"$ref":"#/components/schemas/colo_names"},"colo_regions":{"$ref":"#/components/schemas/colo_regions"}},"type":"object"},"scope-6kSZmzRz":{"description":"The scope of the URL normalization.","example":"incoming","type":"string"},"script":{"properties":{"added_at":{"example":"2021-08-18T10:51:10.09615Z"},"domain_reported_malicious":{"example":false},"fetched_at":{"example":"2021-09-02T10:17:54Z"},"first_page_url":{"example":"blog.cloudflare.com/page"},"first_seen_at":{"example":"2021-08-18T10:51:08Z"},"hash":{"example":"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"},"host":{"example":"blog.cloudflare.com"},"id":{"example":"c9ef84a6bf5e47138c75d95e2f933e8f"},"js_integrity_score":{"example":10},"last_seen_at":{"example":"2021-09-02T09:57:54Z"},"page_urls":{"example":["blog.cloudflare.com/page1","blog.cloudflare.com/page2"]},"url":{"example":"https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.0/js/bootstrap.min.js"},"url_contains_cdn_cgi_path":{"example":false}}},"script-response":{"properties":{"created_on":{"$ref":"#/components/schemas/created_on-tz4RTlxL"},"etag":{"$ref":"#/components/schemas/etag"},"id":{"description":"The id of the script in the Workers system. Usually the script name.","example":"my-workers-script","readOnly":true,"type":"string"},"logpush":{"$ref":"#/components/schemas/logpush"},"modified_on":{"$ref":"#/components/schemas/modified_on-6lsEa3Mx"},"usage_model":{"$ref":"#/components/schemas/usage_model"}}},"script-response-collection":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/script-response"},"type":"array"}}}]},"script-response-collection-rhW1Gmt4":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"items":{"properties":{"created_on":{"readOnly":true},"etag":{"readOnly":true},"id":{"readOnly":true},"modified_on":{"readOnly":true},"usage_model":{"readOnly":true}}},"type":"array"}}}]},"script-response-single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/script-response"}},"x-cfLinkErrors":{"10001":"Unsupported or unexpected Content Type","10002":"Unexpected internal server error","10003":"Missing required URL parameter","10004":"Malformed URL parameter","10006":"Unparseable script body","10007":"Resource not found (similar to HTTP 404)","10014":"Internal error while attempting authorization checks","10015":"The current account is not authorized to use workers","10018":"Attempted to update a script where the e-tag does not match","10021":"Script content failed validation checks, but was otherwise parseable","10023":"Unauthorized access attempt","10027":"Script body was too large","10075":"Requires a Workers Paid plan"}}]},"script-response-single-qkojssqp":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"script_identifier":{"example":"8ee82b3a2c0f42928b8f14dae4a97121","maxLength":32,"readOnly":true,"type":"string"},"script_name":{"description":"Name of the script, used in URLs and route configuration.","example":"this-is_my_script-01","pattern":"^[a-z0-9_][a-z0-9-_]*$","type":"string"},"search":{"properties":{"resources":{"description":"A list of resources matching the search query.","items":{"$ref":"#/components/schemas/resource_reference"},"type":"array"}},"type":"object"},"search_params":{"properties":{"query":{"default":"","description":"Search query term.","example":"primary","type":"string"},"references":{"default":"","description":"The type of references to include (\"*\" for all).","enum":["","*","referral","referrer"],"example":"*","type":"string"}},"type":"object"},"search_result":{"properties":{"result":{"$ref":"#/components/schemas/search"}},"type":"object"},"seat":{"properties":{"access_seat":{"$ref":"#/components/schemas/access_seat"},"gateway_seat":{"$ref":"#/components/schemas/gateway_seat"},"seat_uid":{"$ref":"#/components/schemas/seat_uid"}},"required":["seat_uid","gateway_seat","access_seat"],"type":"object"},"seat_uid":{"description":"The unique API identifier for the Zero Trust seat."},"seats":{"properties":{"access_seat":{"$ref":"#/components/schemas/access_seat"},"created_at":{"$ref":"#/components/schemas/timestamp"},"gateway_seat":{"$ref":"#/components/schemas/gateway_seat"},"seat_uid":{"$ref":"#/components/schemas/seat_uid"},"updated_at":{"$ref":"#/components/schemas/timestamp"}},"type":"object"},"seats_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/seats"},"type":"array"}}}]},"seats_definition":{"items":{"$ref":"#/components/schemas/seat"},"required":["seat_uid","gateway_seat","access_seat"],"type":"array"},"secret":{"description":"TSIG secret.","example":"caf79a7804b04337c9c66ccd7bef9190a1e1679b5dd03d8aa10f7ad45e1a9dab92b417896c15d4d007c7c14194538d2a5d0feffdecc5a7f0e1c570cfa700837c","type":"string"},"secret-QjCIBSp3":{"description":"Optional secret that will be passed in the `cf-webhook-auth` header when dispatching a webhook notification. Secrets are not returned in any API response body.","type":"string"},"security_header":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone's security header.","enum":["security_header"],"example":"security_header"},"value":{"$ref":"#/components/schemas/security_header_value"}}}],"description":"Cloudflare security header for a zone.","title":"Security Header"},"security_header_value":{"properties":{"strict_transport_security":{"description":"Strict Transport Security.","properties":{"enabled":{"description":"Whether or not strict transport security is enabled.","example":true,"type":"boolean"},"include_subdomains":{"description":"Include all subdomains for strict transport security.","example":true,"type":"boolean"},"max_age":{"description":"Max age in seconds of the strict transport security.","example":86400,"type":"number"},"nosniff":{"description":"Whether or not to include 'X-Content-Type-Options: nosniff' header.","example":true,"type":"boolean"}},"type":"object"}},"type":"object"},"security_level":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["security_level"],"example":"security_level"},"value":{"$ref":"#/components/schemas/security_level_value"}}}],"description":"Choose the appropriate security profile for your website, which will automatically adjust each of the security settings. If you choose to customize an individual security setting, the profile will become Custom. (https://support.cloudflare.com/hc/en-us/articles/200170056).","title":"Security Level"},"security_level_value":{"default":"medium","description":"Value of the zone setting.","enum":["off","essentially_off","low","medium","high","under_attack"],"type":"string"},"self_hosted_props":{"properties":{"allowed_idps":{"$ref":"#/components/schemas/allowed_idps"},"app_launcher_visible":{"$ref":"#/components/schemas/app_launcher_visible"},"auto_redirect_to_identity":{"$ref":"#/components/schemas/schemas-auto_redirect_to_identity"},"cors_headers":{"$ref":"#/components/schemas/cors_headers"},"custom_deny_message":{"$ref":"#/components/schemas/custom_deny_message"},"custom_deny_url":{"$ref":"#/components/schemas/custom_deny_url"},"domain":{"$ref":"#/components/schemas/domain"},"enable_binding_cookie":{"$ref":"#/components/schemas/enable_binding_cookie"},"http_only_cookie_attribute":{"$ref":"#/components/schemas/http_only_cookie_attribute"},"logo_url":{"$ref":"#/components/schemas/logo_url"},"name":{"$ref":"#/components/schemas/apps_components-schemas-name"},"path_cookie_attribute":{"$ref":"#/components/schemas/path_cookie_attribute"},"same_site_cookie_attribute":{"$ref":"#/components/schemas/same_site_cookie_attribute"},"service_auth_401_redirect":{"$ref":"#/components/schemas/service_auth_401_redirect"},"session_duration":{"$ref":"#/components/schemas/session_duration-itWcJrO0"},"skip_interstitial":{"$ref":"#/components/schemas/skip_interstitial"},"type":{"description":"The application type.","example":"self_hosted","type":"string"}},"required":["type","domain"],"title":"Self Hosted Application","type":"object"},"self_hosted_props-pFu7lQyL":{"properties":{"allowed_idps":{"$ref":"#/components/schemas/allowed_idps"},"app_launcher_visible":{"$ref":"#/components/schemas/app_launcher_visible"},"auto_redirect_to_identity":{"$ref":"#/components/schemas/auto_redirect_to_identity-zRTYoQOC"},"cors_headers":{"$ref":"#/components/schemas/cors_headers"},"custom_deny_message":{"$ref":"#/components/schemas/custom_deny_message"},"custom_deny_url":{"$ref":"#/components/schemas/custom_deny_url"},"domain":{"$ref":"#/components/schemas/schemas-domain-N8byIUtr"},"enable_binding_cookie":{"$ref":"#/components/schemas/enable_binding_cookie"},"http_only_cookie_attribute":{"$ref":"#/components/schemas/http_only_cookie_attribute"},"logo_url":{"$ref":"#/components/schemas/logo_url"},"name":{"$ref":"#/components/schemas/apps_components-schemas-name"},"same_site_cookie_attribute":{"$ref":"#/components/schemas/same_site_cookie_attribute"},"service_auth_401_redirect":{"$ref":"#/components/schemas/service_auth_401_redirect"},"session_duration":{"$ref":"#/components/schemas/session_duration-ZxG3i84k"},"skip_interstitial":{"$ref":"#/components/schemas/skip_interstitial"},"type":{"description":"The application type.","example":"self_hosted","type":"string"}},"title":"Self Hosted Application","type":"object"},"sensitivity":{"default":"high","description":"The sensitivity of the WAF package.","enum":["high","medium","low","off"],"type":"string"},"sent":{"description":"Timestamp of when the notification was dispatched in ISO 8601 format.","example":"2021-10-08T17:52:17.571336Z","format":"date-time","type":"string"},"serial_number":{"description":"The serial number on the uploaded certificate.","example":"6743787633689793699141714808227354901","type":"string"},"serial_number-8kzQvaWX":{"description":"The device serial number.","example":"EXAMPLEHMD6R","type":"string"},"server_side_exclude":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["server_side_exclude"],"example":"server_side_exclude"},"value":{"$ref":"#/components/schemas/server_side_exclude_value"}}}],"description":"If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: \u003c!--sse--\u003e\u003c!--/sse--\u003e. For example: \u003c!--sse--\u003e Bad visitors won't see my phone number, 555-555-5555 \u003c!--/sse--\u003e. Note: SSE only will work with HTML. If you have HTML minification enabled, you won't see the SSE tags in your HTML source when it's served through Cloudflare. SSE will still function in this case, as Cloudflare's HTML minification and SSE functionality occur on-the-fly as the resource moves through our network to the visitor's computer. (https://support.cloudflare.com/hc/en-us/articles/200170036).","title":"Server Side Exclude"},"server_side_exclude_value":{"default":"on","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"service":{"description":"The service using the certificate.","example":"gateway","type":"string"},"service-tokens":{"properties":{"client_id":{"$ref":"#/components/schemas/client_id"},"created_at":{"$ref":"#/components/schemas/timestamp"},"id":{"description":"The ID of the service token."},"name":{"$ref":"#/components/schemas/service-tokens_components-schemas-name"},"updated_at":{"$ref":"#/components/schemas/timestamp"}},"type":"object"},"service-tokens_components-schemas-name":{"description":"The name of the service token.","example":"CI/CD token","type":"string"},"service-tokens_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/service-tokens"},"type":"array"}}}]},"service-tokens_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/service-tokens"}}}]},"service_auth_401_redirect":{"description":"Returns a 401 status code when the request is blocked by a Service Auth policy.","example":true,"type":"boolean"},"service_mode_v2":{"properties":{"mode":{"description":"The mode to run the WARP client under.","example":"proxy","type":"string"},"port":{"description":"The port number when used with proxy mode.","example":3000,"type":"number"}},"type":"object"},"session_affinity":{"default":"\"\"","description":"The session_affinity specifies the type of session affinity the load balancer should use unless specified as \"none\" or \"\"(default). The supported types are \"cookie\" and \"ip_cookie\". \"cookie\" - On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy then a new origin server is calculated and used. \"ip_cookie\" behaves the same as \"cookie\" except the initial origin selection is stable and based on the client’s ip address.","enum":["none","cookie","ip_cookie","\"\""],"example":"cookie","type":"string"},"session_affinity_attributes":{"description":"Configures cookie attributes for session affinity cookie.","properties":{"drain_duration":{"description":"Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer.","example":100,"type":"number"},"samesite":{"default":"Auto","description":"Configures the SameSite attribute on session affinity cookie. Value \"Auto\" will be translated to \"Lax\" or \"None\" depending if Always Use HTTPS is enabled. Note: when using value \"None\", the secure attribute can not be set to \"Never\".","enum":["Auto","Lax","None","Strict"],"example":"Auto","type":"string"},"secure":{"default":"Auto","description":"Configures the Secure attribute on session affinity cookie. Value \"Always\" indicates the Secure attribute will be set in the Set-Cookie header, \"Never\" indicates the Secure attribute will not be set, and \"Auto\" will set the Secure attribute depending if Always Use HTTPS is enabled.","enum":["Auto","Always","Never"],"example":"Auto","type":"string"},"zero_downtime_failover":{"default":"none","description":"Configures the zero-downtime failover between origins within a pool when session affinity is enabled. Value \"none\" means no failover takes place for sessions pinned to the origin (default). Value \"temporary\" means traffic will be sent to another other healthy origin until the originally pinned origin is available; note that this can potentially result in heavy origin flapping. Value \"sticky\" means the session affinity cookie is updated and subsequent requests are sent to the new origin. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance.","enum":["none","temporary","sticky"],"example":"sticky","type":"string"}},"type":"object"},"session_affinity_ttl":{"description":"Time, in seconds, until this load balancer's session affinity cookie expires after being created. This parameter is ignored unless a supported session affinity policy is set. The current default of 23 hours will be used unless session_affinity_ttl is explicitly set. The accepted range of values is between [1800, 604800]. Once the expiry time has been reached, subsequent requests may get sent to a different origin server.","example":5000,"type":"number"},"session_duration":{"default":5,"description":"Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. If a user is not seen by Cloudflare again in that time period, they will be treated as a new user that visits the route.","maximum":30,"minimum":1,"type":"integer"},"session_duration-ZxG3i84k":{"default":"24h","description":"The amount of time that tokens issued for this application will be valid. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h.","example":"24h","type":"string"},"session_duration-itWcJrO0":{"default":"24h","description":"The amount of time that tokens issued for this application will be valid. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h.","example":"24h","type":"string"},"session_id":{"description":"Unique session id of the job.","example":"99d471b1ca3c23cc8e30b6acec5db987","type":"string"},"setting":{"oneOf":[{"$ref":"#/components/schemas/0rtt"},{"$ref":"#/components/schemas/advanced_ddos"},{"$ref":"#/components/schemas/always_online"},{"$ref":"#/components/schemas/always_use_https"},{"$ref":"#/components/schemas/automatic_https_rewrites"},{"$ref":"#/components/schemas/brotli"},{"$ref":"#/components/schemas/browser_cache_ttl"},{"$ref":"#/components/schemas/browser_check"},{"$ref":"#/components/schemas/cache_level"},{"$ref":"#/components/schemas/challenge_ttl"},{"$ref":"#/components/schemas/ciphers"},{"$ref":"#/components/schemas/cname_flattening"},{"$ref":"#/components/schemas/development_mode"},{"$ref":"#/components/schemas/early_hints"},{"$ref":"#/components/schemas/edge_cache_ttl"},{"$ref":"#/components/schemas/email_obfuscation"},{"$ref":"#/components/schemas/h2_prioritization"},{"$ref":"#/components/schemas/hotlink_protection"},{"$ref":"#/components/schemas/http2"},{"$ref":"#/components/schemas/http3"},{"$ref":"#/components/schemas/image_resizing"},{"$ref":"#/components/schemas/ip_geolocation"},{"$ref":"#/components/schemas/ipv6"},{"$ref":"#/components/schemas/max_upload"},{"$ref":"#/components/schemas/min_tls_version"},{"$ref":"#/components/schemas/minify"},{"$ref":"#/components/schemas/mirage"},{"$ref":"#/components/schemas/mobile_redirect"},{"$ref":"#/components/schemas/nel"},{"$ref":"#/components/schemas/opportunistic_encryption"},{"$ref":"#/components/schemas/opportunistic_onion"},{"$ref":"#/components/schemas/orange_to_orange"},{"$ref":"#/components/schemas/origin_error_page_pass_thru"},{"$ref":"#/components/schemas/origin_max_http_version"},{"$ref":"#/components/schemas/polish"},{"$ref":"#/components/schemas/prefetch_preload"},{"$ref":"#/components/schemas/privacy_pass"},{"$ref":"#/components/schemas/proxy_read_timeout"},{"$ref":"#/components/schemas/pseudo_ipv4"},{"$ref":"#/components/schemas/response_buffering"},{"$ref":"#/components/schemas/rocket_loader"},{"$ref":"#/components/schemas/schemas-automatic_platform_optimization"},{"$ref":"#/components/schemas/security_header"},{"$ref":"#/components/schemas/security_level"},{"$ref":"#/components/schemas/server_side_exclude"},{"$ref":"#/components/schemas/sha1_support"},{"$ref":"#/components/schemas/sort_query_string_for_cache"},{"$ref":"#/components/schemas/ssl"},{"$ref":"#/components/schemas/ssl_recommender"},{"$ref":"#/components/schemas/tls_1_2_only"},{"$ref":"#/components/schemas/tls_1_3"},{"$ref":"#/components/schemas/tls_client_auth"},{"$ref":"#/components/schemas/true_client_ip_header"},{"$ref":"#/components/schemas/waf"},{"$ref":"#/components/schemas/webp"},{"$ref":"#/components/schemas/websockets"}],"type":"object"},"settings":{"description":"Settings available for the zone.","example":[{"id":"browser_check","properties":[{"name":"value","type":"toggle"}]},{"id":"browser_cache_ttl","properties":[{"max":31536000,"min":1800,"name":"value","suggested_values":[1800,3600,7200,10800,14400,18000,28800,43200,57600,72000,86400,172800,259200,345600,432000,691200,1382400,2073600,2678400,5356800,16070400,31536000],"type":"range"}]},{"id":"browser_check","properties":[{"name":"value","type":"toggle"}]},{"id":"cache_key_fields","properties":[{"name":"value","properties":[{"allowEmpty":true,"choices":["include","exclude"],"multiple":false,"name":"query_string","type":"select"},{"allowEmpty":true,"choices":["include","exclude","check_presence"],"multiple":true,"name":"header","type":"select"},{"allowEmpty":false,"choices":["resolved"],"multiple":true,"name":"host","type":"select"},{"allowEmpty":true,"choices":["include","check_presence"],"multiple":true,"name":"cookie","type":"select"},{"allowEmpty":false,"choices":["device_type","geo","lang"],"multiple":true,"name":"user","type":"select"}],"type":"object"}]},{"id":"cache_deception_armor","properties":[{"name":"value","type":"toggle"}]},{"id":"cache_level","properties":[{"choices":["bypass","basic","simplified","aggressive","cache_everything"],"multiple":false,"name":"value","type":"select"}]},{"id":"cache_ttl_by_status","properties":[{"allowEmpty":false,"name":"value","type":"object"}]},{"id":"disable_apps","properties":[]},{"id":"disable_performance","properties":[]},{"id":"disable_security","properties":[]},{"id":"edge_cache_ttl","properties":[{"max":2419200,"min":7200,"name":"value","suggested_values":[7200,10800,14400,18000,28800,43200,57600,72000,86400,172800,259200,345600,432000,518400,604800,1209600,2419200],"type":"range"}]},{"id":"email_obfuscation","properties":[{"name":"value","type":"toggle"}]},{"id":"forwarding_url","properties":[{"choices":[301,302],"multiple":false,"name":"status_code","type":"choice"},{"name":"url","type":"forwardingUrl"}]},{"id":"ip_geolocation","properties":[{"name":"value","type":"toggle"}]},{"id":"minify","properties":[{"allowEmpty":true,"choices":["html","css","js"],"multiple":true,"name":"value","type":"select"}]},{"id":"explicit_cache_control","properties":[{"name":"value","type":"toggle"}]},{"id":"rocket_loader","properties":[{"name":"value","type":"toggle"}]},{"id":"security_level","properties":[{"choices":["essentially_off","low","medium","high","under_attack"],"multiple":false,"name":"value","type":"select"}]},{"id":"server_side_exclude","properties":[{"name":"value","type":"toggle"}]},{"id":"ssl","properties":[{"choices":["off","flexible","full","strict"],"multiple":false,"name":"value","type":"choice"}]}],"items":{"type":"object"},"type":"array"},"settings-2v3jrs7t":{"allOf":[{"$ref":"#/components/schemas/email-settings_properties"}],"type":"object"},"settings-s418OBZp":{"additionalProperties":false,"properties":{"china_network":{"description":"Request client certificates for this hostname in China. Can only be set to true if this zone is china network enabled.","example":false,"type":"boolean"},"client_certificate_forwarding":{"description":"Client Certificate Forwarding is a feature that takes the client cert provided by the eyeball to the edge, and forwards it to the origin as a HTTP header to allow logging on the origin.","example":true,"type":"boolean"},"hostname":{"description":"The hostname that these settings apply to.","example":"admin.example.com","type":"string"}},"required":["hostname","china_network","client_certificate_forwarding"],"title":"Hostname Settings","type":"object"},"sha1_support":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"Zone setting identifier.","enum":["sha1_support"],"example":"sha1_support"},"value":{"$ref":"#/components/schemas/sha1_support_value"}}}],"description":"Allow SHA1 support.","title":"Toggle SHA1 support"},"sha1_support_value":{"default":"off","description":"Value of the zone setting.","enum":["off","on"],"type":"string"},"shared_entry_update_integration":{"description":"Properties of an integration entry in a custom profile","properties":{"enabled":{"description":"Whether the entry is enabled or not.","type":"boolean"},"entry_id":{"$ref":"#/components/schemas/entry_id"}},"title":"Update integration entry","type":"object"},"shared_entry_update_predefined":{"description":"Properties of a predefined entry in a custom profile","properties":{"enabled":{"description":"Whether the entry is enabled or not.","example":true,"type":"boolean"},"entry_id":{"$ref":"#/components/schemas/entry_id"}},"title":"Update predefined entry","type":"object"},"signature":{"description":"The type of hash used for the certificate.","example":"SHA256WithRSA","readOnly":true,"type":"string"},"signed_token_request":{"properties":{"accessRules":{"description":"The optional list of access rule constraints on the token. Access can be blocked or allowed based on an IP, IP range, or by country. Access rules are evaluated from first to last. If a rule matches, the associated action is applied and no further rules are evaluated.","example":[{"action":"block","country":["US","MX"],"type":"ip.geoip.country"},{"action":"allow","ip":["93.184.216.0/24","2400:cb00::/32"],"type":"ip.src"},{"action":"block","type":"any"}],"items":{"$ref":"#/components/schemas/accessRules"},"readOnly":true,"type":"array"},"downloadable":{"default":false,"description":"The optional boolean value that enables using signed tokens to access MP4 download links for a video.","readOnly":true,"type":"boolean"},"exp":{"description":"The optional unix epoch timestamp that specficies the time after a token is not accepted. The maximum time specification is 24 hours from issuing time. If this field is not set, the default is one hour after issuing.","readOnly":true,"type":"integer"},"id":{"description":"The optional ID of a Stream signing key. If present, the `pem` field is also required.","example":"ab0d4ef71g4425f8dcba9041231813000","readOnly":true,"type":"string"},"nbf":{"description":"The optional unix epoch timestamp that specifies the time before a the token is not accepted. If this field is not set, the default is one hour before issuing.","readOnly":true,"type":"integer"},"pem":{"description":"The optional base64 encoded private key in PEM format associated with a Stream signing key. If present, the `id` field is also required.","example":"LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQpNSUlFcEFJQkFBS0NBUUVBc284dnBvOFpEWXRkOUgzbWlPaW1qYXAzVXlVM0oyZ3kwTUYvN1R4blJuRnkwRHpDCkxqUk9naFZsQ0hPQmxsd3NVaE9GU0lyYnN4K05tUTdBeS90TFpXSGxuVGF3UWJ5WGZGOStJeDhVSnNlSHBGV1oKNVF5Z1JYd2liSjh1MVVsZ2xlcmZHMkpueldjVXpZTzEySktZN3doSkw1ajROMWgxZFJNUXQ5Q1pkZFlCQWRzOQpCdk02cjRFMDcxQkhQekhWeDMrUTI1VWtubGdUNXIwS3FiM1E1Y0dlTlBXY1JreW1ybkJEWWR0OXR4eFFMb1dPCllzNXdsMnVYWFVYL0VGcDMwajU0Nmp6czllWExLYlNDbjJjTDZFVE96Y2x3aG9DRGx2a2VQT05rUE9LMDVKNUMKTm1TdFdhMG9hV1VGRzM0MFl3cVVrWGt4OU9tNndXd1JldU1uU1FJREFRQUJBb0lCQUFJOHo1ck5kOEdtOGJBMgo1S3pxQjI1R2lOVENwbUNJeW53NXRJWHZTQmNHcEdydUcvdlN2WG9kVlFVSVY0TWdHQkVXUEFrVzdsNWVBcHI4CnA1ZFd5SkRXYTNkdklFSE9vSEpYU3dBYksxZzZEMTNVa2NkZ1EyRGpoNVhuWDhHZCtBY2c2SmRTQWgxOWtYSHEKMk54RUtBVDB6Ri83a1g2MkRkREFBcWxmQkpGSXJodVIvZUdEVWh4L2piTTRhQ2JCcFdiM0pnRE9OYm5tS1ZoMwpxS2ZwZmRZZENZU1lzWUxrNTlxRDF2VFNwUVFUQ0VadW9VKzNzRVNhdkJzaUs1bU0vTzY5ZkRMRXNURG1MeTVQCmhEK3BMQXI0SlhNNjFwRGVBS0l3cUVqWWJybXlDRHRXTUdJNnZzZ0E1eXQzUUJaME9vV2w5QUkwdWxoZ3p4dXQKZ2ZFNTRRRUNnWUVBN0F3a0lhVEEzYmQ4Nk9jSVZnNFlrWGk1cm5aNDdsM1k4V24zcjIzUmVISXhLdkllRUtSbgp5bUlFNDFtRVBBSmlGWFpLK1VPTXdkeS9EcnFJUithT1JiT2NiV01jWUg2QzgvbG1wdVJFaXE3SW1Ub3VWcnA4CnlnUkprMWprVDA4cTIvNmg4eTBEdjJqMitsaHFXNzRNOUt0cmwxcTRlWmZRUFREL01tR1NnTWtDZ1lFQXdhY04KaSttN1p6dnJtL3NuekF2VlZ5SEtwZHVUUjNERk1naC9maC9tZ0ZHZ1RwZWtUOVV5b3FleGNYQXdwMVlhL01iQQoyNTVJVDZRbXZZTm5yNXp6Wmxic2tMV0hsYllvbWhmWnVXTHhXR3hRaEFORWdaMFVVdUVTRGMvbWx2UXZHbEtSCkZoaGhBUWlVSmdDamhPaHk1SlBiNGFldGRKd0UxK09lVWRFaE1vRUNnWUVBNG8yZ25CM1o4ck5xa3NzemlBek4KYmNuMlJVbDJOaW9pejBwS3JMaDFaT29NNE5BekpQdjJsaHRQMzdtS0htS1hLMHczRjFqTEgwSTBxZmxFVmVZbQpSU1huakdHazJjUnpBYUVzOGgrQzNheDE0Z01pZUtGU3BqNUpNOEFNbVVZOXQ1cUVhN2FYc3o0V1ZoOUlMYmVTCkRiNzlhKzVwd21LQVBrcnBsTHhyZFdrQ2dZQlNNSHVBWVdBbmJYZ1BDS2FZWklGVWJNUWNacmY0ZnpWQ2lmYksKYWZHampvRlNPZXdEOGdGK3BWdWJRTGwxbkFieU44ek1xVDRaaHhybUhpcFlqMjJDaHV2NmN3RXJtbGRiSnpwQwpBMnRaVXdkTk1ESFlMUG5lUHlZeGRJWnlsUXFVeW14SGkydElUQUxNcWtLOGV3ZWdXZHpkeGhQSlJScU5JazhrCmZIVHhnUUtCZ1FEUFc2UXIxY3F3QjNUdnVWdWR4WGRqUTdIcDFodXhrNEVWaEFJZllKNFhSTW1NUE5YS28wdHUKdUt6LzE0QW14R0dvSWJxYVc1bDMzeFNteUxhem84clNUN0tSTjVKME9JSHcrZkR5SFgxdHpVSjZCTldDcEFTcwpjbWdNK0htSzVON0w2bkNaZFJQY2IwU1hGaVRQUGhCUG1PVWFDUnpER0ZMK2JYM1VwajJKbWc9PQotLS0tLUVORCBSU0EgUFJJVkFURSBLRVktLS0tLQo=","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"},"signed_token_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"token":{"description":"The signed token used with the signed URLs feature.","example":"eyJhbGciOiJSUzI1NiIsImtpZCI6ImU5ZGI5OTBhODI2NjZkZDU3MWM3N2Y5NDRhNWM1YzhkIn0.eyJzdWIiOiJlYTk1MTMyYzE1NzMyNDEyZDIyYzE0NzZmYTgzZjI3YSIsImtpZCI6ImU5ZGI5OTBhODI2NjZkZDU3MWM3N2Y5NDRhNWM1YzhkIiwiZXhwIjoiMTUzNzQ2MDM2NSIsIm5iZiI6IjE1Mzc0NTMxNjUifQ.OZhqOARADn1iubK6GKcn25hN3nU-hCFF5q9w2C4yup0C4diG7aMIowiRpP-eDod8dbAJubsiFuTKrqPcmyCKWYsiv0TQueukqbQlF7HCO1TV-oF6El5-7ldJ46eD-ZQ0XgcIYEKrQOYFF8iDQbqPm3REWd6BnjKZdeVrLzuRaiSnZ9qqFpGu5dfxIY9-nZKDubJHqCr3Imtb211VIG_b9MdtO92JjvkDS-rxT_pkEfTZSafl1OU-98A7KBGtPSJHz2dHORIrUiTA6on4eIXTj9aFhGiir4rSn-rn0OjPRTtJMWIDMoQyE_fwrSYzB7MPuzL2t82BWaEbHZTfixBm5A","type":"string"}}}}}]},"signing_key_created":{"description":"The date and time a signing key was created.","example":"2014-01-02T02:20:00Z","format":"date-time","readOnly":true,"type":"string"},"since":{"description":"Start date and time of requesting data period in ISO 8601 format.","example":"2023-11-11T12:00:00Z","format":"date-time","type":"string"},"since-cRELaVYs":{"anyOf":[{"type":"string"},{"type":"integer"}],"default":-10080,"description":"The (inclusive) beginning of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. At this point in time, it cannot exceed a time in the past greater than one year.\n\nRanges that the Cloudflare web application provides will provide the following period length for each point:\n- Last 60 minutes (from -59 to -1): 1 minute resolution\n- Last 7 hours (from -419 to -60): 15 minutes resolution\n- Last 15 hours (from -899 to -420): 30 minutes resolution\n- Last 72 hours (from -4320 to -900): 1 hour resolution\n- Older than 3 days (-525600 to -4320): 1 day resolution.","example":"2015-01-01T12:23:00Z"},"single_invite_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}},"type":"object"}]},"single_member_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}},"type":"object"}]},"single_membership_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}},"type":"object"}]},"single_organization_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}},"type":"object"}]},"single_request_outgoing":{"properties":{"id":{"$ref":"#/components/schemas/identifier-ahBjrSIO"},"name":{"$ref":"#/components/schemas/name-YGUm4gr7"},"peers":{"$ref":"#/components/schemas/peers"}},"required":["id","name","peers"]},"single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/lists"}}}]},"single_response-JiiItTpX":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/healthchecks"}}}]},"single_response-UJHycgfI":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/device-posture-rules-gduy4mTZ"}}}]},"single_response-X5UPXTbk":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/tsig"}}}]},"single_response-ZvEjOvIb":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/waitingroom"}}}]},"single_response-lMJq2fgM":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/configuration"}}}]},"single_response-tparoDL5":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/ipam-prefixes"}}}]},"single_response-x2K6CTG8":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/organizations"}}}]},"single_response-xymoBSIP":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/monitor-FBAH67XY"}}}]},"single_response_hostnames":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/settings-s418OBZp"}}}]},"single_response_incoming":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"auto_refresh_seconds":{"$ref":"#/components/schemas/auto_refresh_seconds"},"checked_time":{"$ref":"#/components/schemas/time"},"created_time":{"$ref":"#/components/schemas/time"},"id":{"$ref":"#/components/schemas/identifier-ahBjrSIO"},"modified_time":{"$ref":"#/components/schemas/time"},"name":{"$ref":"#/components/schemas/name-YGUm4gr7"},"peers":{"$ref":"#/components/schemas/peers"},"soa_serial":{"$ref":"#/components/schemas/soa_serial"}},"type":"object"}}}]},"single_response_outgoing":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"checked_time":{"$ref":"#/components/schemas/time"},"created_time":{"$ref":"#/components/schemas/time"},"id":{"$ref":"#/components/schemas/identifier-ahBjrSIO"},"last_transferred_time":{"$ref":"#/components/schemas/time"},"name":{"$ref":"#/components/schemas/name-YGUm4gr7"},"peers":{"$ref":"#/components/schemas/peers"},"soa_serial":{"$ref":"#/components/schemas/soa_serial"}},"type":"object"}}}]},"single_response_with_list_items":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"created_at":{"$ref":"#/components/schemas/timestamp"},"description":{"$ref":"#/components/schemas/description"},"id":{"$ref":"#/components/schemas/uuid"},"items":{"$ref":"#/components/schemas/items"},"name":{"$ref":"#/components/schemas/name"},"type":{"$ref":"#/components/schemas/type"},"updated_at":{"$ref":"#/components/schemas/timestamp"}}}}}]},"single_role_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}},"type":"object"}]},"single_user_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}},"type":"object"}]},"size":{"description":"The size of the media item in bytes.","example":4190963,"readOnly":true,"type":"number"},"ski":{"description":"Subject Key Identifier","example":"8e375af1389a069a0f921f8cc8e1eb12d784b949","readOnly":true,"type":"string"},"skip_interstitial":{"description":"Enables automatic authentication through cloudflared.","example":true,"type":"boolean"},"soa_serial":{"description":"The serial number of the SOA for the given zone.","example":2019102400,"type":"number"},"sort":{"description":"A comma-separated list of dimensions to sort by, where each dimension may be prefixed by - (descending) or + (ascending).","example":"+responseCode,-queryName","type":"string"},"sort-KhE8n2c0":{"description":"The sort order for the result set; sort fields must be included in `metrics` or `dimensions`.","example":["+count","-bytesIngress"],"items":{},"type":"array"},"sort_query_string_for_cache":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["sort_query_string_for_cache"],"example":"sort_query_string_for_cache"},"value":{"$ref":"#/components/schemas/sort_query_string_for_cache_value"}}}],"default":"off","description":"Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones.","title":"Get String Sort"},"sort_query_string_for_cache_value":{"default":"off","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"split_tunnel":{"properties":{"address":{"description":"The address in CIDR format to exclude from the tunnel. If address is present, host must not be present.","example":"192.0.2.0/24","type":"string"},"description":{"description":"A description of the split tunnel item, displayed in the client UI.","example":"Exclude testing domains from the tunnel","maxLength":100,"type":"string"},"host":{"description":"The domain name to exclude from the tunnel. If host is present, address must not be present.","example":"*.example.com","type":"string"}},"required":["address","description"],"type":"object"},"split_tunnel_include":{"properties":{"address":{"description":"The address in CIDR format to include in the tunnel. If address is present, host must not be present.","example":"192.0.2.0/24","type":"string"},"description":{"description":"A description of the split tunnel item, displayed in the client UI.","example":"Include testing domains from the tunnel","maxLength":100,"type":"string"},"host":{"description":"The domain name to include in the tunnel. If host is present, address must not be present.","example":"*.example.com","type":"string"}},"required":["address","description"],"type":"object"},"split_tunnel_include_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/split_tunnel_include"},"type":"array"}}}]},"split_tunnel_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/split_tunnel"},"type":"array"}}}]},"ssh_props":{"allOf":[{"$ref":"#/components/schemas/self_hosted_props-pFu7lQyL"},{"properties":{"type":{"description":"The application type.","example":"ssh","type":"string"}}}]},"ssl":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["ssl"],"example":"ssl"},"value":{"$ref":"#/components/schemas/ssl_value"}}}],"description":"SSL encrypts your visitor's connection and safeguards credit card numbers and other personal data to and from your website. SSL can take up to 5 minutes to fully activate. Requires Cloudflare active on your root domain or www domain. Off: no SSL between the visitor and Cloudflare, and no SSL between Cloudflare and your web server (all HTTP traffic). Flexible: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, but no SSL between Cloudflare and your web server. You don't need to have an SSL cert on your web server, but your vistors will still see the site as being HTTPS enabled. Full: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have your own SSL cert or self-signed cert at the very least. Full (Strict): SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have a valid SSL certificate installed on your web server. This certificate must be signed by a certificate authority, have an expiration date in the future, and respond for the request domain name (hostname). (https://support.cloudflare.com/hc/en-us/articles/200170416).","title":"SSL"},"ssl-EYx9hEKp":{"description":"SSL properties for the custom hostname.","oneOf":[{"properties":{"bundle_method":{"default":"ubiquitous","description":"A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it.","enum":["ubiquitous","optimal","force"],"example":"ubiquitous","type":"string"},"certificate_authority":{"$ref":"#/components/schemas/certificate_authority"},"custom_certificate":{"description":"If a custom uploaded certificate is used.","example":"-----BEGIN CERTIFICATE-----\\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\\n-----END CERTIFICATE-----\\n","type":"string"},"custom_csr_id":{"description":"The identifier for the Custom CSR that was used.","example":"7b163417-1d2b-4c84-a38a-2fb7a0cd7752","type":"string"},"custom_key":{"description":"The key for a custom uploaded certificate.","example":"-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n","type":"string"},"expires_on":{"description":"The time the custom certificate expires on.","example":"2021-02-06T18:11:23.531995Z","format":"date-time","type":"string"},"hosts":{"description":"A list of Hostnames on a custom uploaded certificate.","example":["app.example.com","*.app.example.com"],"items":{},"type":"array"},"id":{"description":"Custom hostname SSL identifier tag.","example":"0d89c70d-ad9f-4843-b99f-6cc0252067e9","maxLength":36,"minLength":36,"type":"string"},"issuer":{"description":"The issuer on a custom uploaded certificate.","example":"DigiCertInc","type":"string"},"method":{"description":"Domain control validation (DCV) method used for this hostname.","enum":["http","txt","email"],"example":"txt"},"serial_number":{"description":"The serial number on a custom uploaded certificate.","example":"6743787633689793699141714808227354901","type":"string"},"settings":{"$ref":"#/components/schemas/sslsettings"},"signature":{"description":"The signature on a custom uploaded certificate.","example":"SHA256WithRSA","type":"string"},"status":{"description":"Status of the hostname's SSL certificates.","enum":["initializing","pending_validation","deleted","pending_issuance","pending_deployment","pending_deletion","pending_expiration","expired","active","initializing_timed_out","validation_timed_out","issuance_timed_out","deployment_timed_out","deletion_timed_out","pending_cleanup","staging_deployment","staging_active","deactivating","inactive","backup_issued","holding_deployment"],"example":"pending_validation","readOnly":true},"type":{"description":"Level of validation to be used for this hostname. Domain validation (dv) must be used.","enum":["dv"],"example":"dv","readOnly":true},"uploaded_on":{"description":"The time the custom certificate was uploaded.","example":"2020-02-06T18:11:23.531995Z","format":"date-time","type":"string"},"validation_errors":{"description":"Domain validation errors that have been received by the certificate authority (CA).","items":{"properties":{"message":{"description":"A domain validation error.","example":"SERVFAIL looking up CAA for app.example.com","type":"string"}},"type":"object"},"type":"array"},"validation_records":{"items":{"$ref":"#/components/schemas/validation_record"},"type":"array"},"wildcard":{"description":"Indicates whether the certificate covers a wildcard.","example":false,"type":"boolean"}},"type":"object"}],"type":"object"},"ssl-UwTUGHGu":{"description":"SSL properties for the custom hostname.","oneOf":[{"properties":{"bundle_method":{"default":"ubiquitous","description":"A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it.","enum":["ubiquitous","optimal","force"],"example":"ubiquitous","type":"string"},"certificate_authority":{"description":"The Certificate Authority that has issued this certificate.","enum":["digicert","google","lets_encrypt"],"example":"digicert","type":"string"},"custom_certificate":{"description":"If a custom uploaded certificate is used.","example":"-----BEGIN CERTIFICATE-----\\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\\n-----END CERTIFICATE-----\\n","type":"string"},"custom_csr_id":{"description":"The identifier for the Custom CSR that was used.","example":"7b163417-1d2b-4c84-a38a-2fb7a0cd7752","type":"string"},"custom_key":{"description":"The key for a custom uploaded certificate.","example":"-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n","type":"string"},"expires_on":{"description":"The time the custom certificate expires on.","example":"2021-02-06T18:11:23.531995Z","format":"date-time","type":"string"},"hosts":{"description":"A list of Hostnames on a custom uploaded certificate.","example":["app.example.com","*.app.example.com"],"items":{},"type":"array"},"id":{"description":"Custom hostname SSL identifier tag.","example":"0d89c70d-ad9f-4843-b99f-6cc0252067e9","maxLength":36,"minLength":36,"type":"string"},"issuer":{"description":"The issuer on a custom uploaded certificate.","example":"DigiCertInc","type":"string"},"method":{"description":"Domain control validation (DCV) method used for this hostname.","enum":["http","txt","email"],"example":"txt"},"serial_number":{"description":"The serial number on a custom uploaded certificate.","example":"6743787633689793699141714808227354901","type":"string"},"settings":{"$ref":"#/components/schemas/sslsettings"},"signature":{"description":"The signature on a custom uploaded certificate.","example":"SHA256WithRSA","type":"string"},"status":{"description":"Status of the hostname's SSL certificates.","enum":["initializing","pending_validation","deleted","pending_issuance","pending_deployment","pending_deletion","pending_expiration","expired","active","initializing_timed_out","validation_timed_out","issuance_timed_out","deployment_timed_out","deletion_timed_out","pending_cleanup","staging_deployment","staging_active","deactivating","inactive","backup_issued","holding_deployment"],"example":"pending_validation","readOnly":true},"type":{"description":"Level of validation to be used for this hostname. Domain validation (dv) must be used.","enum":["dv"],"example":"dv","readOnly":true},"uploaded_on":{"description":"The time the custom certificate was uploaded.","example":"2020-02-06T18:11:23.531995Z","format":"date-time","type":"string"},"validation_errors":{"description":"Domain validation errors that have been received by the certificate authority (CA).","items":{"properties":{"message":{"description":"A domain validation error.","example":"SERVFAIL looking up CAA for app.example.com","type":"string"}},"type":"object"},"type":"array"},"validation_records":{"items":{"$ref":"#/components/schemas/validation_record"},"type":"array"},"wildcard":{"description":"Indicates whether the certificate covers a wildcard.","example":false,"type":"boolean"}},"type":"object"}],"type":"object"},"ssl-recommender_components-schemas-value":{"enum":["flexible","full","strict"],"example":"strict","type":"string"},"ssl_recommender":{"allOf":[{"properties":{"enabled":{"$ref":"#/components/schemas/ssl_recommender_enabled"},"id":{"description":"Enrollment value for SSL/TLS Recommender.","enum":["ssl_recommender"],"example":"ssl_recommender"}}},{"properties":{"editable":{"$ref":"#/components/schemas/editable"},"modified_on":{"$ref":"#/components/schemas/modified_on-zM0Z89yx"}}}],"description":"Enrollment in the SSL/TLS Recommender service which tries to detect and recommend (by sending periodic emails) the most secure SSL/TLS setting your origin servers support.","title":"SSL/TLS Recommender"},"ssl_recommender_enabled":{"default":false,"description":"ssl-recommender enrollment setting.","type":"boolean"},"ssl_universal_settings_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/universal"}}}]},"ssl_validation_method_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"status":{"$ref":"#/components/schemas/validation_method_components-schemas-status"},"validation_method":{"$ref":"#/components/schemas/validation_method_definition"}}}}}]},"ssl_value":{"default":"off","description":"Value of the zone setting.\nNotes: Depends on the zone's plan level","enum":["off","flexible","full","strict"],"type":"string"},"ssl_verification_response_collection":{"allOf":[{"properties":{"result":{"items":{"$ref":"#/components/schemas/verification"},"type":"array"}}}]},"sslpost":{"description":"SSL properties used when creating the custom hostname.","oneOf":[{"properties":{"bundle_method":{"default":"ubiquitous","description":"A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it.","enum":["ubiquitous","optimal","force"],"example":"ubiquitous","type":"string"},"certificate_authority":{"$ref":"#/components/schemas/certificate_authority"},"custom_certificate":{"description":"If a custom uploaded certificate is used.","example":"-----BEGIN CERTIFICATE-----\\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\\n-----END CERTIFICATE-----\\n","type":"string"},"custom_key":{"description":"The key for a custom uploaded certificate.","example":"-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n","type":"string"},"method":{"description":"Domain control validation (DCV) method used for this hostname.","enum":["http","txt","email"],"example":"http"},"settings":{"$ref":"#/components/schemas/sslsettings"},"type":{"description":"Level of validation to be used for this hostname. Domain validation (dv) must be used.","enum":["dv"],"example":"dv"},"wildcard":{"description":"Indicates whether the certificate covers a wildcard.","example":false,"type":"boolean"}},"type":"object"}],"type":"object"},"sslpost-TcVapXSa":{"description":"SSL properties used when creating the custom hostname.","oneOf":[{"properties":{"bundle_method":{"default":"ubiquitous","description":"A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it.","enum":["ubiquitous","optimal","force"],"example":"ubiquitous","type":"string"},"custom_certificate":{"description":"If a custom uploaded certificate is used.","example":"-----BEGIN CERTIFICATE-----\\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\\n-----END CERTIFICATE-----\\n","type":"string"},"custom_key":{"description":"The key for a custom uploaded certificate.","example":"-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n","type":"string"},"method":{"description":"Domain control validation (DCV) method used for this hostname.","enum":["http","txt","email"],"example":"http"},"settings":{"$ref":"#/components/schemas/sslsettings"},"type":{"description":"Level of validation to be used for this hostname. Domain validation (dv) must be used.","enum":["dv"],"example":"dv","readOnly":true},"wildcard":{"description":"Indicates whether the certificate covers a wildcard.","example":false,"type":"boolean"}},"type":"object"}],"type":"object"},"sslsettings":{"description":"SSL specific settings.","properties":{"ciphers":{"description":"An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format.","example":["ECDHE-RSA-AES128-GCM-SHA256","AES128-SHA"],"items":{"type":"string"},"type":"array","uniqueItems":true},"early_hints":{"description":"Whether or not Early Hints is enabled.","enum":["on","off"],"example":"on"},"http2":{"description":"Whether or not HTTP2 is enabled.","enum":["on","off"],"example":"on"},"min_tls_version":{"description":"The minimum TLS version supported.","enum":["1.0","1.1","1.2","1.3"],"example":"1.2"},"tls_1_3":{"description":"Whether or not TLS 1.3 is enabled.","enum":["on","off"],"example":"on"}},"type":"object"},"stage":{"description":"The status of the deployment.","properties":{"ended_on":{"description":"When the stage ended.","example":"2021-03-09T00:58:59.045655","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"name":{"description":"The current build stage.","example":"deploy","pattern":"queued|initialize|clone_repo|build|deploy","type":"string"},"started_on":{"description":"When the stage started.","example":"2021-03-09T00:55:03.923456Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"status":{"description":"State of the current stage.","example":"success","pattern":"success|idle|active|failure|canceled","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"},"start_end_params":{"properties":{"end":{"description":"Defaults to the current date.","example":"2021-04-30","format":"date","type":"string"},"start":{"description":"Defaults to 30 days before the end parameter value.","example":"2021-04-01","format":"date","type":"string"}},"type":"object"},"start_time_seconds":{"description":"Specifies the start time for the video clip in seconds.","readOnly":true,"type":"integer"},"state":{"description":"State, provided by the CSR","example":"CA","readOnly":true,"type":"string"},"state-MZbhRzAd":{"description":"The state that the subscription is in.","enum":["Trial","Provisioned","Paid","AwaitingPayment","Cancelled","Failed","Expired"],"example":"Paid","readOnly":true,"type":"string"},"status":{"description":"The current status of the origin server according to the health check.","enum":["unknown","healthy","unhealthy","suspended"],"example":"healthy","readOnly":true,"type":"string"},"status-2mOK9Pc7":{"description":"Status of DNSSEC, based on user-desired state and presence of necessary records.","enum":["active","pending","disabled","pending-disabled","error"],"example":"active"},"status-5v6phuGF":{"enum":["event_prequeueing","not_queueing","queueing"],"example":"queueing","type":"string"},"status-8gYjapkg":{"description":"Status of the token.","enum":["active","disabled","expired"],"example":"active","type":"string"},"status-cnKVAn0b":{"default":"disabled","description":"The status of the Page Rule.","enum":["active","disabled"],"example":"active","type":"string"},"status-dMauZcAv":{"description":"Status of the zone's custom SSL.","enum":["active","expired","deleted","pending","initializing"],"example":"active","readOnly":true},"status_event_id":{"example":"25756b2dfe6e378a06b033b670413757","type":"string"},"status_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"estimated_queued_users":{"$ref":"#/components/schemas/estimated_queued_users"},"estimated_total_active_users":{"$ref":"#/components/schemas/estimated_total_active_users"},"event_id":{"$ref":"#/components/schemas/status_event_id"},"max_estimated_time_minutes":{"$ref":"#/components/schemas/max_estimated_time_minutes"},"status":{"$ref":"#/components/schemas/status-5v6phuGF"}},"type":"object"}}}]},"std_dev_rtt_ms":{"description":"Standard deviation of the RTTs in ms.","type":"number"},"steering_policy":{"default":"\"\"","description":"Steering Policy for this load balancer.\n- `\"off\"`: Use `default_pools`.\n- `\"geo\"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools` is determined by `location_strategy`.\n- `\"random\"`: Select a pool randomly.\n- `\"dynamic_latency\"`: Use round trip time to select the closest pool in default_pools (requires pool health checks).\n- `\"proximity\"`: Use the pools' latitude and longitude to select the closest pool using the Cloudflare PoP location for proxied requests or the location determined by `location_strategy` for non-proxied requests.\n- `\"\"`: Will map to `\"geo\"` if you use `region_pools`/`country_pools`/`pop_pools` otherwise `\"off\"`.","enum":["off","geo","random","dynamic_latency","proximity","\"\""],"example":"dynamic_latency","type":"string"},"stix_identifier":{"description":"STIX 2.1 identifier: https://docs.oasis-open.org/cti/stix/v2.1/cs02/stix-v2.1-cs02.html#_64yvzeku5a5c","example":"ipv4-addr--baa568ec-6efe-5902-be55-0663833db537","type":"string"},"string_constraint":{"description":"String constraint.","properties":{"operator":{"default":"contains","description":"The matches operator can use asterisks and pipes as wildcard and 'or' operators.","enum":["matches","contains","equals","not_equal","not_contain"]},"value":{"description":"The value to apply the operator to.","type":"string"}},"required":["operator","value"],"type":"object"},"subcategory":{"properties":{"beta":{"$ref":"#/components/schemas/beta"},"class":{"$ref":"#/components/schemas/class"},"description":{"$ref":"#/components/schemas/components-schemas-description"},"id":{"$ref":"#/components/schemas/id"},"name":{"$ref":"#/components/schemas/categories_components-schemas-name"}},"type":"object"},"subdivision_code_a2":{"description":"Two-letter subdivision code followed in ISO 3166-2.","example":"CA","type":"string"},"subdomain":{"description":"The DNS Over HTTPS domain to send DNS requests to. (auto-generated).","example":"oli3n9zkz5","type":"string"},"subdomain-response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"properties":{"name":{"readOnly":true}},"type":"object"}}}]},"subscription":{"allOf":[{"$ref":"#/components/schemas/subscription-v2"}],"type":"object"},"subscription-v2":{"properties":{"app":{"properties":{"install_id":{"$ref":"#/components/schemas/install_id"}}},"component_values":{"$ref":"#/components/schemas/component_values"},"currency":{"$ref":"#/components/schemas/currency"},"current_period_end":{"$ref":"#/components/schemas/current_period_end"},"current_period_start":{"$ref":"#/components/schemas/current_period_start"},"frequency":{"$ref":"#/components/schemas/frequency-StdFMmw2"},"id":{"$ref":"#/components/schemas/subscription-v2_components-schemas-identifier"},"price":{"$ref":"#/components/schemas/price"},"rate_plan":{"$ref":"#/components/schemas/rate_plan"},"state":{"$ref":"#/components/schemas/state-MZbhRzAd"},"zone":{"$ref":"#/components/schemas/zone-NCQbmiTF"}},"type":"object"},"subscription-v2_components-schemas-identifier":{"description":"Subscription identifier tag.","example":"506e3185e9c882d175a2d0cb0093d9f2","maxLength":32,"readOnly":true,"type":"string"},"suggested_threshold":{"description":"The suggested threshold in requests done by the same auth_id or period_seconds.","readOnly":true,"type":"integer"},"support_url":{"description":"The URL to launch when the Send Feedback button is clicked.","example":"https://1.1.1.1/help","type":"string"},"supported_tld":{"description":"Whether a particular TLD is currently supported by Cloudflare Registrar. Refer to [TLD Policies](https://www.cloudflare.com/tld-policies/) for a list of supported TLDs.","example":true,"type":"boolean"},"suspended":{"default":false,"description":"If suspended, no health checks are sent to the origin.","type":"boolean"},"suspended-qdpN2ZN2":{"default":false,"description":"Suspends or allows traffic going to the waiting room. If set to `true`, the traffic will not go to the waiting room.","type":"boolean"},"switch_locked":{"description":"Whether to allow the user to turn off the WARP switch and disconnect the client.","example":true,"type":"boolean"},"tags":{"description":"Custom tags for the DNS record. This field has no effect on DNS responses.","items":{"description":"Individual tag of the form name:value (the name must consist of only letters, numbers, underscores and hyphens)","example":"owner:dns-team","type":"string"},"type":"array"},"tail-response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"properties":{"expires_at":{"readOnly":true},"id":{"readOnly":true},"url":{"readOnly":true}},"type":"object"}}}]},"target":{"description":"A request condition target.","oneOf":[{"$ref":"#/components/schemas/url_target"}],"required":["target","constraint"]},"target-MnAfh9We":{"description":"The target hostname, IPv6, or IPv6 address.","example":"1.1.1.1","type":"string"},"target_result":{"properties":{"colos":{"items":{"$ref":"#/components/schemas/colo_result"},"type":"array"},"target":{"$ref":"#/components/schemas/target-MnAfh9We"}},"type":"object"},"target_summary":{"description":"Aggregated statistics from all hops about the target.","example":{"asn":"","ip":"1.1.1.1","max_latency_ms":0.034,"mean_latency_ms":0.021,"min_latency_ms":0.014,"name":"1.1.1.1","packet_count":3,"std_dev_latency_ms":0.011269427669584647},"type":"object"},"targets":{"description":"The rule targets to evaluate on each request.","example":[{"constraint":{"operator":"matches","value":"*example.com/images/*"},"target":"url"}],"items":{"$ref":"#/components/schemas/target"},"type":"array"},"targets-8BcM0LKv":{"example":["203.0.113.1","cloudflare.com"],"items":{"description":"Hosts as a hostname or IPv4/IPv6 address represented by strings.","example":"203.0.113.1","type":"string"},"maxLength":10,"type":"array"},"tcp_config":{"description":"Parameters specific to TCP health check.","nullable":true,"properties":{"method":{"default":"connection_established","description":"The TCP connection method to use for the health check.","enum":["connection_established"],"type":"string"},"port":{"default":80,"description":"Port number to connect to for the health check. Defaults to 80.","type":"integer"}},"type":"object"},"teamnet":{"properties":{"comment":{"$ref":"#/components/schemas/comment-ZBQ7qz21"},"created_at":{"description":"Timestamp of when the route was created."},"deleted_at":{"description":"Timestamp of when the route was deleted. If `null`, the route has not been deleted.","example":"2021-01-25T18:22:34.317854Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"network":{"$ref":"#/components/schemas/ip_network"},"tunnel_id":{"$ref":"#/components/schemas/schemas-tunnel_id"},"tunnel_name":{"$ref":"#/components/schemas/schemas-tunnel_name"},"virtual_network_id":{"$ref":"#/components/schemas/schemas-virtual_network_id"}},"required":["network","tunnel_id","comment","created_at"],"type":"object"},"teamnet_components-schemas-ip":{"example":"10.1.0.137","type":"string"},"telephone":{"description":"User's telephone number","example":"+1 123-123-1234","maxLength":20,"nullable":true,"type":"string"},"test_connection_properties":{"properties":{"body_hash":{"description":"Hash version of body.","example":"be27f2429421e12f200cab1da43ba301bdc70e1d","type":"string"},"body_size":{"description":"Size of the body in bytes.","example":"63910 bytes","type":"string"},"cf-cache-status":{"description":"Lists any `cf-cache-status` present.","type":"string"},"cf-ray":{"description":"Lists any `cf-ray` present.","example":"1ddd7570575207d9-LAX","type":"string"},"cf-wan-error":{"description":"Lists any `cf-wan-error` present.","type":"string"},"cloudflare":{"description":"Whether Cloudflare is enabled on the host.","example":"on","type":"string"},"connection_close":{"default":true,"description":"Connection closed or open.","example":false,"type":"boolean"},"elapsed_time":{"description":"Amount of seconds that the test lasted.","example":"0.239013s","type":"string"},"host_name":{"description":"The hostname queried.","example":"www.example.com","type":"string"},"http_status":{"description":"The HTTP status response code.","example":200,"type":"number"},"method":{"description":"HTTP Method used to test the connection.","enum":["GET","POST"],"example":"GET"},"missing_headers":{"description":"What headers are missing.","example":"No Content-Length or Transfer-Encoding.","type":"string"},"protocol":{"description":"Protocol used to test the connection.","example":"HTTP/1.1","type":"string"},"railgun":{"description":"Indicates if Railgun is enabled on the queried hostname.","example":"on","type":"string"},"response_status":{"description":"HTTP Status code.","example":"200 OK","type":"string"},"url":{"description":"Url of the domain you can compare the connection to.","example":"https://www.cloudflare.com","type":"string"}},"type":"object"},"test_connection_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/test_connection_properties"}}}]},"threats":{"description":"Breakdown of totals for threats.","properties":{"all":{"description":"The total number of identifiable threats received over the time frame.","type":"integer"},"country":{"description":"A list of key/value pairs where the key is a two-digit country code and the value is the number of malicious requests received from that country.","example":{"AU":91,"CN":523423,"US":123},"type":"object"},"type":{"description":"The list of key/value pairs where the key is a threat category and the value is the number of requests.","example":{"hot.ban.unknown":5324,"macro.chl.captchaErr":1341,"macro.chl.jschlErr":5323,"user.ban.ip":123},"type":"object"}},"type":"object"},"threshold":{"description":"The threshold that will trigger the configured mitigation action. Configure this value along with the `period` property to establish a threshold per period.","example":60,"minimum":1,"type":"number"},"thresholds":{"properties":{"thresholds":{"properties":{"auth_id_tokens":{"$ref":"#/components/schemas/auth_id_tokens"},"data_points":{"$ref":"#/components/schemas/data_points"},"last_updated":{"$ref":"#/components/schemas/timestamp"},"p50":{"$ref":"#/components/schemas/p50"},"p90":{"$ref":"#/components/schemas/p90"},"p99":{"$ref":"#/components/schemas/p99"},"period_seconds":{"$ref":"#/components/schemas/period_seconds"},"requests":{"$ref":"#/components/schemas/requests"},"suggested_threshold":{"$ref":"#/components/schemas/suggested_threshold"}},"type":"object"}},"readOnly":true,"required":["period_seconds","suggested_threshold","p50","p90","p99","requests","auth_id_tokens","data_points","last_updated"],"type":"object"},"thumbnailTimestampPct":{"default":0,"description":"The timestamp for a thumbnail image calculated as a percentage value of the video's duration. To convert from a second-wise timestamp to a percentage, divide the desired timestamp by the total duration of the video. If this value is not set, the default thumbnail image is taken from 0s of the video.","example":0.529241,"maximum":1,"minimum":0,"type":"number"},"thumbnail_url":{"description":"URI to thumbnail variant for an image.","example":"https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/thumbnail","format":"uri","readOnly":true,"type":"string"},"thumbnail_url-GZVIYimZ":{"description":"The media item's thumbnail URI. This field is omitted until encoding is complete.","example":"https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/thumbnails/thumbnail.jpg","format":"uri","readOnly":true,"type":"string"},"tiered-cache-smart-topology-api_components-schemas-value":{"description":"Enables Tiered Cache.","enum":["on","off"],"example":"on","type":"string"},"time":{"description":"The time for a specific event.","example":"2019-10-24T17:09:42.883908+01:00","type":"string"},"time_delta":{"description":"Unit of time to group data by.","enum":["all","auto","year","quarter","month","week","day","hour","dekaminute","minute"],"example":"hour","type":"string"},"timeout":{"default":5,"description":"The timeout (in seconds) before marking the health check as failed.","type":"integer"},"timeout-QN7vNkTu":{"description":"The time in seconds during which Cloudflare will perform the mitigation action. Must be an integer value greater than or equal to the period.\nNotes: If \"mode\" is \"challenge\", \"managed_challenge\", or \"js_challenge\", Cloudflare will use the zone's Challenge Passage time and you should not provide this value.","example":86400,"maximum":86400,"minimum":1,"type":"number"},"timeseries":{"description":"Time deltas containing metadata about each bucket of time. The number of buckets (resolution) is determined by the amount of time between the since and until parameters.","items":{"properties":{"bandwidth":{"$ref":"#/components/schemas/bandwidth"},"pageviews":{"$ref":"#/components/schemas/pageviews"},"requests":{"$ref":"#/components/schemas/schemas-requests"},"since":{"$ref":"#/components/schemas/since-cRELaVYs"},"threats":{"$ref":"#/components/schemas/threats"},"uniques":{"$ref":"#/components/schemas/uniques"},"until":{"$ref":"#/components/schemas/until-HpHDrENT"}},"type":"object"},"type":"array"},"timeseries_by_colo":{"description":"Time deltas containing metadata about each bucket of time. The number of buckets (resolution) is determined by the amount of time between the since and until parameters.","items":{"properties":{"bandwidth":{"$ref":"#/components/schemas/bandwidth_by_colo"},"requests":{"$ref":"#/components/schemas/requests_by_colo"},"since":{"$ref":"#/components/schemas/since-cRELaVYs"},"threats":{"$ref":"#/components/schemas/threats"},"until":{"$ref":"#/components/schemas/until-HpHDrENT"}},"type":"object"},"type":"array"},"timestamp":{"example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string"},"timestamps":{"default":"unixnano","description":"By default, timestamps in responses are returned as Unix nanosecond integers. The `?timestamps=` argument can be set to change the format in which response timestamps are returned. Possible values are: `unix`, `unixnano`, `rfc3339`. Note that `unix` and `unixnano` return timestamps as integers; `rfc3339` returns timestamps as strings.","enum":["unix","unixnano","rfc3339"],"example":"unixnano","type":"string"},"tls":{"description":"The type of TLS termination associated with the application.","enum":["off","flexible","full","strict"],"example":"full","type":"string"},"tls-settings":{"description":"TLS interception settings.","properties":{"enabled":{"description":"Enable inspecting encrypted HTTP traffic.","example":true,"type":"boolean"}},"type":"object"},"tls_1_2_only":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"Zone setting identifier.","enum":["tls_1_2_only"],"example":"tls_1_2_only"},"value":{"$ref":"#/components/schemas/tls_1_2_only_value"}}}],"description":"Only allows TLS1.2.","title":"TLS1.2 only"},"tls_1_2_only_value":{"default":"off","description":"Value of the zone setting.","enum":["off","on"],"type":"string"},"tls_1_3":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["tls_1_3"],"example":"tls_1_3"},"value":{"$ref":"#/components/schemas/tls_1_3_value"}}}],"default":"off","description":"Enables Crypto TLS 1.3 feature for a zone.","title":"Enable TLS 1.3 value for a zone"},"tls_1_3_value":{"default":"off","description":"Value of the zone setting.\nNotes: Default value depends on the zone's plan level.","enum":["on","off","zrt"],"type":"string"},"tls_client_auth":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["tls_client_auth"],"example":"tls_client_auth"},"value":{"$ref":"#/components/schemas/tls_client_auth_value"}}}],"description":"TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only).","title":"TLS Client Authentication"},"tls_client_auth_value":{"default":"on","description":"value of the zone setting.","enum":["on","off"],"type":"string"},"tls_config_request":{"properties":{"sha256":{"description":"The SHA-256 hash of the TLS certificate presented by the host found at tls_sockaddr. If absent, regular certificate verification (trusted roots, valid timestamp, etc) will be used to validate the certificate.","example":"b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c","type":"string"},"tls_sockaddr":{"description":"A network address of the form \"host:port\" that the WARP client will use to detect the presence of a TLS host.","example":"foobar:1234","type":"string"}},"required":["tls_sockaddr"],"type":"object"},"tls_config_response":{"description":"The Managed Network TLS Config Response.","properties":{"sha256":{"description":"The SHA-256 hash of the TLS certificate presented by the host found at tls_sockaddr. If absent, regular certificate verification (trusted roots, valid timestamp, etc) will be used to validate the certificate.","example":"b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c","type":"string"},"tls_sockaddr":{"description":"A network address of the form \"host:port\" that the WARP client will use to detect the presence of a TLS host.","example":"foobar:1234","type":"string"}},"required":["tls_sockaddr"],"type":"object"},"token":{"properties":{"condition":{"$ref":"#/components/schemas/condition"},"expires_on":{"$ref":"#/components/schemas/expires_on-dkbMDCaD"},"id":{"$ref":"#/components/schemas/components-schemas-identifier-vS0Y8rdw"},"issued_on":{"$ref":"#/components/schemas/issued_on-ckMiaqK5"},"modified_on":{"$ref":"#/components/schemas/modified_on-bJDfxiY8"},"name":{"$ref":"#/components/schemas/name-pG4STmz5"},"not_before":{"$ref":"#/components/schemas/not_before"},"policies":{"$ref":"#/components/schemas/policies-iecjppBc"},"status":{"$ref":"#/components/schemas/status-8gYjapkg"}},"required":["id","name","status","policies"],"type":"object"},"total_active_users":{"description":"Sets the total number of active user sessions on the route at a point in time. A route is a combination of host and path on which a waiting room is available. This value is used as a baseline for the total number of active user sessions on the route. It is possible to have a situation where there are more or less active users sessions on the route based on the traffic patterns at that time around the world.","maximum":2147483647,"minimum":200,"type":"integer"},"total_tls_settings_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"certificate_authority":{"$ref":"#/components/schemas/components-schemas-certificate_authority"},"enabled":{"$ref":"#/components/schemas/components-schemas-enabled"},"validity_days":{"$ref":"#/components/schemas/schemas-validity_days"}}}}}]},"total_tls_settings_response-uh822r21":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"certificate_authority":{"$ref":"#/components/schemas/schemas-certificate_authority-mu8utRU0"},"enabled":{"$ref":"#/components/schemas/components-schemas-enabled"},"validity_days":{"$ref":"#/components/schemas/schemas-validity_days"}}}}}]},"totals":{"description":"Breakdown of totals by data type.","properties":{"bandwidth":{"$ref":"#/components/schemas/bandwidth"},"pageviews":{"$ref":"#/components/schemas/pageviews"},"requests":{"$ref":"#/components/schemas/schemas-requests"},"since":{"$ref":"#/components/schemas/since-cRELaVYs"},"threats":{"$ref":"#/components/schemas/threats"},"uniques":{"$ref":"#/components/schemas/uniques"},"until":{"$ref":"#/components/schemas/until-HpHDrENT"}},"type":"object"},"totals_by_colo":{"description":"Breakdown of totals by data type.","properties":{"bandwidth":{"$ref":"#/components/schemas/bandwidth_by_colo"},"requests":{"$ref":"#/components/schemas/requests_by_colo"},"since":{"$ref":"#/components/schemas/since-cRELaVYs"},"threats":{"$ref":"#/components/schemas/threats"},"until":{"$ref":"#/components/schemas/until-HpHDrENT"}},"type":"object"},"trace":{"items":{"description":"List of steps acting on request/response","properties":{"action":{"description":"If step type is rule, then action performed by this rule","example":"execute","pattern":"^[a-z_]+$","type":"string"},"action_parameters":{"description":"If step type is rule, then action parameters of this rule as JSON","example":{"id":"4814384a9e5d4991b9815dcfc25d2f1f"},"type":"object"},"description":{"description":"If step type is rule or ruleset, the description of this entity","example":"some rule","type":"string"},"expression":{"description":"If step type is rule, then expression used to match for this rule","example":"ip.src ne 1.1.1.1","type":"string"},"kind":{"description":"If step type is ruleset, then kind of this ruleset","example":"zone","type":"string"},"matched":{"description":"Whether tracing step affected tracing request/response","example":true,"type":"boolean"},"name":{"description":"If step type is ruleset, then name of this ruleset","example":"some ruleset name","type":"string"},"step_name":{"description":"Tracing step identifying name","example":"rule_id01","type":"string"},"trace":{"$ref":"#/components/schemas/trace"},"type":{"description":"Tracing step type","example":"rule","type":"string"}},"type":"object"},"type":"array"},"traceroute_components-schemas-ip":{"description":"IP address of the node.","type":"string"},"traceroute_components-schemas-name":{"description":"Host name of the address, this may be the same as the IP address.","type":"string"},"traceroute_components-schemas-port":{"default":0,"description":"For UDP and TCP, specifies the destination port. For ICMP, specifies the initial ICMP sequence value. Default value 0 will choose the best value to use for each protocol.","maximum":65535,"minimum":0,"type":"integer"},"traceroute_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/target_result"},"type":"array"}}}]},"traceroute_time_ms":{"description":"Total time of traceroute in ms.","type":"integer"},"traditional_allow_rule":{"allOf":[{"$ref":"#/components/schemas/rule_components-schemas-base-2"},{"properties":{"allowed_modes":{"$ref":"#/components/schemas/allowed_modes_allow_traditional"},"mode":{"$ref":"#/components/schemas/mode_allow_traditional"}}}],"description":"When triggered, traditional WAF rules cause the firewall to immediately act on the request based on the rule configuration. An 'allow' rule will immediately allow the request and no other rules will be processed.","required":["id","description","priority","allowed_modes","default_mode","mode","group","package_id"],"title":"Traditional (allow) WAF rule"},"traditional_deny_rule":{"allOf":[{"$ref":"#/components/schemas/rule_components-schemas-base-2"},{"properties":{"allowed_modes":{"$ref":"#/components/schemas/allowed_modes_deny_traditional"},"default_mode":{"$ref":"#/components/schemas/default_mode"},"mode":{"$ref":"#/components/schemas/mode_deny_traditional"}}}],"description":"When triggered, traditional WAF rules cause the firewall to immediately act upon the request based on the configuration of the rule. A 'deny' rule will immediately respond to the request based on the configured rule action/mode (for example, 'block') and no other rules will be processed.","required":["id","description","priority","allowed_modes","default_mode","mode","group","package_id"],"title":"Traditional (deny) WAF rule"},"traffic":{"description":"The wirefilter expression to be used for traffic matching.","example":"http.request.uri matches \".*a/partial/uri.*\" and http.request.host in $01302951-49f9-47c9-a400-0297e60b6a10","type":"string"},"traffic_type":{"default":"direct","description":"Determines how data travels from the edge to your origin. When set to \"direct\", Spectrum will send traffic directly to your origin, and the application's type is derived from the `protocol`. When set to \"http\" or \"https\", Spectrum will apply Cloudflare's HTTP/HTTPS features as it sends traffic to your origin, and the application type matches this property exactly.","enum":["direct","http","https"],"example":"direct","type":"string"},"transfer_in":{"description":"Statuses for domain transfers into Cloudflare Registrar.","properties":{"accept_foa":{"description":"Form of authorization has been accepted by the registrant.","example":"needed"},"approve_transfer":{"description":"Shows transfer status with the registry.","example":"unknown"},"can_cancel_transfer":{"description":"Indicates if cancellation is still possible.","example":true,"type":"boolean"},"disable_privacy":{"description":"Privacy guards are disabled at the foreign registrar."},"enter_auth_code":{"description":"Auth code has been entered and verified.","example":"needed"},"unlock_domain":{"description":"Domain is unlocked at the foreign registrar."}}},"transform-rules_components-schemas-action_parameters":{"description":"The parameters configuring the action.","oneOf":[{"$ref":"#/components/schemas/action_parameters_rewrite"}],"type":"object"},"transform-rules_components-schemas-rule":{"properties":{"action":{"example":"rewrite"},"action_parameters":{"$ref":"#/components/schemas/transform-rules_components-schemas-action_parameters"},"description":{"example":"change request based on ip location"},"expression":{"example":"ip.geoip.country eq \"AL\""},"id":{"example":"3a03d665bac047339bb530ecb439a90d"},"version":{"example":"1"}}},"transform-rules_components-schemas-ruleset":{"properties":{"description":{"example":""},"id":{"example":"2f2feab2026849078ba485f918791bdc"},"kind":{"example":"zone"},"name":{"example":"default"},"phase":{"example":"http_request_transform"},"rules":{"description":"The rules in the ruleset.","items":{"$ref":"#/components/schemas/transform-rules_components-schemas-rule"},"type":"array"}}},"true_client_ip_header":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["true_client_ip_header"],"example":"true_client_ip_header"},"value":{"$ref":"#/components/schemas/true_client_ip_header_value"}}}],"default":"off","description":"Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones.","title":"True Client IP Header"},"true_client_ip_header_value":{"default":"off","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"tsig":{"properties":{"algo":{"$ref":"#/components/schemas/algo"},"id":{"$ref":"#/components/schemas/schemas-identifier-03kXbNiE"},"name":{"$ref":"#/components/schemas/schemas-name-rmJQq4HY"},"secret":{"$ref":"#/components/schemas/secret"}},"required":["id","name","secret","algo"],"type":"object"},"tsig_id":{"description":"TSIG authentication will be used for zone transfer if configured.","example":"69cd1e104af3e6ed3cb344f263fd0d5a","type":"string"},"ttl":{"default":64,"description":"Time To Live (TTL) in number of hops of the GRE tunnel.","type":"integer"},"ttl-0jCBhfJ2":{"description":"Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.","example":30,"type":"number"},"ttl-Us5Qprrb":{"anyOf":[{"example":3600,"maximum":86400,"minimum":30,"type":"number"},{"enum":[1],"type":"number"}],"default":1,"description":"Time To Live (TTL) of the DNS record in seconds. Setting to 1 means 'automatic'. Value must be between 60 and 86400, with the minimum reduced to 30 for Enterprise zones.","example":3600,"type":"number"},"ttl-vFKh1wOV":{"description":"Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.","example":30,"type":"number"},"tunnel":{"description":"A Cloudflare Tunnel that connects your origin to Cloudflare's edge.","properties":{"account_tag":{"$ref":"#/components/schemas/cf_account_id"},"connections":{"$ref":"#/components/schemas/connections"},"conns_active_at":{"$ref":"#/components/schemas/conns_active_at"},"conns_inactive_at":{"$ref":"#/components/schemas/conns_inactive_at"},"created_at":{"$ref":"#/components/schemas/cloudflare-tunnel_components-schemas-created_at"},"deleted_at":{"$ref":"#/components/schemas/deleted_at-5nLnuPfs"},"id":{"$ref":"#/components/schemas/tunnel_id"},"metadata":{"$ref":"#/components/schemas/cloudflare-tunnel_components-schemas-metadata"},"name":{"$ref":"#/components/schemas/tunnel_name"},"remote_config":{"$ref":"#/components/schemas/remote_config"},"status":{"$ref":"#/components/schemas/cloudflare-tunnel_components-schemas-status"},"tun_type":{"$ref":"#/components/schemas/tunnel_type"}},"type":"object"},"tunnel_add_single_request":{"properties":{"cloudflare_gre_endpoint":{"$ref":"#/components/schemas/cloudflare_gre_endpoint"},"customer_gre_endpoint":{"$ref":"#/components/schemas/customer_gre_endpoint"},"description":{"$ref":"#/components/schemas/schemas-description-SitV9b51"},"health_check":{"$ref":"#/components/schemas/health_check"},"interface_address":{"$ref":"#/components/schemas/interface_address"},"mtu":{"$ref":"#/components/schemas/mtu"},"name":{"$ref":"#/components/schemas/name-z6BHq9UH"},"ttl":{"$ref":"#/components/schemas/ttl"}},"required":["name","customer_gre_endpoint","cloudflare_gre_endpoint","interface_address"],"type":"object"},"tunnel_connection":{"description":"A connection between cloudflared and a Cloudflare data center.","properties":{"arch":{"$ref":"#/components/schemas/arch"},"config_version":{"$ref":"#/components/schemas/config_version"},"conns":{"$ref":"#/components/schemas/connections"},"features":{"$ref":"#/components/schemas/schemas-features"},"id":{"$ref":"#/components/schemas/connection_id"},"run_at":{"$ref":"#/components/schemas/run_at"},"version":{"$ref":"#/components/schemas/cloudflare-tunnel_components-schemas-version"}},"type":"object"},"tunnel_connections_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/tunnel_connection"},"type":"array"}},"type":"object"}]},"tunnel_deleted_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"deleted":{"example":true,"type":"boolean"},"deleted_gre_tunnel":{"type":"object"}}}}}]},"tunnel_health_check":{"properties":{"enabled":{"default":true,"description":"Determines whether to run healthchecks for a tunnel.","example":true,"type":"boolean"},"rate":{"default":"mid","description":"How frequent the health check is run. The default value is `mid`.","enum":["low","mid","high"],"example":"low","type":"string"},"target":{"description":"The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`.","example":"203.0.113.1","type":"string"},"type":{"default":"reply","description":"The type of healthcheck to run, reply or request. The default value is `reply`.","enum":["reply","request"],"example":"request","type":"string"}},"type":"object"},"tunnel_id":{"description":"UUID of the tunnel.","example":"f70ff985-a4ef-4643-bbbc-4a0ed4fc8415","maxLength":36,"readOnly":true,"type":"string"},"tunnel_modified_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"modified":{"example":true,"type":"boolean"},"modified_gre_tunnel":{"type":"object"}}}}}]},"tunnel_name":{"description":"A user-friendly name for the tunnel.","example":"blog","type":"string"},"tunnel_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/argo-tunnel"},"type":"array"}},"type":"object"}]},"tunnel_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}},"type":"object"}]},"tunnel_response_token":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"string"}},"type":"object"}]},"tunnel_secret":{"description":"Sets the password required to run a locally-managed tunnel. Must be at least 32 bytes and encoded as a base64 string.","example":"AQIDBAUGBwgBAgMEBQYHCAECAwQFBgcIAQIDBAUGBwg=","type":"string"},"tunnel_single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"gre_tunnel":{"type":"object"}}}}}]},"tunnel_type":{"description":"The type of tunnel.","enum":["cfd_tunnel"],"example":"cfd_tunnel","type":"string"},"tunnel_update_request":{"allOf":[{"$ref":"#/components/schemas/tunnel_add_single_request"}]},"tunnels_collection_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"gre_tunnels":{"items":{"$ref":"#/components/schemas/gre-tunnel"},"type":"array"}}}}}]},"tus_resumable":{"description":"Specifies the TUS protocol version. This value must be included in every upload request.\nNotes: The only supported version of TUS protocol is 1.0.0.","enum":["1.0.0"],"example":"1.0.0","type":"string"},"two_factor_authentication_enabled":{"default":false,"description":"Indicates whether two-factor authentication is enabled for the user account. Does not apply to API authentication.","readOnly":true,"type":"boolean"},"type":{"description":"The type of List.","enum":["SERIAL","URL","DOMAIN","EMAIL","IP"],"example":"SERIAL","type":"string"},"type-52Dm78wx":{"description":"The billing item type.","example":"charge","maxLength":30,"readOnly":true,"type":"string"},"type-8rJfuYNQ":{"default":"legacy_custom","description":"The type 'legacy_custom' enables support for legacy clients which do not include SNI in the TLS handshake.","enum":["legacy_custom","sni_custom"],"example":"sni_custom","type":"string"},"type-Eu3SX4l3":{"default":"HTTP","description":"The protocol to use for the health check. Currently supported protocols are 'HTTP', 'HTTPS' and 'TCP'.","example":"HTTPS","type":"string"},"type-gTI6cLgq":{"default":"http","description":"The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'.","enum":["http","https","tcp","udp_icmp","icmp_ping","smtp"],"example":"https","type":"string"},"type-kxPaBgXc":{"description":"A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup.","enum":["full","partial"],"example":"full","type":"string"},"type-tb4QXpPC":{"description":"The type of Device Posture Rule.","enum":["file","application","serial_number","tanium","gateway","warp","disk_encryption"],"example":"file","type":"string"},"type-u7orNcta":{"description":"The application type.","enum":["self_hosted","saas","ssh","vnc","app_launcher","warp","biso","bookmark","dash_sso"],"example":"self_hosted","type":"string"},"ua-rules":{"allOf":[{"$ref":"#/components/schemas/firewalluablock"}],"type":"object"},"ua-rules_components-schemas-description":{"description":"An informative summary of the rule.","example":"Prevent access from abusive clients identified by this User Agent to mitigate a DDoS attack","maxLength":1024,"type":"string"},"ua-rules_components-schemas-id":{"description":"The unique identifier of the User Agent Blocking rule.","example":"372e67954025e0ba6aaa6d586b9e0b59","maxLength":32,"readOnly":true,"type":"string"},"ua-rules_components-schemas-mode":{"description":"The action to apply to a matched request.","enum":["block","challenge","js_challenge","managed_challenge"],"example":"js_challenge","maxLength":12},"ui_read_only_toggle_reason":{"description":"A description of the reason why the UI read only field is being toggled.","example":"Temporarily turn off the UI read only lock to make a change via the UI","type":"string"},"uid":{"description":"The unique API identifier for the user."},"uniques":{"properties":{"all":{"description":"Total number of unique IP addresses within the time range.","type":"integer"}},"type":"object"},"unit_price":{"description":"The unit price of the addon.","example":1,"readOnly":true,"type":"number"},"universal":{"properties":{"enabled":{"$ref":"#/components/schemas/schemas-enabled"}},"type":"object"},"unrevoke_devices_request":{"description":"A list of device ids to unrevoke.","items":{"$ref":"#/components/schemas/uuid-s0SXln0q"},"maxLength":200,"type":"array"},"unrevoke_devices_request-bkyFobOE":{"description":"A list of device ids to unrevoke.","items":{"$ref":"#/components/schemas/schemas-uuid-lt6l49Ob"},"maxLength":200,"type":"array"},"until":{"description":"End date and time of requesting data period in ISO 8601 format.","example":"2023-11-11T13:00:00Z","format":"date-time","type":"string"},"until-HpHDrENT":{"anyOf":[{"type":"string"},{"type":"integer"}],"default":0,"description":"The (exclusive) end of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. If omitted, the time of the request is used.","example":"2015-01-02T12:23:00Z"},"until-XGNiH7hs":{"description":"End date and time of requesting data period in the ISO8601 format.","example":"2016-11-11T13:00:00Z","format":"date-time","type":"string"},"update-zone-settings-response":{"properties":{"enabled":{"$ref":"#/components/schemas/enabled-N6CliIvj"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"use_cloudflare_reporting_endpoint":{"$ref":"#/components/schemas/use_cloudflare_reporting_endpoint"},"use_connection_url_path":{"$ref":"#/components/schemas/use_connection_url_path"}}},"update_catch_all_rule_properties":{"properties":{"actions":{"$ref":"#/components/schemas/rule_catchall-actions"},"enabled":{"$ref":"#/components/schemas/rule_enabled-VMnvyEOL"},"matchers":{"$ref":"#/components/schemas/rule_catchall-matchers"},"name":{"$ref":"#/components/schemas/rule_name"}},"required":["actions","matchers"],"type":"object"},"update_custom_profile":{"properties":{"allowed_match_count":{"$ref":"#/components/schemas/allowed_match_count"},"description":{"description":"The description of the profile.","example":"A standard CVV card number","type":"string"},"entries":{"description":"The custom entries for this profile. Array elements with IDs are modifying the existing entry with that ID. Elements without ID will create new entries. Any entry not in the list will be deleted.","items":{"$ref":"#/components/schemas/custom_entry"},"type":"array"},"name":{"description":"The name of the profile.","example":"Generic CVV Card Number","type":"string"},"shared_entries":{"description":"Entries from other profiles (e.g. pre-defined Cloudflare profiles, or your Microsoft Information Protection profiles).","items":{"oneOf":[{"$ref":"#/components/schemas/shared_entry_update_predefined"},{"$ref":"#/components/schemas/shared_entry_update_integration"}]},"type":"array"}},"title":"Update custom profile","type":"object"},"update_custom_profile-j98uzXOJ":{"properties":{"allowed_match_count":{"$ref":"#/components/schemas/allowed_match_count"},"description":{"description":"The description of the profile.","example":"A standard CVV card number","type":"string"},"entries":{"description":"The entries for this profile. Array elements with IDs are modifying the existing entry with that ID. Elements without ID will create new entries. Any entry not in the list will be deleted.","items":{"$ref":"#/components/schemas/custom_entry-jOfsrCYH"},"type":"array"},"name":{"description":"The name of the profile.","example":"Generic CVV Card Number","type":"string"}},"title":"Update custom profile","type":"object"},"update_input_request":{"properties":{"defaultCreator":{"$ref":"#/components/schemas/live_input_default_creator"},"meta":{"$ref":"#/components/schemas/live_input_metadata"},"recording":{"$ref":"#/components/schemas/live_input_recording_settings"}}},"update_output_request":{"properties":{"enabled":{"$ref":"#/components/schemas/output_enabled"}},"required":["enabled"]},"update_predefined_profile":{"properties":{"allowed_match_count":{"$ref":"#/components/schemas/allowed_match_count"},"entries":{"description":"The entries for this profile.","items":{"properties":{"enabled":{"description":"Wheter the entry is enabled or not.","example":true,"type":"boolean"},"id":{"$ref":"#/components/schemas/entry_id-A2p6ZYit"}}},"type":"array"}},"title":"Update predefined profile","type":"object"},"update_rule_properties":{"properties":{"actions":{"$ref":"#/components/schemas/rule_actions"},"enabled":{"$ref":"#/components/schemas/rule_enabled-VMnvyEOL"},"matchers":{"$ref":"#/components/schemas/rule_matchers"},"name":{"$ref":"#/components/schemas/rule_name"},"priority":{"$ref":"#/components/schemas/rule_priority"}},"required":["actions","matchers"],"type":"object"},"update_rules":{"items":{"$ref":"#/components/schemas/create_rule"},"type":"array"},"update_ruleset":{"description":"A ruleset object.","properties":{"description":{"$ref":"#/components/schemas/rulesets_components-schemas-description"},"rules":{"$ref":"#/components/schemas/create_update_rules"}},"required":["rules"],"type":"object"},"update_settings":{"description":"Payload log settings","properties":{"public_key":{"description":"The public key to use when encrypting extracted payloads, as a base64 string","example":"EmpOvSXw8BfbrGCi0fhGiD/3yXk2SiV1Nzg2lru3oj0=","nullable":true,"type":"string"}},"required":["public_key"],"title":"Settings","type":"object"},"update_settings_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"public_key":{"example":"EmpOvSXw8BfbrGCi0fhGiD/3yXk2SiV1Nzg2lru3oj0=","nullable":true,"type":"string"}},"required":["public_key"]}}}]},"updated":{"description":"When the device was updated.","example":"2017-06-14T00:00:00Z","format":"date-time","type":"string"},"updated_at":{"description":"The timestamp of when Page Shield was last updated.","example":"2022-10-12T17:56:52.083582+01:00","type":"string"},"updated_at-AejnlvA8":{"description":"The time when the certificate was updated.","example":"2100-01-01T05:20:00Z","format":"date-time","readOnly":true,"type":"string"},"updated_at-W25UuRZk":{"description":"The time when the certificate was updated.","example":"2100-01-01T05:20:00Z","format":"date-time","readOnly":true,"type":"string"},"upgrade_info":{"description":"Defined when the Railgun version is out of date from the latest release from Cloudflare.","properties":{"download_link":{"description":"An HTTP link to download the latest Railgun binary.","example":"https://www.cloudflare.com/downloads/railgun","type":"string"},"latest_version":{"description":"Latest version of the Railgun receiver available to install.","example":"1.0.0","type":"string"}},"type":"object"},"upload_length":{"description":"Indicates the size of the entire upload in bytes. The value must be a non-negative integer.","minimum":0,"type":"integer"},"uploaded":{"description":"When the media item was uploaded.","example":"2014-01-02T02:20:00Z","format":"date-time","readOnly":true,"type":"string"},"uploaded-3C8O7sGT":{"description":"The date and time the media item was uploaded.","example":"2014-01-02T02:20:00Z","format":"date-time","readOnly":true,"type":"string"},"uploaded_on":{"description":"When the certificate was uploaded to Cloudflare.","example":"2014-01-01T05:20:00Z","format":"date-time","readOnly":true,"type":"string"},"uptycs_config_request":{"properties":{"client_key":{"description":"The Uptycs client secret.","example":"example client key","type":"string"},"client_secret":{"description":"The Uptycs client secret.","example":"example client secret","type":"string"},"customer_id":{"description":"The Uptycs customer ID.","example":"example customer id","type":"string"}},"required":["client_key","customer_id","client_secret"],"type":"object"},"uri_search":{"description":"A single URI to search for in the list of URLs of existing rules.","example":"/some/path","type":"string"},"url":{"default":"","description":"The URL associated with the custom page.","example":"http://www.example.com","format":"uri","type":"string"},"url_id":{"description":"Submission ID(s) to filter submission results by.","type":"integer"},"url_id_param":{"properties":{"url_id":{"$ref":"#/components/schemas/url_id"}},"type":"object"},"url_normalization_components-schemas-type":{"description":"The type of URL normalization performed by Cloudflare.","example":"cloudflare","type":"string"},"url_param":{"properties":{"url":{"$ref":"#/components/schemas/components-schemas-url"}},"type":"object"},"url_target":{"description":"URL target.","properties":{"constraint":{"allOf":[{"$ref":"#/components/schemas/string_constraint"},{"properties":{"value":{"description":"The URL pattern to match against the current request. The pattern may contain up to four asterisks ('*') as placeholders.","example":"*example.com/images/*","pattern":"^(https?://)?(([-a-zA-Z0-9*]*\\.)+[-a-zA-Z0-9]{2,20})(:(8080|8443|443|80))?(/[\\S]+)?$","type":"string"}}}],"description":"The constraint of a target.","type":"object"},"target":{"description":"A target based on the URL of the request.","enum":["url"],"example":"url"}},"type":"object"},"urls":{"description":"The URLs to include in the current WAF override. You can use wildcards. Each entered URL will be escaped before use, which means you can only use simple wildcard patterns.","items":{"example":"shop.example.com/*","type":"string"},"type":"array"},"usage-model-response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"properties":{"usage_model":{"readOnly":true}},"type":"object"}}}]},"usage_model":{"description":"Specifies the usage model for the Worker (e.g. 'bundled' or 'unbound').","example":"unbound","pattern":"^(bundled|unbound)$","type":"string"},"use_cloudflare_reporting_endpoint":{"description":"When true, CSP reports will be sent to https://csp-reporting.cloudflare.com/cdn-cgi/script_monitor/report","example":true,"type":"boolean"},"use_connection_url_path":{"description":"When true, the paths associated with connections URLs will also be analyzed.","example":true,"type":"boolean"},"user":{"properties":{"email":{"$ref":"#/components/schemas/email-sNyq81Xd"},"id":{"$ref":"#/components/schemas/uuid-s0SXln0q"},"name":{"description":"The enrolled device user's name.","example":"John Appleseed","type":"string"}},"type":"object"},"user-L6j8gcON":{"properties":{"email":{"$ref":"#/components/schemas/email-rXr4fRvz"},"id":{"$ref":"#/components/schemas/components-schemas-uuid-nWj9wBDf"},"name":{"description":"The enrolled device user's name.","example":"John Appleseed","type":"string"}},"type":"object"},"user_invite":{"allOf":[{"$ref":"#/components/schemas/base-bSfRyaRZ"},{"properties":{"status":{"description":"Current status of the invitation.","enum":["pending","accepted","rejected","expired"],"example":"accepted"}}}]},"user_seat_expiration_inactive_time":{"description":"The amount of time a user seat is inactive before it expires. When the user seat exceeds the set time of inactivity, the user is removed as an active seat and no longer counts against your Teams seat count. Must be in the format `300ms` or `2h45m`. Valid time units are: `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`.","example":"720h","type":"string"},"user_subscription_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/subscription"},"type":"array"}},"type":"object"}]},"user_subscription_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}},"type":"object"}]},"users":{"properties":{"access_seat":{"$ref":"#/components/schemas/schemas-access_seat"},"active_device_count":{"$ref":"#/components/schemas/active_device_count"},"created_at":{"$ref":"#/components/schemas/timestamp"},"email":{"$ref":"#/components/schemas/schemas-email"},"gateway_seat":{"$ref":"#/components/schemas/schemas-gateway_seat"},"id":{"$ref":"#/components/schemas/schemas-id"},"last_successful_login":{"$ref":"#/components/schemas/last_successful_login"},"name":{"$ref":"#/components/schemas/users_components-schemas-name"},"seat_uid":{"$ref":"#/components/schemas/seat_uid"},"uid":{"$ref":"#/components/schemas/uid"},"updated_at":{"$ref":"#/components/schemas/timestamp"}},"type":"object"},"users-OYnvPFO3":{"properties":{"access_seat":{"$ref":"#/components/schemas/schemas-access_seat"},"active_device_count":{"$ref":"#/components/schemas/active_device_count"},"created_at":{"$ref":"#/components/schemas/timestamp"},"email":{"$ref":"#/components/schemas/components-schemas-email"},"gateway_seat":{"$ref":"#/components/schemas/schemas-gateway_seat"},"id":{"$ref":"#/components/schemas/users_components-schemas-id"},"last_successful_login":{"$ref":"#/components/schemas/last_successful_login"},"name":{"$ref":"#/components/schemas/users_components-schemas-name"},"seat_uid":{"$ref":"#/components/schemas/seat_uid"},"uid":{"$ref":"#/components/schemas/uid"},"updated_at":{"$ref":"#/components/schemas/timestamp"}},"type":"object"},"users_components-schemas-id":{"description":"The ID of the user.","example":"f3b12456-80dd-4e89-9f5f-ba3dfff12365"},"users_components-schemas-name":{"description":"The name of the user.","example":"Jane Doe","type":"string"},"users_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result_info":{"properties":{"count":{"example":1},"page":{"example":1},"per_page":{"example":100},"total_count":{"example":1}},"type":"object"}}},{"properties":{"result":{"items":{"$ref":"#/components/schemas/users-OYnvPFO3"},"type":"array"}}}]},"uuid":{"description":"API Resource UUID tag.","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36,"type":"string"},"uuid-EBZK5Bp1":{"description":"UUID","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36,"readOnly":true,"type":"string"},"uuid-l20MFQPz":{"description":"API uuid tag.","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36,"type":"string"},"uuid-lbOWhPVX":{"description":"UUID","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36,"readOnly":true,"type":"string"},"uuid-s0SXln0q":{"description":"UUID","example":"f174e90a-fafe-4643-bbbc-4a0ed4fc8415","maxLength":36,"readOnly":true,"type":"string"},"validate_ownership_response":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"nullable":true,"properties":{"valid":{"example":true,"type":"boolean"}},"type":"object"}}}]},"validate_pattern":{"description":"A request to validate a pattern","properties":{"regex":{"description":"The regex pattern.","example":"^4[0-9]{6,}$","type":"string"}},"required":["regex"],"title":"Pattern","type":"object"},"validate_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"valid":{"example":true,"type":"boolean"}}}}}]},"validate_response-PaQpkUV3":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"nullable":true,"properties":{"message":{"example":"","type":"string"},"valid":{"example":true,"type":"boolean"}},"type":"object"}}}]},"validation_method":{"description":"Validation Method selected for the order.","enum":["txt","http","email"],"example":"txt","type":"string"},"validation_method_components-schemas-status":{"description":"Result status.","example":"pending_validation","type":"string"},"validation_method_definition":{"description":"Desired validation method.","enum":["http","cname","txt","email"],"example":"txt","type":"string"},"validation_record":{"description":"Certificate's required validation record.","properties":{"emails":{"description":"The set of email addresses that the certificate authority (CA) will use to complete domain validation.","example":["administrator@example.com","webmaster@example.com"],"items":{},"type":"array"},"http_body":{"description":"The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.","example":"ca3-574923932a82475cb8592200f1a2a23d","type":"string"},"http_url":{"description":"The url that will be checked during domain validation.","example":"http://app.example.com/.well-known/pki-validation/ca3-da12a1c25e7b48cf80408c6c1763b8a2.txt","type":"string"},"txt_name":{"description":"The hostname that the certificate authority (CA) will check for a TXT record during domain validation .","example":"_acme-challenge.app.example.com","type":"string"},"txt_value":{"description":"The TXT record that the certificate authority (CA) will check during domain validation.","example":"810b7d5f01154524b961ba0cd578acc2","type":"string"}},"type":"object"},"validity_days":{"description":"Validity Days selected for the order.","enum":[14,30,90,365],"type":"integer"},"value":{"description":"The value of the item in a List.","example":"8GE8721REF","type":"string"},"value-V4GUo1Bz":{"description":"The token value.","example":"8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T","maxLength":80,"minLength":40,"readOnly":true,"type":"string"},"vanity_name_servers":{"description":"An array of domains used for custom name servers. This is only\navailable for Business and Enterprise plans.","example":["ns1.example.com","ns2.example.com"],"items":{"format":"hostname","maxLength":253,"type":"string"},"type":"array"},"variant_generation_request":{"properties":{"id":{"$ref":"#/components/schemas/variants_components-schemas-identifier"},"neverRequireSignedURLs":{"$ref":"#/components/schemas/neverRequireSignedURLs"},"options":{"$ref":"#/components/schemas/options"}},"required":["id","options"],"type":"object"},"variant_list_response":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"$ref":"#/components/schemas/variants_response"}}}]},"variant_patch_request":{"properties":{"neverRequireSignedURLs":{"$ref":"#/components/schemas/neverRequireSignedURLs"},"options":{"$ref":"#/components/schemas/options"}},"required":["options"],"type":"object"},"variant_public_request":{"properties":{"hero":{"type":"object"}},"type":"object"},"variant_response":{"properties":{"variant":{"type":"object"}},"type":"object"},"variant_simple_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/variant_response"}}}]},"variants":{"allOf":[{"$ref":"#/components/schemas/schemas-base"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["variants"],"example":"variants"}}}],"description":"Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.","title":"Variants Caching"},"variants_components-schemas-identifier":{"example":"hero","maxLength":99,"pattern":"^[a-zA-Z0-9]$"},"variants_response":{"properties":{"variants":{"$ref":"#/components/schemas/variant_public_request"}},"type":"object"},"variants_response_value":{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/variants"},{"properties":{"value":{"$ref":"#/components/schemas/variants_value"}},"required":["value"]}]}}},"variants_value":{"description":"Value of the zone setting.","properties":{"avif":{"description":"List of strings with the MIME types of all the variants that should be served for avif.","example":["image/webp","image/jpeg"],"items":{},"type":"array","uniqueItems":true},"bmp":{"description":"List of strings with the MIME types of all the variants that should be served for bmp.","example":["image/webp","image/jpeg"],"items":{},"type":"array","uniqueItems":true},"gif":{"description":"List of strings with the MIME types of all the variants that should be served for gif.","example":["image/webp","image/jpeg"],"items":{},"type":"array","uniqueItems":true},"jp2":{"description":"List of strings with the MIME types of all the variants that should be served for jp2.","example":["image/webp","image/avif"],"items":{},"type":"array","uniqueItems":true},"jpeg":{"description":"List of strings with the MIME types of all the variants that should be served for jpeg.","example":["image/webp","image/avif"],"items":{},"type":"array","uniqueItems":true},"jpg":{"description":"List of strings with the MIME types of all the variants that should be served for jpg.","example":["image/webp","image/avif"],"items":{},"type":"array","uniqueItems":true},"jpg2":{"description":"List of strings with the MIME types of all the variants that should be served for jpg2.","example":["image/webp","image/avif"],"items":{},"type":"array","uniqueItems":true},"png":{"description":"List of strings with the MIME types of all the variants that should be served for png.","example":["image/webp","image/avif"],"items":{},"type":"array","uniqueItems":true},"tif":{"description":"List of strings with the MIME types of all the variants that should be served for tif.","example":["image/webp","image/avif"],"items":{},"type":"array","uniqueItems":true},"tiff":{"description":"List of strings with the MIME types of all the variants that should be served for tiff.","example":["image/webp","image/avif"],"items":{},"type":"array","uniqueItems":true},"webp":{"description":"List of strings with the MIME types of all the variants that should be served for webp.","example":["image/jpeg","image/avif"],"items":{},"type":"array","uniqueItems":true}},"type":"object"},"verification":{"properties":{"brand_check":{"$ref":"#/components/schemas/brand_check"},"cert_pack_uuid":{"$ref":"#/components/schemas/cert_pack_uuid"},"certificate_status":{"$ref":"#/components/schemas/certificate_status"},"signature":{"$ref":"#/components/schemas/schemas-signature"},"validation_method":{"$ref":"#/components/schemas/schemas-validation_method"},"verification_info":{"$ref":"#/components/schemas/verification_info"},"verification_status":{"$ref":"#/components/schemas/verification_status"},"verification_type":{"$ref":"#/components/schemas/verification_type"}},"required":["certificate_status"],"type":"object"},"verification_errors":{"description":"These are errors that were encountered while trying to activate a hostname.","example":["None of the A or AAAA records are owned by this account and the pre-generated ownership verification token was not found."],"items":{},"type":"array"},"verification_info":{"description":"Certificate's required verification information.","enum":["record_name","record_value","http_url","http_body","cname","cname_target","txt_name","txt_value"],"properties":{"record_name":{"description":"Name of CNAME record.","example":"b3b90cfedd89a3e487d3e383c56c4267.example.com","format":"hostname","type":"string"},"record_target":{"description":"Target of CNAME record.","example":"6979be7e4cfc9e5c603e31df7efac9cc60fee82d.comodoca.com","format":"hostname","type":"string"}},"type":"object"},"verification_status":{"description":"Status of the required verification information, omitted if verification status is unknown.","example":true,"type":"boolean"},"verification_type":{"description":"Method of verification.","enum":["cname","meta tag"],"example":"cname","type":"string"},"verified":{"description":"The date and time the destination address has been verified. Null means not verified yet.","example":"2014-01-02T02:20:00Z","format":"date-time","readOnly":true,"type":"string"},"version":{"description":"The version of the analyzed script.","properties":{"fetched_at":{"$ref":"#/components/schemas/fetched_at"},"hash":{"$ref":"#/components/schemas/hash"},"js_integrity_score":{"$ref":"#/components/schemas/js_integrity_score"}},"type":"object"},"version-SGF9qNGE":{"description":"The WARP client version.","example":"1.0.0","type":"string"},"version-VHkxmcSG":{"description":"The version of the ruleset.","example":"1","pattern":"^[0-9]+$","type":"string"},"videoClipStandard":{"properties":{"allowedOrigins":{"$ref":"#/components/schemas/allowedOrigins"},"clippedFromVideoUID":{"$ref":"#/components/schemas/clipped_from_video_uid"},"creator":{"$ref":"#/components/schemas/creator"},"endTimeSeconds":{"$ref":"#/components/schemas/end_time_seconds"},"maxDurationSeconds":{"$ref":"#/components/schemas/maxDurationSeconds"},"requireSignedURLs":{"$ref":"#/components/schemas/requireSignedURLs-9DKWYMwu"},"startTimeSeconds":{"$ref":"#/components/schemas/start_time_seconds"},"thumbnailTimestampPct":{"$ref":"#/components/schemas/thumbnailTimestampPct"},"watermark":{"$ref":"#/components/schemas/watermarkAtUpload"}},"required":["clippedFromVideoUID","startTimeSeconds","endTimeSeconds"],"type":"object"},"video_copy_request":{"properties":{"allowedOrigins":{"$ref":"#/components/schemas/allowedOrigins"},"creator":{"$ref":"#/components/schemas/creator"},"requireSignedURLs":{"$ref":"#/components/schemas/requireSignedURLs-9DKWYMwu"},"thumbnailTimestampPct":{"$ref":"#/components/schemas/thumbnailTimestampPct"},"url":{"description":"A video's URL. The server must be publicly routable and support `HTTP HEAD` requests and `HTTP GET` range requests. The server should respond to `HTTP HEAD` requests with a `content-range` header that includes the size of the file.","example":"https://example.com/myvideo.mp4","format":"uri","type":"string"},"watermark":{"$ref":"#/components/schemas/watermark_at_upload"}},"required":["url"]},"video_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/videos"},"type":"array"}}},{"properties":{"range":{"description":"The total number of remaining videos based on cursor position.","example":1000,"readOnly":true,"type":"integer"},"total":{"description":"The total number of videos that match the provided filters.","example":35586,"readOnly":true,"type":"integer"}}}]},"video_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/videos"}}}]},"video_update":{"properties":{"allowedOrigins":{"$ref":"#/components/schemas/allowedOrigins"},"creator":{"$ref":"#/components/schemas/creator"},"maxDurationSeconds":{"$ref":"#/components/schemas/maxDurationSeconds"},"meta":{"$ref":"#/components/schemas/media_metadata"},"requireSignedURLs":{"$ref":"#/components/schemas/requireSignedURLs-9DKWYMwu"},"thumbnailTimestampPct":{"$ref":"#/components/schemas/thumbnailTimestampPct"},"uploadExpiry":{"$ref":"#/components/schemas/oneTimeUploadExpiry"}},"type":"object"},"videos":{"properties":{"allowedOrigins":{"$ref":"#/components/schemas/allowedOrigins"},"created":{"$ref":"#/components/schemas/created-GBc463rN"},"creator":{"$ref":"#/components/schemas/creator"},"duration":{"$ref":"#/components/schemas/duration-nfHavjWr"},"input":{"$ref":"#/components/schemas/input-kvQ6FpFL"},"liveInput":{"$ref":"#/components/schemas/liveInput"},"maxDurationSeconds":{"$ref":"#/components/schemas/maxDurationSeconds"},"meta":{"$ref":"#/components/schemas/media_metadata"},"modified":{"$ref":"#/components/schemas/modified-5P46cImn"},"playback":{"$ref":"#/components/schemas/playback"},"preview":{"$ref":"#/components/schemas/preview"},"readyToStream":{"$ref":"#/components/schemas/readyToStream"},"requireSignedURLs":{"$ref":"#/components/schemas/requireSignedURLs-9DKWYMwu"},"size":{"$ref":"#/components/schemas/size"},"status":{"$ref":"#/components/schemas/media_status"},"thumbnail":{"$ref":"#/components/schemas/thumbnail_url-GZVIYimZ"},"thumbnailTimestampPct":{"$ref":"#/components/schemas/thumbnailTimestampPct"},"uid":{"$ref":"#/components/schemas/identifier-XSj9HnWY"},"uploadExpiry":{"$ref":"#/components/schemas/oneTimeUploadExpiry"},"uploaded":{"$ref":"#/components/schemas/uploaded-3C8O7sGT"},"watermark":{"$ref":"#/components/schemas/watermarks"}},"type":"object"},"virtual-network":{"properties":{"comment":{"$ref":"#/components/schemas/schemas-comment"},"created_at":{"description":"Timestamp of when the virtual network was created."},"deleted_at":{"description":"Timestamp of when the virtual network was deleted. If `null`, the virtual network has not been deleted."},"id":{"$ref":"#/components/schemas/vnet_id"},"is_default_network":{"$ref":"#/components/schemas/is_default_network"},"name":{"$ref":"#/components/schemas/vnet_name"}},"required":["id","name","is_default_network","comment","created_at"],"type":"object"},"virtual_network_id":{"description":"The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account.","example":"a5624d4e-044a-4ff0-b3e1-e2465353d4b4","type":"string"},"vnc_props":{"allOf":[{"$ref":"#/components/schemas/self_hosted_props-pFu7lQyL"},{"properties":{"type":{"description":"The application type.","example":"vnc","type":"string"}}}]},"vnet_id":{"description":"UUID of the virtual network.","example":"f70ff985-a4ef-4643-bbbc-4a0ed4fc8415","maxLength":36,"readOnly":true,"type":"string"},"vnet_name":{"description":"A user-friendly name for the virtual network.","example":"us-east-1-vpc","type":"string"},"vnet_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/virtual-network"},"type":"array"}},"type":"object"}]},"vnet_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}},"type":"object"}]},"waf":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["waf"],"example":"waf"},"value":{"$ref":"#/components/schemas/waf_value"}}}],"description":"The WAF examines HTTP requests to your website. It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will 'challenge' the web visitor with a page that asks them to submit a CAPTCHA successfully to continue their action. If the challenge is failed, the action will be stopped. What this means is that Cloudflare's WAF will block any traffic identified as illegitimate before it reaches your origin web server. (https://support.cloudflare.com/hc/en-us/articles/200172016).","title":"Web Application Firewall"},"waf_action":{"description":"The WAF rule action to apply.","enum":["challenge","block","simulate","disable","default"]},"waf_rewrite_action":{"description":"The WAF rule action to apply.","enum":["challenge","block","simulate","disable","default"]},"waf_value":{"default":"off","description":"Value of the zone setting.","enum":["on","off"],"type":"string"},"wait_time":{"default":1,"description":"Set the time (in seconds) to wait for a response to a probe.","maximum":5,"minimum":1,"type":"integer"},"waiting_room_id":{"example":"699d98642c564d2e855e9661899b7252"},"waiting_room_id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/waiting_room_id"}},"type":"object"}}}]},"waitingroom":{"properties":{"cookie_attributes":{"$ref":"#/components/schemas/cookie_attributes"},"created_on":{"$ref":"#/components/schemas/timestamp"},"custom_page_html":{"$ref":"#/components/schemas/custom_page_html"},"default_template_language":{"$ref":"#/components/schemas/default_template_language"},"description":{"$ref":"#/components/schemas/description-DIf6mz41"},"disable_session_renewal":{"$ref":"#/components/schemas/disable_session_renewal"},"host":{"$ref":"#/components/schemas/host"},"id":{"$ref":"#/components/schemas/waiting_room_id"},"json_response_enabled":{"$ref":"#/components/schemas/json_response_enabled"},"modified_on":{"$ref":"#/components/schemas/timestamp"},"name":{"$ref":"#/components/schemas/name-jYNmruXY"},"new_users_per_minute":{"$ref":"#/components/schemas/new_users_per_minute"},"next_event_prequeue_start_time":{"$ref":"#/components/schemas/next_event_prequeue_start_time"},"next_event_start_time":{"$ref":"#/components/schemas/next_event_start_time"},"path":{"$ref":"#/components/schemas/path"},"queue_all":{"$ref":"#/components/schemas/queue_all"},"queueing_method":{"$ref":"#/components/schemas/queueing_method"},"session_duration":{"$ref":"#/components/schemas/session_duration"},"suspended":{"$ref":"#/components/schemas/suspended-qdpN2ZN2"},"total_active_users":{"$ref":"#/components/schemas/total_active_users"}},"type":"object"},"warp_props":{"allOf":[{"$ref":"#/components/schemas/feature_app_props-g2VC0WUC"},{"properties":{"domain":{"example":"authdomain.cloudflareaccess.com/warp","readOnly":true},"name":{"default":"Warp Login App","example":"Warp Login App","readOnly":true},"type":{"description":"The application type.","example":"warp","type":"string"}}}]},"wasm_module_binding":{"properties":{"name":{"$ref":"#/components/schemas/binding_name"},"type":{"description":"The class of resource that the binding provides.","enum":["wasm_module"],"example":"wasm_module","type":"string"}},"required":["name","type"],"type":"object"},"watermarkAtUpload":{"properties":{"uid":{"description":"The unique identifier for the watermark profile.","example":"ea95132c15732412d22c1476fa83f27a","maxLength":32,"type":"string"}},"type":"object"},"watermark_at_upload":{"properties":{"uid":{"description":"The unique identifier for the watermark profile.","example":"ea95132c15732412d22c1476fa83f27a","maxLength":32,"type":"string"}},"type":"object"},"watermark_basic_upload":{"properties":{"file":{"description":"The image file to upload.","example":"@/Users/rchen/Downloads/watermark.png","type":"string"},"name":{"$ref":"#/components/schemas/name-0M1mwjDs"},"opacity":{"$ref":"#/components/schemas/opacity"},"padding":{"$ref":"#/components/schemas/padding"},"position":{"$ref":"#/components/schemas/position"},"scale":{"$ref":"#/components/schemas/scale"}},"required":["file"],"type":"object"},"watermark_created":{"description":"The date and a time a watermark profile was created.","example":"2014-01-02T02:20:00Z","format":"date-time","readOnly":true,"type":"string"},"watermark_identifier":{"description":"The unique identifier for a watermark profile.","example":"ea95132c15732412d22c1476fa83f27a","maxLength":32,"readOnly":true,"type":"string"},"watermark_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/watermarks"},"type":"array"}}}]},"watermark_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"watermark_size":{"description":"The size of the image in bytes.","example":29472,"readOnly":true,"type":"number"},"watermarks":{"properties":{"created":{"$ref":"#/components/schemas/watermark_created"},"downloadedFrom":{"$ref":"#/components/schemas/downloadedFrom"},"height":{"$ref":"#/components/schemas/height-YS9whiRo"},"name":{"$ref":"#/components/schemas/name-0M1mwjDs"},"opacity":{"$ref":"#/components/schemas/opacity"},"padding":{"$ref":"#/components/schemas/padding"},"position":{"$ref":"#/components/schemas/position"},"scale":{"$ref":"#/components/schemas/scale"},"size":{"$ref":"#/components/schemas/watermark_size"},"uid":{"$ref":"#/components/schemas/watermark_identifier"},"width":{"$ref":"#/components/schemas/width-bMHL5ne3"}},"type":"object"},"web3-hostname":{"properties":{"created_on":{"$ref":"#/components/schemas/timestamp"},"description":{"$ref":"#/components/schemas/web3-hostname_components-schemas-description"},"dnslink":{"$ref":"#/components/schemas/dnslink"},"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"modified_on":{"$ref":"#/components/schemas/timestamp"},"name":{"$ref":"#/components/schemas/web3-hostname_components-schemas-name"},"status":{"$ref":"#/components/schemas/web3-hostname_components-schemas-status"},"target":{"$ref":"#/components/schemas/schemas-target"}},"type":"object"},"web3-hostname_components-schemas-description":{"description":"An optional description of the hostname.","example":"This is my IPFS gateway.","maxLength":500,"type":"string"},"web3-hostname_components-schemas-name":{"description":"The hostname that will point to the target gateway via CNAME.","example":"gateway.example.com","maxLength":255,"readOnly":true,"type":"string"},"web3-hostname_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/web3-hostname"}}}]},"web3-hostname_components-schemas-status":{"description":"Status of the hostname's activation.","enum":["active","pending","deleting","error"],"example":"active","readOnly":true,"type":"string"},"webhook_request":{"properties":{"notificationUrl":{"$ref":"#/components/schemas/notificationUrl"}},"required":["notificationUrl"]},"webhook_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"webhooks":{"properties":{"created_at":{"$ref":"#/components/schemas/webhooks_components-schemas-created_at"},"id":{"$ref":"#/components/schemas/uuid-s0SXln0q"},"last_failure":{"$ref":"#/components/schemas/last_failure"},"last_success":{"$ref":"#/components/schemas/last_success"},"name":{"$ref":"#/components/schemas/webhooks_components-schemas-name"},"secret":{"$ref":"#/components/schemas/secret-QjCIBSp3"},"type":{"$ref":"#/components/schemas/webhooks_components-schemas-type"},"url":{"$ref":"#/components/schemas/webhooks_components-schemas-url"}},"type":"object"},"webhooks_components-schemas-created_at":{"description":"Timestamp of when the webhook destination was created.","example":"2020-10-26T18:25:04.532316Z","format":"date-time","readOnly":true,"type":"string"},"webhooks_components-schemas-id_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/uuid-s0SXln0q"}},"type":"object"}}}]},"webhooks_components-schemas-name":{"description":"The name of the webhook destination. This will be included in the request body when you receive a webhook notification.","example":"Slack Webhook","type":"string"},"webhooks_components-schemas-response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/webhooks"},"type":"array"}}}]},"webhooks_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/webhooks"}}}]},"webhooks_components-schemas-type":{"description":"Type of webhook endpoint.","enum":["slack","generic","gchat"],"example":"slack","type":"string"},"webhooks_components-schemas-url":{"description":"The POST endpoint to call when dispatching a notification.","example":"https://hooks.slack.com/services/Ds3fdBFbV/456464Gdd","type":"string"},"webp":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["webp"],"example":"webp"},"value":{"$ref":"#/components/schemas/webp_value"}}}],"description":"When the client requesting the image supports the WebP image codec, and WebP offers a performance advantage over the original image format, Cloudflare will serve a WebP version of the original image.","title":"Polish WebP Conversion"},"webp_value":{"default":"off","description":"Value of the zone setting.","enum":["off","on"],"type":"string"},"websockets":{"allOf":[{"$ref":"#/components/schemas/base-ozkeixvx"},{"properties":{"id":{"description":"ID of the zone setting.","enum":["websockets"],"example":"websockets"},"value":{"$ref":"#/components/schemas/websockets_value"}}}],"description":"WebSockets are open connections sustained between the client and the origin server. Inside a WebSockets connection, the client and the origin can pass data back and forth without having to reestablish sessions. This makes exchanging data within a WebSockets connection fast. WebSockets are often used for real-time applications such as live chat and gaming. For more information refer to [Can I use Cloudflare with Websockets](https://support.cloudflare.com/hc/en-us/articles/200169466-Can-I-use-Cloudflare-with-WebSockets-).","title":"WebSockets"},"websockets_value":{"default":"off","description":"Value of the zone setting.","enum":["off","on"],"type":"string"},"weight":{"description":"Optional weight of the ECMP scope - if provided.","type":"integer"},"weight-6YtMahm8":{"default":1,"description":"The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool.","example":0.6,"maximum":1,"minimum":0,"multipleOf":0.01,"type":"number"},"weight-9aFRWjMy":{"default":1,"description":"The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool.","example":0.6,"maximum":1,"minimum":0,"multipleOf":0.01,"type":"number"},"whois":{"properties":{"created_date":{"example":"2009-02-17","format":"date","type":"string"},"domain":{"$ref":"#/components/schemas/schemas-domain_name"},"nameservers":{"example":["ns3.cloudflare.com","ns4.cloudflare.com","ns5.cloudflare.com","ns6.cloudflare.com","ns7.cloudflare.com"],"items":{"type":"string"},"type":"array"},"registrant":{"example":"DATA REDACTED","type":"string"},"registrant_country":{"example":"United States","type":"string"},"registrant_email":{"example":"https://domaincontact.cloudflareregistrar.com/cloudflare.com","type":"string"},"registrant_org":{"example":"DATA REDACTED","type":"string"},"registrar":{"example":"Cloudflare, Inc.","type":"string"},"updated_date":{"example":"2017-05-24","format":"date","type":"string"}}},"whois_components-schemas-single_response":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/whois"}}}]},"width":{"description":"Maximum width in image pixels.","example":1366,"minimum":1,"type":"number"},"width-bMHL5ne3":{"description":"The width of the image in pixels.","readOnly":true,"type":"integer"},"workspace_one_config_request":{"properties":{"api_url":{"description":"The Workspace One API URL provided in the Workspace One Admin Dashboard.","example":"https://as123.awmdm.com/API","type":"string"},"auth_url":{"description":"The Workspace One Authorization URL depending on your region.","example":"https://na.uemauth.vmwservices.com/connect/token","type":"string"},"client_id":{"description":"The Workspace One client ID provided in the Workspace One Admin Dashboard.","example":"example client id","type":"string"},"client_secret":{"description":"The Workspace One client secret provided in the Workspace One Admin Dashboard.","example":"example client secret","type":"string"}},"required":["api_url","auth_url","client_id","client_secret"],"type":"object"},"workspace_one_config_response":{"description":"The Workspace One Config Response.","properties":{"api_url":{"description":"The Workspace One API URL provided in the Workspace One Admin Dashboard.","example":"https://as123.awmdm.com/API","type":"string"},"auth_url":{"description":"The Workspace One Authorization URL depending on your region.","example":"https://na.uemauth.vmwservices.com/connect/token","type":"string"},"client_id":{"description":"The Workspace One client ID provided in the Workspace One Admin Dashboard.","example":"example client id","type":"string"}},"required":["api_url","auth_url","client_id"],"type":"object"},"yandex":{"allOf":[{"$ref":"#/components/schemas/identity-provider"},{"properties":{"config":{"$ref":"#/components/schemas/generic-oauth-config"}},"type":"object"}],"title":"Yandex","type":"object"},"zipcode":{"description":"The zipcode or postal code where the user lives.","example":"12345","maxLength":20,"nullable":true,"type":"string"},"zone":{"properties":{"activated_on":{"description":"The last time proof of ownership was detected and the zone was made\nactive","example":"2014-01-02T00:01:00.12345Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"created_on":{"description":"When the zone was created","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string"},"development_mode":{"description":"The interval (in seconds) from when development mode expires\n(positive integer) or last expired (negative integer) for the\ndomain. If development mode has never been enabled, this value is 0.","example":7200,"readOnly":true,"type":"number"},"id":{"$ref":"#/components/schemas/identifier-MZFDye9j"},"modified_on":{"description":"When the zone was last modified","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string"},"name":{"description":"The domain name","example":"example.com","maxLength":253,"pattern":"^([a-zA-Z0-9][\\-a-zA-Z0-9]*\\.)+[\\-a-zA-Z0-9]{2,20}$","type":"string"},"original_dnshost":{"description":"DNS host at the time of switching to Cloudflare","example":"NameCheap","maxLength":50,"nullable":true,"readOnly":true,"type":"string"},"original_name_servers":{"description":"Original name servers before moving to Cloudflare\nNotes: Is this only available for full zones?","example":["ns1.originaldnshost.com","ns2.originaldnshost.com"],"items":{"format":"hostname","type":"string"},"nullable":true,"readOnly":true,"type":"array"},"original_registrar":{"description":"Registrar for the domain at the time of switching to Cloudflare","example":"GoDaddy","nullable":true,"readOnly":true,"type":"string"}},"required":["id","name","development_mode","owner","account","meta","original_name_servers","original_registrar","original_dnshost","created_on","modified_on","activated_on"],"type":"object"},"zone-NCQbmiTF":{"description":"A simple zone object. May have null properties if not a zone subscription.","properties":{"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"},"name":{"$ref":"#/components/schemas/zone-properties-name"}},"type":"object"},"zone-authenticated-origin-pull":{"allOf":[{"$ref":"#/components/schemas/certificateObject"}],"properties":{"certificate":{"$ref":"#/components/schemas/zone-authenticated-origin-pull_components-schemas-certificate"},"enabled":{"$ref":"#/components/schemas/zone-authenticated-origin-pull_components-schemas-enabled"},"id":{"$ref":"#/components/schemas/identifier-tZwYoMuc"},"private_key":{"$ref":"#/components/schemas/private_key"}},"type":"object"},"zone-authenticated-origin-pull-aLOWlDXy":{"allOf":[{"$ref":"#/components/schemas/certificateObject-ymFm5Oiv"}],"properties":{"certificate":{"$ref":"#/components/schemas/zone-authenticated-origin-pull_components-schemas-certificate"},"enabled":{"$ref":"#/components/schemas/zone-authenticated-origin-pull_components-schemas-enabled"},"id":{"$ref":"#/components/schemas/zone-authenticated-origin-pull_components-schemas-identifier"},"private_key":{"$ref":"#/components/schemas/private_key"}},"type":"object"},"zone-authenticated-origin-pull_components-schemas-certificate":{"description":"The zone's leaf certificate.","example":"-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n","type":"string"},"zone-authenticated-origin-pull_components-schemas-enabled":{"description":"Indicates whether zone-level authenticated origin pulls is enabled.","example":true,"type":"boolean"},"zone-authenticated-origin-pull_components-schemas-expires_on":{"description":"When the certificate from the authority expires.","example":"2100-01-01T05:20:00Z","format":"date-time","readOnly":true,"type":"string"},"zone-authenticated-origin-pull_components-schemas-identifier":{"description":"Certificate identifier tag.","example":"2458ce5a-0c35-4c7f-82c7-8e9487d3ff60","maxLength":36,"readOnly":true,"type":"string"},"zone-authenticated-origin-pull_components-schemas-status":{"description":"Status of the certificate activation.","enum":["initializing","pending_deployment","pending_deletion","active","deleted","deployment_timed_out","deletion_timed_out"],"example":"active"},"zone-properties-name":{"description":"The domain name","example":"example.com","maxLength":253,"pattern":"^([a-zA-Z0-9][\\-a-zA-Z0-9]*\\.)+[\\-a-zA-Z0-9]{2,20}$","readOnly":true,"type":"string"},"zone_cache_settings_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"zone_identifier":{"description":"Identifier of the zone.","example":"593c9c94de529bbbfaac7c53ced0447d"},"zone_identifier-jLr6NCq8":{"$ref":"#/components/schemas/identifier-YhmC5GTP"},"zone_metadata":{"properties":{"enabled":{"description":"Whether zone uses account-level custom nameservers.","example":true,"type":"boolean"}},"type":"object"},"zone_name":{"description":"Name of the zone.","example":"example.com","type":"string"},"zone_settings_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-common-jkxlh21Y"},{"properties":{"result":{"items":{"anyOf":[{"$ref":"#/components/schemas/0rtt"},{"$ref":"#/components/schemas/advanced_ddos"},{"$ref":"#/components/schemas/always_online"},{"$ref":"#/components/schemas/always_use_https"},{"$ref":"#/components/schemas/automatic_https_rewrites"},{"$ref":"#/components/schemas/brotli"},{"$ref":"#/components/schemas/browser_cache_ttl"},{"$ref":"#/components/schemas/browser_check"},{"$ref":"#/components/schemas/cache_level"},{"$ref":"#/components/schemas/challenge_ttl"},{"$ref":"#/components/schemas/ciphers"},{"$ref":"#/components/schemas/cname_flattening"},{"$ref":"#/components/schemas/development_mode"},{"$ref":"#/components/schemas/early_hints"},{"$ref":"#/components/schemas/edge_cache_ttl"},{"$ref":"#/components/schemas/email_obfuscation"},{"$ref":"#/components/schemas/h2_prioritization"},{"$ref":"#/components/schemas/hotlink_protection"},{"$ref":"#/components/schemas/http2"},{"$ref":"#/components/schemas/http3"},{"$ref":"#/components/schemas/image_resizing"},{"$ref":"#/components/schemas/ip_geolocation"},{"$ref":"#/components/schemas/ipv6"},{"$ref":"#/components/schemas/max_upload"},{"$ref":"#/components/schemas/min_tls_version"},{"$ref":"#/components/schemas/minify"},{"$ref":"#/components/schemas/mirage"},{"$ref":"#/components/schemas/mobile_redirect"},{"$ref":"#/components/schemas/nel"},{"$ref":"#/components/schemas/opportunistic_encryption"},{"$ref":"#/components/schemas/opportunistic_onion"},{"$ref":"#/components/schemas/orange_to_orange"},{"$ref":"#/components/schemas/origin_error_page_pass_thru"},{"$ref":"#/components/schemas/origin_max_http_version"},{"$ref":"#/components/schemas/polish"},{"$ref":"#/components/schemas/prefetch_preload"},{"$ref":"#/components/schemas/privacy_pass"},{"$ref":"#/components/schemas/proxy_read_timeout"},{"$ref":"#/components/schemas/pseudo_ipv4"},{"$ref":"#/components/schemas/response_buffering"},{"$ref":"#/components/schemas/rocket_loader"},{"$ref":"#/components/schemas/schemas-automatic_platform_optimization"},{"$ref":"#/components/schemas/security_header"},{"$ref":"#/components/schemas/security_level"},{"$ref":"#/components/schemas/server_side_exclude"},{"$ref":"#/components/schemas/sha1_support"},{"$ref":"#/components/schemas/sort_query_string_for_cache"},{"$ref":"#/components/schemas/ssl"},{"$ref":"#/components/schemas/ssl_recommender"},{"$ref":"#/components/schemas/tls_1_2_only"},{"$ref":"#/components/schemas/tls_1_3"},{"$ref":"#/components/schemas/tls_client_auth"},{"$ref":"#/components/schemas/true_client_ip_header"},{"$ref":"#/components/schemas/waf"},{"$ref":"#/components/schemas/webp"},{"$ref":"#/components/schemas/websockets"}]},"type":"array"}}}]},"zone_settings_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}}}]},"zone_settings_response_single-WcbmxR67":{"allOf":[{"$ref":"#/components/schemas/api-response-common-jkxlh21Y"},{"properties":{"result":{"type":"object"}}}]},"zone_subscription_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"type":"object"}},"type":"object"}]},"zonelockdown":{"additionalProperties":false,"properties":{"configurations":{"$ref":"#/components/schemas/configurations"},"created_on":{"$ref":"#/components/schemas/created_on-k2n1y7eG"},"description":{"$ref":"#/components/schemas/lockdowns_components-schemas-description"},"id":{"$ref":"#/components/schemas/lockdowns_components-schemas-id"},"modified_on":{"$ref":"#/components/schemas/components-schemas-modified_on"},"paused":{"$ref":"#/components/schemas/schemas-paused"},"urls":{"$ref":"#/components/schemas/schemas-urls"}},"required":["id","created_on","modified_on","paused","description","urls","configurations"]},"zonelockdown_response_collection":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/zonelockdown"},"type":"array"}},"required":["result"],"type":"object"}]},"zonelockdown_response_single":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/zonelockdown"}},"required":["result"],"type":"object"}]},"zones_connected":{"description":"The number of zones using this Railgun.","example":2,"readOnly":true,"type":"number"}},"securitySchemes":{"api_email":{"in":"header","name":"X-Auth-Email","type":"apiKey"},"api_key":{"in":"header","name":"X-Auth-Key","type":"apiKey"},"api_token":{"scheme":"bearer","type":"http"},"user_service_key":{"in":"header","name":"X-Auth-User-Service-Key","type":"apiKey"}}},"info":{"description":"Interact with Cloudflare's products and services via the Cloudflare API.\nFor more information on how to create and troubleshoot API tokens, refer to\nour [API fundamentals](https://developers.cloudflare.com/fundamentals/api/).\n\nTotally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/).","license":{"name":"BSD-3-Clause","url":"https://opensource.org/licenses/BSD-3-Clause"},"title":"Cloudflare API","version":"4.0.0"},"openapi":"3.0.3","paths":{"/accounts":{"get":{"description":"List all accounts you have ownership or verified access to.","operationId":"accounts-list-accounts","parameters":[{"in":"query","name":"name","schema":{"description":"Name of the account.","example":"example.com","readOnly":true,"type":"string"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Maximum number of results per page.","maximum":50,"minimum":5,"type":"number"}},{"in":"query","name":"direction","schema":{"description":"Direction to order results.","enum":["asc","desc"],"example":"desc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_collection-NcnbjEgN"}}},"description":"List Accounts response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_collection-NcnbjEgN"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Accounts response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Accounts","tags":["Accounts"],"x-cfPermissionsRequired":{"enum":["#organization:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_identifier1}/addressing/address_maps/{address_map_identifier}/accounts/{account_identifier}":{"delete":{"description":"Remove an account as a member of a particular address map.","operationId":"ip-address-management-address-maps-remove-an-account-membership-from-an-address-map","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}},{"in":"path","name":"address_map_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}},{"in":"path","name":"account_identifier1","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-collection"}}},"description":"Remove an account membership from an Address Map response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Remove an account membership from an Address Map response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Remove an account membership from an Address Map","tags":["IP Address Management Address Maps"]},"put":{"description":"Add an account as a member of a particular address map.","operationId":"ip-address-management-address-maps-add-an-account-membership-to-an-address-map","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}},{"in":"path","name":"address_map_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}},{"in":"path","name":"account_identifier1","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-collection"}}},"description":"Add an account membership to an Address Map response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Add an account membership to an Address Map response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Add an account membership to an Address Map","tags":["IP Address Management Address Maps"]}},"/accounts/{account_identifier}/addressing/address_maps":{"get":{"description":"List all address maps owned by the account.","operationId":"ip-address-management-address-maps-list-address-maps","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-response_collection-R3Nbn4ml"}}},"description":"List Address Maps response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-response_collection-R3Nbn4ml"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Address Maps response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Address Maps","tags":["IP Address Management Address Maps"]},"post":{"description":"Create a new address map under the account.","operationId":"ip-address-management-address-maps-create-address-map","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"description":{"$ref":"#/components/schemas/schemas-description-Fsn87iOz"},"enabled":{"$ref":"#/components/schemas/enabled-i0fFiRwL"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/full_response"}}},"description":"Create Address Map response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/full_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Address Map response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Address Map","tags":["IP Address Management Address Maps"]}},"/accounts/{account_identifier}/addressing/address_maps/{address_map_identifier}":{"delete":{"description":"Delete a particular address map owned by the account. An Address Map must be disabled before it can be deleted.","operationId":"ip-address-management-address-maps-delete-address-map","parameters":[{"in":"path","name":"address_map_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-collection"}}},"description":"Delete Address Map response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Address Map response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Address Map","tags":["IP Address Management Address Maps"]},"get":{"description":"Show a particular address map owned by the account.","operationId":"ip-address-management-address-maps-address-map-details","parameters":[{"in":"path","name":"address_map_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/full_response"}}},"description":"Address Map Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/full_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Address Map Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Address Map Details","tags":["IP Address Management Address Maps"]},"patch":{"description":"Modify properties of an address map owned by the account.","operationId":"ip-address-management-address-maps-update-address-map","parameters":[{"in":"path","name":"address_map_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"default_sni":{"$ref":"#/components/schemas/default_sni"},"description":{"$ref":"#/components/schemas/schemas-description-Fsn87iOz"},"enabled":{"$ref":"#/components/schemas/enabled-i0fFiRwL"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-single_response-plUIZwft"}}},"description":"Update Address Map response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-single_response-plUIZwft"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Address Map response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Address Map","tags":["IP Address Management Address Maps"]}},"/accounts/{account_identifier}/addressing/address_maps/{address_map_identifier}/ips/{ip_address}":{"delete":{"description":"Remove an IP from a particular address map.","operationId":"ip-address-management-address-maps-remove-an-ip-from-an-address-map","parameters":[{"in":"path","name":"ip_address","required":true,"schema":{"$ref":"#/components/schemas/ip_address"}},{"in":"path","name":"address_map_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-collection"}}},"description":"Remove an IP from an Address Map response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Remove an IP from an Address Map response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Remove an IP from an Address Map","tags":["IP Address Management Address Maps"]},"put":{"description":"Add an IP from a prefix owned by the account to a particular address map.","operationId":"ip-address-management-address-maps-add-an-ip-to-an-address-map","parameters":[{"in":"path","name":"ip_address","required":true,"schema":{"$ref":"#/components/schemas/ip_address"}},{"in":"path","name":"address_map_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-collection"}}},"description":"Add an IP to an Address Map response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Add an IP to an Address Map response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Add an IP to an Address Map","tags":["IP Address Management Address Maps"]}},"/accounts/{account_identifier}/addressing/address_maps/{address_map_identifier}/zones/{zone_identifier}":{"delete":{"description":"Remove a zone as a member of a particular address map.","operationId":"ip-address-management-address-maps-remove-a-zone-membership-from-an-address-map","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}},{"in":"path","name":"address_map_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-collection"}}},"description":"Remove a zone membership from an Address Map response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Remove a zone membership from an Address Map response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Remove a zone membership from an Address Map","tags":["IP Address Management Address Maps"]},"put":{"description":"Add a zone as a member of a particular address map.","operationId":"ip-address-management-address-maps-add-a-zone-membership-to-an-address-map","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}},{"in":"path","name":"address_map_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-collection"}}},"description":"Add a zone membership to an Address Map response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Add a zone membership to an Address Map response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Add a zone membership to an Address Map","tags":["IP Address Management Address Maps"]}},"/accounts/{account_identifier}/addressing/loa_documents":{"post":{"description":"Submit LOA document (pdf format) under the account.","operationId":"ip-address-management-prefixes-upload-loa-document","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"loa_document":{"description":"LOA document to upload.","example":"@document.pdf","type":"string"}},"required":["loa_document"],"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/loa_upload_response"}}},"description":"Upload LOA Document response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/loa_upload_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Upload LOA Document response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Upload LOA Document","tags":["IP Address Management Prefixes"]}},"/accounts/{account_identifier}/addressing/loa_documents/{loa_document_identifier}/download":{"get":{"description":"Download specified LOA document under the account.","operationId":"ip-address-management-prefixes-download-loa-document","parameters":[{"in":"path","name":"loa_document_identifier","required":true,"schema":{"$ref":"#/components/schemas/loa_document_identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}}],"responses":{"200":{"content":{"application/json":{"schema":{}}},"description":"Download LOA Document response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Download LOA Document response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Download LOA Document","tags":["IP Address Management Prefixes"]}},"/accounts/{account_identifier}/addressing/prefixes":{"get":{"description":"List all prefixes owned by the account.","operationId":"ip-address-management-prefixes-list-prefixes","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_collection-wEgS8Oby"}}},"description":"List Prefixes response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_collection-wEgS8Oby"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Prefixes response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Prefixes","tags":["IP Address Management Prefixes"]},"post":{"description":"Add a new prefix under the account.","operationId":"ip-address-management-prefixes-add-prefix","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"asn":{"$ref":"#/components/schemas/asn"},"cidr":{"$ref":"#/components/schemas/cidr"},"loa_document_id":{"$ref":"#/components/schemas/loa_document_identifier"}},"required":["cidr","loa_document_id","asn"]}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response-tparoDL5"}}},"description":"Add Prefix response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response-tparoDL5"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Add Prefix response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Add Prefix","tags":["IP Address Management Prefixes"]}},"/accounts/{account_identifier}/addressing/prefixes/{prefix_identifier}":{"delete":{"description":"Delete an unapproved prefix owned by the account.","operationId":"ip-address-management-prefixes-delete-prefix","parameters":[{"in":"path","name":"prefix_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-collection"}}},"description":"Delete Prefix response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Prefix response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Prefix","tags":["IP Address Management Prefixes"]},"get":{"description":"List a particular prefix owned by the account.","operationId":"ip-address-management-prefixes-prefix-details","parameters":[{"in":"path","name":"prefix_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response-tparoDL5"}}},"description":"Prefix Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response-tparoDL5"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Prefix Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Prefix Details","tags":["IP Address Management Prefixes"]},"patch":{"description":"Modify the description for a prefix owned by the account.","operationId":"ip-address-management-prefixes-update-prefix-description","parameters":[{"in":"path","name":"prefix_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"description":{"$ref":"#/components/schemas/description-AqNwNwjr"}},"required":["description"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response-tparoDL5"}}},"description":"Update Prefix Description response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response-tparoDL5"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Prefix Description response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Prefix Description","tags":["IP Address Management Prefixes"]}},"/accounts/{account_identifier}/addressing/prefixes/{prefix_identifier}/bgp/status":{"get":{"description":"List the current advertisement state for a prefix.","operationId":"ip-address-management-dynamic-advertisement-get-advertisement-status","parameters":[{"in":"path","name":"prefix_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/advertised_response"}}},"description":"Get Advertisement Status response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/advertised_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Advertisement Status response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Advertisement Status","tags":["IP Address Management Dynamic Advertisement"]},"patch":{"description":"Advertise or withdraw BGP route for a prefix.","operationId":"ip-address-management-dynamic-advertisement-update-prefix-dynamic-advertisement-status","parameters":[{"in":"path","name":"prefix_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"advertised":{"$ref":"#/components/schemas/schemas-advertised"}},"required":["advertised"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/advertised_response"}}},"description":"Update Prefix Dynamic Advertisement Status response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/advertised_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Prefix Dynamic Advertisement Status response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Prefix Dynamic Advertisement Status","tags":["IP Address Management Dynamic Advertisement"]}},"/accounts/{account_identifier}/addressing/prefixes/{prefix_identifier}/delegations":{"get":{"description":"List all delegations for a given account IP prefix.","operationId":"ip-address-management-prefix-delegation-list-prefix-delegations","parameters":[{"in":"path","name":"prefix_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-response_collection-NmAY72Ue"}}},"description":"List Prefix Delegations response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-response_collection-NmAY72Ue"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Prefix Delegations response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Prefix Delegations","tags":["IP Address Management Prefix Delegation"]},"post":{"description":"Create a new account delegation for a given IP prefix.","operationId":"ip-address-management-prefix-delegation-create-prefix-delegation","parameters":[{"in":"path","name":"prefix_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"cidr":{"$ref":"#/components/schemas/cidr"},"delegated_account_id":{"$ref":"#/components/schemas/delegated_account_identifier"}},"required":["cidr","delegated_account_id"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-single_response-xdmRbZer"}}},"description":"Create Prefix Delegation response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-single_response-xdmRbZer"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Prefix Delegation response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Prefix Delegation","tags":["IP Address Management Prefix Delegation"]}},"/accounts/{account_identifier}/addressing/prefixes/{prefix_identifier}/delegations/{delegation_identifier}":{"delete":{"description":"Delete an account delegation for a given IP prefix.","operationId":"ip-address-management-prefix-delegation-delete-prefix-delegation","parameters":[{"in":"path","name":"delegation_identifier","required":true,"schema":{"$ref":"#/components/schemas/delegation_identifier"}},{"in":"path","name":"prefix_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-v0xEcFCj"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/id_response-I5lr4Hc3"}}},"description":"Delete Prefix Delegation response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/id_response-I5lr4Hc3"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Prefix Delegation response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Prefix Delegation","tags":["IP Address Management Prefix Delegation"]}},"/accounts/{account_identifier}/audit_logs":{"get":{"description":"Gets a list of audit logs for an account. The list can be filtered by who made the change, which zone was the change made on, and the timeframe of the change.","operationId":"audit-logs-get-account-audit-logs","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"id","schema":{"description":"Finds a specific log by its ID.","example":"f174be97-19b1-40d6-954d-70cd5fbd52db","type":"string"}},{"in":"query","name":"export","schema":{"description":"Indicates that this request is an export of logs in CSV format.","example":true,"type":"boolean"}},{"in":"query","name":"action.type","schema":{"description":"Filters by the action type.","example":"add","type":"string"}},{"in":"query","name":"actor.ip","schema":{"description":"Filters by the IP address of the request that made the change by specific IP address or valid CIDR Range.","example":"17.168.228.63","type":"string"}},{"in":"query","name":"actor.email","schema":{"description":"Filters by the email address of the actor that made the change.","example":"alice@example.com","format":"email","type":"string"}},{"in":"query","name":"since","schema":{"description":"Limits the returned results to logs newer than the specified date. This can be a date string `2019-04-30` or an absolute timestamp that conforms to RFC3339.","example":"2019-04-30T01:12:20Z","format":"date-time","type":"string"}},{"in":"query","name":"before","schema":{"description":"Limits the returned results to logs older than the specified date. This can be a date string `2019-04-30` or an absolute timestamp that conforms to RFC3339.","example":"2019-04-30T01:12:20Z","format":"date-time","type":"string"}},{"in":"query","name":"zone.name","schema":{"description":"Filters by the name of the zone associated to the change.","example":"example.com","type":"string"}},{"in":"query","name":"direction","schema":{"default":"desc","description":"Changes the direction of the chronological sorting.","enum":["desc","asc"],"example":"desc","type":"string"}},{"in":"query","name":"per_page","schema":{"default":100,"description":"Sets the number of results to return per page.","example":25,"maximum":1000,"minimum":1,"type":"number"}},{"in":"query","name":"page","schema":{"default":1,"description":"Defines which page of results to return.","example":50,"minimum":1,"type":"number"}},{"in":"query","name":"hide_user_logs","schema":{"default":false,"description":"Indicates whether or not to hide user level audit logs.","type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/audit_logs_response_collection"}}},"description":"Get account audit logs response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/audit_logs_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get account audit logs response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get account audit logs","tags":["Audit Logs"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_identifier}/billing/profile":{"get":{"description":"Gets the current billing profile for the account.","operationId":"account-billing-profile-billing-profile-details","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-D3Kod1Eh"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing_response_single"}}},"description":"Billing Profile Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/billing_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Billing Profile Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Billing Profile Details","tags":["Account Billing Profile"],"x-cfPermissionsRequired":{"enum":["#billing:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_identifier}/brand-protection/submit":{"post":{"operationId":"phishing-url-scanner-submit-suspicious-url-for-scanning","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/url_param"}],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/phishing-url-submit_components-schemas-single_response"}}},"description":"Submit suspicious URL for scanning response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/phishing-url-submit_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Submit suspicious URL for scanning response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Submit suspicious URL for scanning","tags":["Phishing URL Scanner"]}},"/accounts/{account_identifier}/brand-protection/url-info":{"get":{"operationId":"phishing-url-information-get-results-for-a-url-scan","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"url_id_param","schema":{"$ref":"#/components/schemas/url_id_param"}},{"in":"query","name":"url","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/phishing-url-info_components-schemas-single_response"}}},"description":"Get results for a URL scan response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/phishing-url-info_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get results for a URL scan response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get results for a URL scan","tags":["Phishing URL Information"]}},"/accounts/{account_identifier}/cfd_tunnel":{"get":{"description":"Lists and filters Cloudflare Tunnels in an account.","operationId":"cloudflare-tunnel-list-cloudflare-tunnels","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}},{"in":"query","name":"uuid","schema":{"$ref":"#/components/schemas/tunnel_id"}},{"in":"query","name":"existed_at","schema":{"$ref":"#/components/schemas/existed_at"}},{"in":"query","name":"per_page","schema":{"$ref":"#/components/schemas/schemas-per_page"}},{"in":"query","name":"tunnel_id","schema":{"$ref":"#/components/schemas/tunnel_id"}},{"in":"query","name":"is_deleted","schema":{"description":"If `true`, only include deleted tunnels. If `false`, exclude deleted tunnels. If empty, all tunnels will be included.","example":true,"type":"boolean"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"tunnel_name","schema":{"description":"A user-friendly name for the tunnel.","example":"blog","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-tunnel_response_collection"}}},"description":"List Cloudflare Tunnels response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-tunnel_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Cloudflare Tunnels response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Cloudflare Tunnels","tags":["Cloudflare Tunnel"]},"post":{"description":"Creates a new Cloudflare Tunnel in an account.","operationId":"cloudflare-tunnel-create-a-cloudflare-tunnel","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"config_src":{"$ref":"#/components/schemas/config_src"},"name":{"$ref":"#/components/schemas/tunnel_name"},"tunnel_secret":{"$ref":"#/components/schemas/tunnel_secret"}},"required":["name","tunnel_secret"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-tunnel_response_single"}}},"description":"Create a Cloudflare Tunnel response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-tunnel_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create a Cloudflare Tunnel response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create a Cloudflare Tunnel","tags":["Cloudflare Tunnel"]}},"/accounts/{account_identifier}/cfd_tunnel/{tunnel_id}":{"delete":{"description":"Deletes a Cloudflare Tunnel from an account.","operationId":"cloudflare-tunnel-delete-a-cloudflare-tunnel","parameters":[{"in":"path","name":"tunnel_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_id"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-tunnel_response_single"}}},"description":"Delete a Cloudflare Tunnel response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-tunnel_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete a Cloudflare Tunnel response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete a Cloudflare Tunnel","tags":["Cloudflare Tunnel"]},"get":{"description":"Fetches a single Cloudflare Tunnel.","operationId":"cloudflare-tunnel-get-a-cloudflare-tunnel","parameters":[{"in":"path","name":"tunnel_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_id"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-tunnel_response_single"}}},"description":"Get a Cloudflare Tunnel response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-tunnel_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get a Cloudflare Tunnel response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a Cloudflare Tunnel","tags":["Cloudflare Tunnel"]},"patch":{"description":"Updates an existing Cloudflare Tunnel.","operationId":"cloudflare-tunnel-update-a-cloudflare-tunnel","parameters":[{"in":"path","name":"tunnel_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_id"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"$ref":"#/components/schemas/tunnel_name"},"tunnel_secret":{"$ref":"#/components/schemas/tunnel_secret"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-tunnel_response_single"}}},"description":"Update a Cloudflare Tunnel response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-tunnel_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update a Cloudflare Tunnel response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update a Cloudflare Tunnel","tags":["Cloudflare Tunnel"]}},"/accounts/{account_identifier}/cfd_tunnel/{tunnel_id}/configurations":{"get":{"description":"Gets the configuration for a remotely-managed tunnel","operationId":"cloudflare-tunnel-configuration-get-configuration","parameters":[{"in":"path","name":"tunnel_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_id"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/config_response_single"}}},"description":"Get configuration response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/config_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get configuration response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get configuration","tags":["Cloudflare Tunnel configuration"]},"put":{"description":"Adds or updates the configuration for a remotely-managed tunnel.","operationId":"cloudflare-tunnel-configuration-put-configuration","parameters":[{"in":"path","name":"tunnel_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_id"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"config":{"$ref":"#/components/schemas/components-schemas-config"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/config_response_single"}}},"description":"Put configuration response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/config_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Put configuration response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Put configuration","tags":["Cloudflare Tunnel configuration"]}},"/accounts/{account_identifier}/cfd_tunnel/{tunnel_id}/connections":{"delete":{"description":"Removes connections that are in a disconnected or pending reconnect state. We recommend running this command after shutting down a tunnel.","operationId":"cloudflare-tunnel-clean-up-cloudflare-tunnel-connections","parameters":[{"in":"path","name":"tunnel_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_id"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-empty_response"}}},"description":"Clean up Cloudflare Tunnel connections response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-empty_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Clean up Cloudflare Tunnel connections response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Clean up Cloudflare Tunnel connections","tags":["Cloudflare Tunnel"]},"get":{"description":"Fetches connection details for a Cloudflare Tunnel.","operationId":"cloudflare-tunnel-list-cloudflare-tunnel-connections","parameters":[{"in":"path","name":"tunnel_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_id"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_connections_response"}}},"description":"List Cloudflare Tunnel connections response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_connections_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Cloudflare Tunnel connections response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Cloudflare Tunnel connections","tags":["Cloudflare Tunnel"]}},"/accounts/{account_identifier}/cfd_tunnel/{tunnel_id}/token":{"get":{"description":"Gets the token used to associate cloudflared with a specific tunnel.","operationId":"cloudflare-tunnel-get-a-cloudflare-tunnel-token","parameters":[{"in":"path","name":"tunnel_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_id"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_response_token"}}},"description":"Get a Cloudflare Tunnel token response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_response_token"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get a Cloudflare Tunnel token response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a Cloudflare Tunnel token","tags":["Cloudflare Tunnel"]}},"/accounts/{account_identifier}/custom_pages":{"get":{"description":"Fetches all the custom pages at the account level.","operationId":"custom-pages-for-an-account-list-custom-pages","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_pages_response_collection"}}},"description":"List custom pages response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom_pages_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List custom pages response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List custom pages","tags":["Custom pages for an account"],"x-cfPermissionsRequired":{"enum":["#organization:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/accounts/{account_identifier}/custom_pages/{identifier}":{"get":{"description":"Fetches the details of a custom page.","operationId":"custom-pages-for-an-account-get-a-custom-page","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/custom-pages_components-schemas-identifier-2"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_pages_response_single"}}},"description":"Get a custom page response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom_pages_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get a custom page response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a custom page","tags":["Custom pages for an account"],"x-cfPermissionsRequired":{"enum":["#organization:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"put":{"description":"Updates the configuration of an existing custom page.","operationId":"custom-pages-for-an-account-update-a-custom-page","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/custom-pages_components-schemas-identifier-2"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"state":{"$ref":"#/components/schemas/components-schemas-state"},"url":{"$ref":"#/components/schemas/url"}},"required":["url","state"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_pages_response_single"}}},"description":"Update a custom page response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom_pages_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update a custom page response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update a custom page","tags":["Custom pages for an account"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/accounts/{account_identifier}/diagnostics/traceroute":{"post":{"description":"Run traceroutes from Cloudflare colos.","operationId":"diagnostics-traceroute","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"colos":{"$ref":"#/components/schemas/colos"},"options":{"$ref":"#/components/schemas/schemas-options"},"targets":{"$ref":"#/components/schemas/targets-8BcM0LKv"}},"required":["targets"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/traceroute_response_collection"}}},"description":"Traceroute response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/traceroute_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Traceroute response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Traceroute","tags":["Diagnostics"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/dlp/patterns/validate":{"post":{"description":"Validates whether this pattern is a valid regular expression. Rejects it if the regular expression is too complex or can match an unbounded-length string. Your regex will be rejected if it uses the Kleene Star -- be sure to bound the maximum number of characters that can be matched.","operationId":"dlp-pattern-validation-validate-pattern","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/validate_pattern"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/validate_response"}}},"description":"Validate pattern response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/validate_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Validate pattern response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Validate pattern","tags":["DLP Pattern Validation"]}},"/accounts/{account_identifier}/dlp/payload_log":{"get":{"description":"Gets the current DLP payload log settings for this account.","operationId":"dlp-payload-log-settings-get-settings","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_settings_response"}}},"description":"Get settings response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/get_settings_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get settings response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get settings","tags":["DLP Payload Log Settings"]},"put":{"description":"Updates the DLP payload log settings for this account.","operationId":"dlp-payload-log-settings-update-settings","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_settings"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_settings_response"}}},"description":"Update settings response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/update_settings_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update settings response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update settings","tags":["DLP Payload Log Settings"]}},"/accounts/{account_identifier}/dlp/profiles":{"get":{"description":"Lists all DLP profiles in an account.","operationId":"dlp-profiles-list-all-profiles","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/profiles_components-schemas-response_collection"}}},"description":"List all profiles response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/profiles_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List all profiles response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List all profiles","tags":["DLP Profiles"]}},"/accounts/{account_identifier}/dlp/profiles/custom":{"post":{"description":"Creates a set of DLP custom profiles.","operationId":"dlp-profiles-create-custom-profiles","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_custom_profiles"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_custom_profile_response"}}},"description":"Create custom profiles response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/create_custom_profile_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create custom profiles response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create custom profiles","tags":["DLP Profiles"]}},"/accounts/{account_identifier}/dlp/profiles/custom/{profile_id}":{"delete":{"description":"Deletes a DLP custom profile.","operationId":"dlp-profiles-delete-custom-profile","parameters":[{"in":"path","name":"profile_id","required":true,"schema":{"$ref":"#/components/schemas/profile_id-JwqwymCp"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single"}}},"description":"Delete custom profile response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete custom profile response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete custom profile","tags":["DLP Profiles"]},"get":{"description":"Fetches a custom DLP profile.","operationId":"dlp-profiles-get-custom-profile","parameters":[{"in":"path","name":"profile_id","required":true,"schema":{"$ref":"#/components/schemas/profile_id-JwqwymCp"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_profile_response"}}},"description":"Get custom profile response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom_profile_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get custom profile response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get custom profile","tags":["DLP Profiles"]},"put":{"description":"Updates a DLP custom profile.","operationId":"dlp-profiles-update-custom-profile","parameters":[{"in":"path","name":"profile_id","required":true,"schema":{"$ref":"#/components/schemas/profile_id-JwqwymCp"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_custom_profile-j98uzXOJ"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_profile"}}},"description":"Update custom profile response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom_profile"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update custom profile response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update custom profile","tags":["DLP Profiles"]}},"/accounts/{account_identifier}/dlp/profiles/predefined/{profile_id}":{"get":{"description":"Fetches a predefined DLP profile.","operationId":"dlp-profiles-get-predefined-profile","parameters":[{"in":"path","name":"profile_id","required":true,"schema":{"$ref":"#/components/schemas/profile_id-JwqwymCp"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/predefined_profile_response"}}},"description":"Get predefined profile response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/predefined_profile_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get predefined profile response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get predefined profile","tags":["DLP Profiles"]},"put":{"description":"Updates a DLP predefined profile. Only supports enabling/disabling entries.","operationId":"dlp-profiles-update-predefined-profile","parameters":[{"in":"path","name":"profile_id","required":true,"schema":{"$ref":"#/components/schemas/profile_id-JwqwymCp"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_predefined_profile"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/predefined_profile"}}},"description":"Update predefined profile response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/predefined_profile"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update predefined profile response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update predefined profile","tags":["DLP Profiles"]}},"/accounts/{account_identifier}/dlp/profiles/{profile_id}":{"get":{"description":"Fetches a DLP profile by ID. Supports both predefined and custom profiles","operationId":"dlp-profiles-get-dlp-profile","parameters":[{"in":"path","name":"profile_id","required":true,"schema":{"$ref":"#/components/schemas/profile_id-JwqwymCp"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/either_profile_response-G4QJIAYV"}}},"description":"Get DLP Profile response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/either_profile_response-G4QJIAYV"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get DLP Profile response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get DLP Profile","tags":["DLP Profiles"]}},"/accounts/{account_identifier}/dns_firewall":{"get":{"description":"List configured DNS Firewall clusters for an account.","operationId":"dns-firewall-list-dns-firewall-clusters","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-b3jdvVAb"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns_firewall_response_collection"}}},"description":"List DNS Firewall Clusters response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns_firewall_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List DNS Firewall Clusters response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List DNS Firewall Clusters","tags":["DNS Firewall"],"x-cfPermissionsRequired":{"enum":["#dns_records:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Create a configured DNS Firewall Cluster.","operationId":"dns-firewall-create-dns-firewall-cluster","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-b3jdvVAb"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"attack_mitigation":{"$ref":"#/components/schemas/attack_mitigation"},"deprecate_any_requests":{"$ref":"#/components/schemas/deprecate_any_requests"},"ecs_fallback":{"$ref":"#/components/schemas/ecs_fallback"},"maximum_cache_ttl":{"$ref":"#/components/schemas/maximum_cache_ttl"},"minimum_cache_ttl":{"$ref":"#/components/schemas/minimum_cache_ttl"},"name":{"$ref":"#/components/schemas/name-SScjQrIN"},"negative_cache_ttl":{"$ref":"#/components/schemas/negative_cache_ttl"},"origin_ips":{"$ref":"#/components/schemas/origin_ips"},"ratelimit":{"$ref":"#/components/schemas/ratelimit"},"retries":{"$ref":"#/components/schemas/retries-w39sVXcQ"}},"required":["name","origin_ips"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns_firewall_single_response"}}},"description":"Create DNS Firewall Cluster response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns_firewall_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create DNS Firewall Cluster response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create DNS Firewall Cluster","tags":["DNS Firewall"],"x-cfPermissionsRequired":{"enum":["#dns_records:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/dns_firewall/{identifier}":{"delete":{"description":"Delete a configured DNS Firewall Cluster.","operationId":"dns-firewall-delete-dns-firewall-cluster","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-b3jdvVAb"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-b3jdvVAb"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/identifier-b3jdvVAb"}}}}}]}}},"description":"Delete DNS Firewall Cluster response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/identifier-b3jdvVAb"}}}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete DNS Firewall Cluster response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete DNS Firewall Cluster","tags":["DNS Firewall"],"x-cfPermissionsRequired":{"enum":["#dns_records:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Show a single configured DNS Firewall cluster for an account.","operationId":"dns-firewall-dns-firewall-cluster-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-b3jdvVAb"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-b3jdvVAb"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns_firewall_single_response"}}},"description":"DNS Firewall Cluster Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns_firewall_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"DNS Firewall Cluster Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"DNS Firewall Cluster Details","tags":["DNS Firewall"],"x-cfPermissionsRequired":{"enum":["#dns_records:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"patch":{"description":"Modify a DNS Firewall Cluster configuration.","operationId":"dns-firewall-update-dns-firewall-cluster","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-b3jdvVAb"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-b3jdvVAb"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-dns-firewall"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns_firewall_single_response"}}},"description":"Update DNS Firewall Cluster response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns_firewall_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update DNS Firewall Cluster response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update DNS Firewall Cluster","tags":["DNS Firewall"],"x-cfPermissionsRequired":{"enum":["#dns_records:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/dns_firewall/{identifier}/dns_analytics/report":{"get":{"description":"Retrieves a list of summarised aggregate metrics over a given time period.\n\nSee [Analytics API properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/) for detailed information about the available query parameters.","operationId":"dns-firewall-analytics-table","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-98VX040R"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-98VX040R"}},{"in":"query","name":"metrics","schema":{"$ref":"#/components/schemas/metrics"}},{"in":"query","name":"dimensions","schema":{"$ref":"#/components/schemas/dimensions"}},{"in":"query","name":"since","schema":{"$ref":"#/components/schemas/since"}},{"in":"query","name":"until","schema":{"$ref":"#/components/schemas/until"}},{"in":"query","name":"limit","schema":{"$ref":"#/components/schemas/limit"}},{"in":"query","name":"sort","schema":{"$ref":"#/components/schemas/sort"}},{"in":"query","name":"filters","schema":{"$ref":"#/components/schemas/filters-6K6BiPDe"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/report"}},"type":"object"}]}}},"description":"Table response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/report"}},"type":"object"}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Table response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Table","tags":["DNS Firewall Analytics"],"x-cfPermissionsRequired":{"enum":["#analytics:read"]}}},"/accounts/{account_identifier}/dns_firewall/{identifier}/dns_analytics/report/bytime":{"get":{"description":"Retrieves a list of aggregate metrics grouped by time interval.\n\nSee [Analytics API properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/) for detailed information about the available query parameters.","operationId":"dns-firewall-analytics-by-time","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-98VX040R"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-98VX040R"}},{"in":"query","name":"metrics","schema":{"$ref":"#/components/schemas/metrics"}},{"in":"query","name":"dimensions","schema":{"$ref":"#/components/schemas/dimensions"}},{"in":"query","name":"since","schema":{"$ref":"#/components/schemas/since"}},{"in":"query","name":"until","schema":{"$ref":"#/components/schemas/until"}},{"in":"query","name":"limit","schema":{"$ref":"#/components/schemas/limit"}},{"in":"query","name":"sort","schema":{"$ref":"#/components/schemas/sort"}},{"in":"query","name":"filters","schema":{"$ref":"#/components/schemas/filters-6K6BiPDe"}},{"in":"query","name":"time_delta","schema":{"$ref":"#/components/schemas/time_delta"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/report_bytime"}},"type":"object"}]}}},"description":"By Time response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/report_bytime"}},"type":"object"}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"By Time response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"By Time","tags":["DNS Firewall Analytics"],"x-cfPermissionsRequired":{"enum":["#analytics:read"]}}},"/accounts/{account_identifier}/email/routing/addresses":{"get":{"description":"Lists existing destination addresses.","operationId":"email-routing-destination-addresses-list-destination-addresses","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-YhmC5GTP"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Maximum number of results per page.","maximum":50,"minimum":5,"type":"number"}},{"in":"query","name":"direction","schema":{"default":"asc","description":"Sorts results in an ascending or descending order.","enum":["asc","desc"],"example":"asc","type":"string"}},{"in":"query","name":"verified","schema":{"default":true,"description":"Filter by verified destination addresses.","enum":[true,false],"example":true,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/destination_addresses_response_collection"}}},"description":"List destination addresses response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List destination addresses","tags":["Email Routing destination addresses"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.email.routing.address.list"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Create a destination address to forward your emails to. Destination addresses need to be verified before they can be used.","operationId":"email-routing-destination-addresses-create-a-destination-address","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-YhmC5GTP"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_destination_address_properties"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/destination_address_response_single"}}},"description":"Create a destination address response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create a destination address","tags":["Email Routing destination addresses"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.email.routing.address.create"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_identifier}/email/routing/addresses/{destination_address_identifier}":{"delete":{"description":"Deletes a specific destination address.","operationId":"email-routing-destination-addresses-delete-destination-address","parameters":[{"in":"path","name":"destination_address_identifier","required":true,"schema":{"$ref":"#/components/schemas/destination_address_identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-YhmC5GTP"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/destination_address_response_single"}}},"description":"Delete destination address response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete destination address","tags":["Email Routing destination addresses"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.email.routing.address.delete"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Gets information for a specific destination email already created.","operationId":"email-routing-destination-addresses-get-a-destination-address","parameters":[{"in":"path","name":"destination_address_identifier","required":true,"schema":{"$ref":"#/components/schemas/destination_address_identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-YhmC5GTP"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/destination_address_response_single"}}},"description":"Get a destination address response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a destination address","tags":["Email Routing destination addresses"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.email.routing.address.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_identifier}/firewall/access_rules/rules":{"get":{"description":"Fetches IP Access rules of an account. These rules apply to all the zones in the account. You can filter the results using several optional parameters.","operationId":"ip-access-rules-for-an-account-list-ip-access-rules","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-D3Kod1Eh"}},{"in":"query","name":"filters","schema":{"$ref":"#/components/schemas/schemas-filters"}},{"in":"query","name":"egs-pagination.json","schema":{"$ref":"#/components/schemas/egs-pagination"}},{"in":"query","name":"page","schema":{"description":"Requested page within paginated list of results.","example":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"description":"Maximum number of results requested.","example":20,"type":"number"}},{"in":"query","name":"order","schema":{"description":"The field used to sort returned rules.","enum":["configuration.target","configuration.value","mode"],"example":"mode","type":"string"}},{"in":"query","name":"direction","schema":{"description":"The direction used to sort returned rules.","enum":["asc","desc"],"example":"desc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_collection-NcnbjEgN"}}},"description":"List IP Access rules response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_collection-NcnbjEgN"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List IP Access rules response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List IP Access rules","tags":["IP Access rules for an account"],"x-cfPermissionsRequired":{"enum":["#waf:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Creates a new IP Access rule for an account. The rule will apply to all zones in the account.\n\nNote: To create an IP Access rule that applies to a single zone, refer to the [IP Access rules for a zone](#ip-access-rules-for-a-zone) endpoints.","operationId":"ip-access-rules-for-an-account-create-an-ip-access-rule","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-D3Kod1Eh"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"configuration":{"$ref":"#/components/schemas/schemas-configuration"},"mode":{"$ref":"#/components/schemas/schemas-mode"},"notes":{"$ref":"#/components/schemas/notes"}},"required":["mode","configuration"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_single"}}},"description":"Create an IP Access rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create an IP Access rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create an IP Access rule","tags":["IP Access rules for an account"],"x-cfPermissionsRequired":{"enum":["#waf:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_identifier}/firewall/access_rules/rules/{identifier}":{"delete":{"description":"Deletes an existing IP Access rule defined at the account level.\n\nNote: This operation will affect all zones in the account.","operationId":"ip-access-rules-for-an-account-delete-an-ip-access-rule","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier-3n9sRq0H"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-D3Kod1Eh"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single-id-u7jsvBJu"}}},"description":"Delete an IP Access rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single-id-u7jsvBJu"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete an IP Access rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete an IP Access rule","tags":["IP Access rules for an account"],"x-cfPermissionsRequired":{"enum":["#waf:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Fetches the details of an IP Access rule defined at the account level.","operationId":"ip-access-rules-for-an-account-get-an-ip-access-rule","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier-3n9sRq0H"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-D3Kod1Eh"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_single"}}},"description":"Get an IP Access rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get an IP Access rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get an IP Access rule","tags":["IP Access rules for an account"],"x-cfPermissionsRequired":{"enum":["#waf:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Updates an IP Access rule defined at the account level.\n\nNote: This operation will affect all zones in the account.","operationId":"ip-access-rules-for-an-account-update-an-ip-access-rule","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier-3n9sRq0H"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-D3Kod1Eh"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-rule"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_single"}}},"description":"Update an IP Access rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update an IP Access rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update an IP Access rule","tags":["IP Access rules for an account"],"x-cfPermissionsRequired":{"enum":["#waf:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_identifier}/images/v1":{"get":{"description":"List up to 100 images with one request. Use the optional parameters below to get a specific range of images.","operationId":"cloudflare-images-list-images","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-account_identifier"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":50,"description":"Number of items per page.","maximum":100,"minimum":10,"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/image_response_collection"}}},"description":"List images response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/image_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List images response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List images","tags":["Cloudflare Images"]},"post":{"description":"Upload an image via URL with up to 10 Megabytes using a single HTTP POST (multipart/form-data) request.","operationId":"cloudflare-images-upload-an-image-via-url","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-account_identifier"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/image_basic_upload_via_url"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/image_response_single"}}},"description":"Upload an image via URL response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/image_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Upload an image via URL response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Upload an image via URL","tags":["Cloudflare Images"]}},"/accounts/{account_identifier}/images/v1/keys":{"get":{"description":"Lists your signing keys. These can be found on your Cloudflare Images dashboard.","operationId":"cloudflare-images-keys-list-signing-keys","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/key_response_collection"}}},"description":"List Signing Keys response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/key_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Signing Keys response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Signing Keys","tags":["Cloudflare Images Keys"]}},"/accounts/{account_identifier}/images/v1/stats":{"get":{"description":"Fetch usage statistics details for Cloudflare Images.","operationId":"cloudflare-images-images-usage-statistics","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/images_stats"}}},"description":"Images usage statistics response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/images_stats"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Images usage statistics response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Images usage statistics","tags":["Cloudflare Images"]}},"/accounts/{account_identifier}/images/v1/variants":{"get":{"description":"Lists existing variants.","operationId":"cloudflare-images-variants-list-variants","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/variant_list_response"}}},"description":"List variants response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/variant_list_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List variants response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List variants","tags":["Cloudflare Images Variants"]},"post":{"description":"Specify variants that allow you to resize images for different use cases.","operationId":"cloudflare-images-variants-create-a-variant","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/variant_generation_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/variant_simple_response"}}},"description":"Create a variant response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/variant_simple_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create a variant response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create a variant","tags":["Cloudflare Images Variants"]}},"/accounts/{account_identifier}/images/v1/variants/{identifier}":{"delete":{"description":"Deleting a variant purges the cache for all images associated with the variant.","operationId":"cloudflare-images-variants-delete-a-variant","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/variants_components-schemas-identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deleted_response"}}},"description":"Delete a variant response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/deleted_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete a variant response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete a variant","tags":["Cloudflare Images Variants"]},"get":{"description":"Fetch details for a single variant.","operationId":"cloudflare-images-variants-variant-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/variants_components-schemas-identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/variant_simple_response"}}},"description":"Variant details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/variant_simple_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Variant details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Variant details","tags":["Cloudflare Images Variants"]},"patch":{"description":"Updating a variant purges the cache for all images associated with the variant.","operationId":"cloudflare-images-variants-update-a-variant","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/variants_components-schemas-identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/variant_patch_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/variant_simple_response"}}},"description":"Update a variant response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/variant_simple_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update a variant response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update a variant","tags":["Cloudflare Images Variants"]}},"/accounts/{account_identifier}/images/v1/{identifier}":{"delete":{"description":"Delete an image on Cloudflare Images. On success, all copies of the image are deleted and purged from cache.","operationId":"cloudflare-images-delete-image","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/images_components-schemas-identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-account_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deleted_response"}}},"description":"Delete image response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/deleted_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete image response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete image","tags":["Cloudflare Images"]},"get":{"description":"Fetch details for a single image.","operationId":"cloudflare-images-image-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/images_components-schemas-identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/image_response_single"}}},"description":"Image details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/image_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Image details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Image details","tags":["Cloudflare Images"]},"patch":{"description":"Update image access control. On access control change, all copies of the image are purged from cache.","operationId":"cloudflare-images-update-image","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/images_components-schemas-identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/image_patch_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/image_response_single"}}},"description":"Update image response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/image_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update image response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update image","tags":["Cloudflare Images"]}},"/accounts/{account_identifier}/images/v1/{identifier}/blob":{"get":{"description":"Fetch base image. For most images this will be the originally uploaded file. For larger images it can be a near-lossless version of the original.","operationId":"cloudflare-images-base-image","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/images_components-schemas-identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/image_response_blob"}}},"description":"Base image response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/image_response_blob"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Base image response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Base image","tags":["Cloudflare Images"]}},"/accounts/{account_identifier}/images/v2/direct_upload":{"post":{"description":"Direct uploads allow users to upload images without API keys. A common use case are web apps, client-side applications, or mobile devices where users upload content directly to Cloudflare Images. This method creates a draft record for a future image. It returns an upload URL and an image identifier. To verify if the image itself has been uploaded, send an image details request (accounts/:account_identifier/images/v1/:identifier), and check that the `draft: true` property is not present.","operationId":"cloudflare-images-create-authenticated-direct-upload-url-v-2","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-account_identifier"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/direct_upload_request_v2"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/direct_upload_response_v2"}}},"description":"Create authenticated direct upload URL V2 response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/direct_upload_response_v2"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create authenticated direct upload URL V2 response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create authenticated direct upload URL V2","tags":["Cloudflare Images"]}},"/accounts/{account_identifier}/intel/asn/{asn}":{"get":{"operationId":"asn-intelligence-get-asn-overview","parameters":[{"in":"path","name":"asn","required":true,"schema":{"$ref":"#/components/schemas/asn_components-schemas-asn"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/asn_components-schemas-response"}}},"description":"Get ASN Overview response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/asn_components-schemas-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get ASN Overview response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get ASN Overview","tags":["ASN Intelligence"]}},"/accounts/{account_identifier}/intel/asn/{asn}/subnets":{"get":{"operationId":"asn-intelligence-get-asn-subnets","parameters":[{"in":"path","name":"asn","required":true,"schema":{"$ref":"#/components/schemas/asn_components-schemas-asn"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"asn":{"$ref":"#/components/schemas/components-schemas-asn"},"count":{"$ref":"#/components/schemas/count-IxGc2iY9"},"ip_count_total":{"type":"integer"},"page":{"$ref":"#/components/schemas/page"},"per_page":{"$ref":"#/components/schemas/components-schemas-per_page"},"subnets":{"example":["192.0.2.0/24","2001:DB8::/32"],"items":{"type":"string"},"type":"array"}},"type":"object"}}},"description":"Get ASN Subnets response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"properties":{"asn":{"$ref":"#/components/schemas/components-schemas-asn"},"count":{"$ref":"#/components/schemas/count-IxGc2iY9"},"ip_count_total":{"type":"integer"},"page":{"$ref":"#/components/schemas/page"},"per_page":{"$ref":"#/components/schemas/components-schemas-per_page"},"subnets":{"example":["192.0.2.0/24","2001:DB8::/32"],"items":{"type":"string"},"type":"array"}},"type":"object"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get ASN Subnets response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get ASN Subnets","tags":["ASN Intelligence"]}},"/accounts/{account_identifier}/intel/dns":{"get":{"operationId":"passive-dns-by-ip-get-passive-dns-by-ip","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"start_end_params","schema":{"$ref":"#/components/schemas/start_end_params"}},{"in":"query","name":"ipv4","schema":{"type":"string"}},{"in":"query","name":"page","schema":{"description":"Requested page within paginated list of results.","example":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"description":"Maximum number of results requested.","example":20,"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/passive-dns-by-ip_components-schemas-single_response"}}},"description":"Get Passive DNS by IP response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/passive-dns-by-ip_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Passive DNS by IP response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Passive DNS by IP","tags":["Passive DNS by IP"]}},"/accounts/{account_identifier}/intel/domain":{"get":{"operationId":"domain-intelligence-get-domain-details","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"domain","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain_components-schemas-single_response"}}},"description":"Get Domain Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/domain_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Domain Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Domain Details","tags":["Domain Intelligence"]}},"/accounts/{account_identifier}/intel/domain-history":{"get":{"operationId":"domain-history-get-domain-history","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"domain","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/response"}}},"description":"Get Domain History response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Domain History response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Domain History","tags":["Domain History"]}},"/accounts/{account_identifier}/intel/domain/bulk":{"get":{"operationId":"domain-intelligence-get-multiple-domain-details","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"domain","schema":{"description":"Accepts multiple values, i.e. `?domain=cloudflare.com\u0026domain=example.com`."}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-collection_response"}}},"description":"Get Multiple Domain Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Multiple Domain Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Multiple Domain Details","tags":["Domain Intelligence"]}},"/accounts/{account_identifier}/intel/ip":{"get":{"operationId":"ip-intelligence-get-ip-overview","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"ipv4","schema":{"type":"string"}},{"in":"query","name":"ipv6","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-response"}}},"description":"Get IP Overview response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get IP Overview response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get IP Overview","tags":["IP Intelligence"]}},"/accounts/{account_identifier}/intel/ip-list":{"get":{"operationId":"ip-list-get-ip-lists","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-response"}}},"description":"Get IP Lists response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get IP Lists response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get IP Lists","tags":["IP List"]}},"/accounts/{account_identifier}/intel/miscategorization":{"post":{"operationId":"miscategorization-create-miscategorization","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/miscategorization"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single"}}},"description":"Create Miscategorization response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Miscategorization response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Miscategorization","tags":["Miscategorization"]}},"/accounts/{account_identifier}/intel/whois":{"get":{"operationId":"whois-record-get-whois-record","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"domain","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/whois_components-schemas-single_response"}}},"description":"Get WHOIS Record response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/whois_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get WHOIS Record response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get WHOIS Record","tags":["WHOIS Record"]}},"/accounts/{account_identifier}/load_balancers/monitors":{"get":{"description":"List configured monitors for an account.","operationId":"account-load-balancer-monitors-list-monitors","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-identifier-454QZaBH"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/monitor_components-schemas-response_collection-hQYwgX5c"}}},"description":"List Monitors response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/monitor_components-schemas-response_collection-hQYwgX5c"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Monitors response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Monitors","tags":["Account Load Balancer Monitors"]},"post":{"description":"Create a configured monitor.","operationId":"account-load-balancer-monitors-create-monitor","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-identifier-454QZaBH"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"allow_insecure":{"$ref":"#/components/schemas/allow_insecure"},"consecutive_down":{"$ref":"#/components/schemas/consecutive_down"},"consecutive_up":{"$ref":"#/components/schemas/consecutive_up"},"description":{"$ref":"#/components/schemas/description-Jd6AMFjR"},"expected_body":{"$ref":"#/components/schemas/expected_body"},"expected_codes":{"$ref":"#/components/schemas/schemas-expected_codes"},"follow_redirects":{"$ref":"#/components/schemas/follow_redirects"},"header":{"$ref":"#/components/schemas/header"},"interval":{"$ref":"#/components/schemas/interval-hA6swy38"},"method":{"$ref":"#/components/schemas/method-guvmKTdR"},"path":{"$ref":"#/components/schemas/path-I0p9X4oI"},"port":{"$ref":"#/components/schemas/schemas-port-uAxZ6zJW"},"probe_zone":{"$ref":"#/components/schemas/probe_zone"},"retries":{"$ref":"#/components/schemas/retries"},"timeout":{"$ref":"#/components/schemas/timeout"},"type":{"$ref":"#/components/schemas/type-gTI6cLgq"}},"required":["expected_codes"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/monitor_components-schemas-single_response"}}},"description":"Create Monitor response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/monitor_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Monitor response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Monitor","tags":["Account Load Balancer Monitors"]}},"/accounts/{account_identifier}/load_balancers/monitors/{identifier}":{"delete":{"description":"Delete a configured monitor.","operationId":"account-load-balancer-monitors-delete-monitor","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-FZThz4k7"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-identifier-454QZaBH"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/id_response-99rIWUZu"}}},"description":"Delete Monitor response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/id_response-99rIWUZu"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Monitor response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Monitor","tags":["Account Load Balancer Monitors"]},"get":{"description":"List a single configured monitor for an account.","operationId":"account-load-balancer-monitors-monitor-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-FZThz4k7"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-identifier-454QZaBH"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/monitor_components-schemas-single_response"}}},"description":"Monitor Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/monitor_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Monitor Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Monitor Details","tags":["Account Load Balancer Monitors"]},"patch":{"description":"Apply changes to an existing monitor, overwriting the supplied properties.","operationId":"account-load-balancer-monitors-patch-monitor","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-FZThz4k7"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-identifier-454QZaBH"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"allow_insecure":{"$ref":"#/components/schemas/allow_insecure"},"consecutive_down":{"$ref":"#/components/schemas/consecutive_down"},"consecutive_up":{"$ref":"#/components/schemas/consecutive_up"},"description":{"$ref":"#/components/schemas/description-Jd6AMFjR"},"expected_body":{"$ref":"#/components/schemas/expected_body"},"expected_codes":{"$ref":"#/components/schemas/schemas-expected_codes"},"follow_redirects":{"$ref":"#/components/schemas/follow_redirects"},"header":{"$ref":"#/components/schemas/header"},"interval":{"$ref":"#/components/schemas/interval-hA6swy38"},"method":{"$ref":"#/components/schemas/method-guvmKTdR"},"path":{"$ref":"#/components/schemas/path-I0p9X4oI"},"port":{"$ref":"#/components/schemas/schemas-port-uAxZ6zJW"},"probe_zone":{"$ref":"#/components/schemas/probe_zone"},"retries":{"$ref":"#/components/schemas/retries"},"timeout":{"$ref":"#/components/schemas/timeout"},"type":{"$ref":"#/components/schemas/type-gTI6cLgq"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/monitor_components-schemas-single_response"}}},"description":"Patch Monitor response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/monitor_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Patch Monitor response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Patch Monitor","tags":["Account Load Balancer Monitors"]},"put":{"description":"Modify a configured monitor.","operationId":"account-load-balancer-monitors-update-monitor","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-FZThz4k7"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-identifier-454QZaBH"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"allow_insecure":{"$ref":"#/components/schemas/allow_insecure"},"consecutive_down":{"$ref":"#/components/schemas/consecutive_down"},"consecutive_up":{"$ref":"#/components/schemas/consecutive_up"},"description":{"$ref":"#/components/schemas/description-Jd6AMFjR"},"expected_body":{"$ref":"#/components/schemas/expected_body"},"expected_codes":{"$ref":"#/components/schemas/schemas-expected_codes"},"follow_redirects":{"$ref":"#/components/schemas/follow_redirects"},"header":{"$ref":"#/components/schemas/header"},"interval":{"$ref":"#/components/schemas/interval-hA6swy38"},"method":{"$ref":"#/components/schemas/method-guvmKTdR"},"path":{"$ref":"#/components/schemas/path-I0p9X4oI"},"port":{"$ref":"#/components/schemas/schemas-port-uAxZ6zJW"},"probe_zone":{"$ref":"#/components/schemas/probe_zone"},"retries":{"$ref":"#/components/schemas/retries"},"timeout":{"$ref":"#/components/schemas/timeout"},"type":{"$ref":"#/components/schemas/type-gTI6cLgq"}},"required":["expected_codes"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/monitor_components-schemas-single_response"}}},"description":"Update Monitor response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/monitor_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Monitor response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Monitor","tags":["Account Load Balancer Monitors"]}},"/accounts/{account_identifier}/load_balancers/monitors/{identifier}/preview":{"post":{"description":"Preview pools using the specified monitor with provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results.","operationId":"account-load-balancer-monitors-preview-monitor","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-FZThz4k7"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-identifier-454QZaBH"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"allow_insecure":{"$ref":"#/components/schemas/allow_insecure"},"expected_body":{"$ref":"#/components/schemas/expected_body"},"expected_codes":{"$ref":"#/components/schemas/schemas-expected_codes"},"follow_redirects":{"$ref":"#/components/schemas/follow_redirects"},"header":{"$ref":"#/components/schemas/header"},"method":{"$ref":"#/components/schemas/method-guvmKTdR"},"path":{"$ref":"#/components/schemas/path-I0p9X4oI"},"port":{"$ref":"#/components/schemas/schemas-port-uAxZ6zJW"},"probe_zone":{"$ref":"#/components/schemas/probe_zone"},"retries":{"$ref":"#/components/schemas/retries"},"timeout":{"$ref":"#/components/schemas/timeout"},"type":{"$ref":"#/components/schemas/type-gTI6cLgq"}},"required":["expected_codes"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/preview_response-ZWQ9Fl0k"}}},"description":"Preview Monitor response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/preview_response-ZWQ9Fl0k"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Preview Monitor response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Preview Monitor","tags":["Account Load Balancer Monitors"]}},"/accounts/{account_identifier}/load_balancers/monitors/{identifier}/references":{"get":{"description":"Get the list of resources that reference the provided monitor.","operationId":"account-load-balancer-monitors-list-monitor-references","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-FZThz4k7"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-identifier-454QZaBH"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/references_response"}}},"description":"List Monitor References response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/references_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Monitor References response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Monitor References","tags":["Account Load Balancer Monitors"]}},"/accounts/{account_identifier}/load_balancers/pools":{"get":{"description":"List configured pools.","operationId":"account-load-balancer-pools-list-pools","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-identifier-454QZaBH"}},{"in":"query","name":"monitor","schema":{"description":"The ID of the Monitor to use for checking the health of origins within this pool."}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-response_collection-PNoWMjSR"}}},"description":"List Pools response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-response_collection-PNoWMjSR"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Pools response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Pools","tags":["Account Load Balancer Pools"]},"patch":{"description":"Apply changes to a number of existing pools, overwriting the supplied properties. Pools are ordered by ascending `name`. Returns the list of affected pools. Supports the standard pagination query parameters, either `limit`/`offset` or `per_page`/`page`.","operationId":"account-load-balancer-pools-patch-pools","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-identifier-454QZaBH"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"notification_email":{"$ref":"#/components/schemas/patch_pools_notification_email"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-response_collection-PNoWMjSR"}}},"description":"Patch Pools response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-response_collection-PNoWMjSR"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Patch Pools response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Patch Pools","tags":["Account Load Balancer Pools"]},"post":{"description":"Create a new pool.","operationId":"account-load-balancer-pools-create-pool","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-identifier-454QZaBH"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"description":{"$ref":"#/components/schemas/schemas-description-XvtZaN2T"},"enabled":{"$ref":"#/components/schemas/enabled-WoQtkwsn"},"latitude":{"$ref":"#/components/schemas/latitude"},"load_shedding":{"$ref":"#/components/schemas/load_shedding"},"longitude":{"$ref":"#/components/schemas/longitude"},"minimum_origins":{"$ref":"#/components/schemas/minimum_origins"},"monitor":{"$ref":"#/components/schemas/schemas-monitor"},"name":{"$ref":"#/components/schemas/name-Pky1OOiR"},"notification_email":{"$ref":"#/components/schemas/notification_email"},"notification_filter":{"$ref":"#/components/schemas/notification_filter"},"origin_steering":{"$ref":"#/components/schemas/origin_steering"},"origins":{"$ref":"#/components/schemas/origins-BzaDTSuG"}},"required":["origins","name"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-single_response-uzr0CVkk"}}},"description":"Create Pool response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-single_response-uzr0CVkk"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Pool response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Pool","tags":["Account Load Balancer Pools"]}},"/accounts/{account_identifier}/load_balancers/pools/{identifier}":{"delete":{"description":"Delete a configured pool.","operationId":"account-load-balancer-pools-delete-pool","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier-LDS3pdXe"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-identifier-454QZaBH"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-id_response-n8mMAIdf"}}},"description":"Delete Pool response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-id_response-n8mMAIdf"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Pool response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Pool","tags":["Account Load Balancer Pools"]},"get":{"description":"Fetch a single configured pool.","operationId":"account-load-balancer-pools-pool-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier-LDS3pdXe"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-identifier-454QZaBH"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-single_response-uzr0CVkk"}}},"description":"Pool Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-single_response-uzr0CVkk"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Pool Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Pool Details","tags":["Account Load Balancer Pools"]},"patch":{"description":"Apply changes to an existing pool, overwriting the supplied properties.","operationId":"account-load-balancer-pools-patch-pool","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier-LDS3pdXe"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-identifier-454QZaBH"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"check_regions":{"$ref":"#/components/schemas/check_regions-q46IR1gk"},"description":{"$ref":"#/components/schemas/schemas-description-XvtZaN2T"},"disabled_at":{"$ref":"#/components/schemas/schemas-disabled_at"},"enabled":{"$ref":"#/components/schemas/enabled-WoQtkwsn"},"latitude":{"$ref":"#/components/schemas/latitude"},"load_shedding":{"$ref":"#/components/schemas/load_shedding"},"longitude":{"$ref":"#/components/schemas/longitude"},"minimum_origins":{"$ref":"#/components/schemas/minimum_origins"},"monitor":{"$ref":"#/components/schemas/schemas-monitor"},"name":{"$ref":"#/components/schemas/name-Pky1OOiR"},"notification_email":{"$ref":"#/components/schemas/notification_email"},"notification_filter":{"$ref":"#/components/schemas/notification_filter"},"origin_steering":{"$ref":"#/components/schemas/origin_steering"},"origins":{"$ref":"#/components/schemas/origins-BzaDTSuG"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-single_response-uzr0CVkk"}}},"description":"Patch Pool response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-single_response-uzr0CVkk"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Patch Pool response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Patch Pool","tags":["Account Load Balancer Pools"]},"put":{"description":"Modify a configured pool.","operationId":"account-load-balancer-pools-update-pool","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier-LDS3pdXe"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-identifier-454QZaBH"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"check_regions":{"$ref":"#/components/schemas/check_regions-q46IR1gk"},"description":{"$ref":"#/components/schemas/schemas-description-XvtZaN2T"},"disabled_at":{"$ref":"#/components/schemas/schemas-disabled_at"},"enabled":{"$ref":"#/components/schemas/enabled-WoQtkwsn"},"latitude":{"$ref":"#/components/schemas/latitude"},"load_shedding":{"$ref":"#/components/schemas/load_shedding"},"longitude":{"$ref":"#/components/schemas/longitude"},"minimum_origins":{"$ref":"#/components/schemas/minimum_origins"},"monitor":{"$ref":"#/components/schemas/schemas-monitor"},"name":{"$ref":"#/components/schemas/name-Pky1OOiR"},"notification_email":{"$ref":"#/components/schemas/notification_email"},"notification_filter":{"$ref":"#/components/schemas/notification_filter"},"origin_steering":{"$ref":"#/components/schemas/origin_steering"},"origins":{"$ref":"#/components/schemas/origins-BzaDTSuG"}},"required":["origins","name"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-single_response-uzr0CVkk"}}},"description":"Update Pool response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-single_response-uzr0CVkk"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Pool response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Pool","tags":["Account Load Balancer Pools"]}},"/accounts/{account_identifier}/load_balancers/pools/{identifier}/health":{"get":{"description":"Fetch the latest pool health status for a single pool.","operationId":"account-load-balancer-pools-pool-health-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier-LDS3pdXe"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-identifier-454QZaBH"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/health_details"}}},"description":"Pool Health Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/health_details"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Pool Health Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Pool Health Details","tags":["Account Load Balancer Pools"]}},"/accounts/{account_identifier}/load_balancers/pools/{identifier}/preview":{"post":{"description":"Preview pool health using provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results.","operationId":"account-load-balancer-pools-preview-pool","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier-LDS3pdXe"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-identifier-454QZaBH"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"allow_insecure":{"$ref":"#/components/schemas/allow_insecure"},"expected_body":{"$ref":"#/components/schemas/expected_body"},"expected_codes":{"$ref":"#/components/schemas/schemas-expected_codes"},"follow_redirects":{"$ref":"#/components/schemas/follow_redirects"},"header":{"$ref":"#/components/schemas/header"},"method":{"$ref":"#/components/schemas/method-guvmKTdR"},"path":{"$ref":"#/components/schemas/path-I0p9X4oI"},"port":{"$ref":"#/components/schemas/schemas-port-uAxZ6zJW"},"probe_zone":{"$ref":"#/components/schemas/probe_zone"},"retries":{"$ref":"#/components/schemas/retries"},"timeout":{"$ref":"#/components/schemas/timeout"},"type":{"$ref":"#/components/schemas/type-gTI6cLgq"}},"required":["expected_codes"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/preview_response-ZWQ9Fl0k"}}},"description":"Preview Pool response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/preview_response-ZWQ9Fl0k"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Preview Pool response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Preview Pool","tags":["Account Load Balancer Pools"]}},"/accounts/{account_identifier}/load_balancers/pools/{identifier}/references":{"get":{"description":"Get the list of resources that reference the provided pool.","operationId":"account-load-balancer-pools-list-pool-references","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier-LDS3pdXe"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-identifier-454QZaBH"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-references_response"}}},"description":"List Pool References response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-references_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Pool References response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Pool References","tags":["Account Load Balancer Pools"]}},"/accounts/{account_identifier}/load_balancers/preview/{preview_id}":{"get":{"description":"Get the result of a previous preview operation using the provided preview_id.","operationId":"account-load-balancer-monitors-preview-result","parameters":[{"in":"path","name":"preview_id","required":true,"schema":{"$ref":"#/components/schemas/schemas-preview_id"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-identifier-454QZaBH"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/preview_result_response-181bkyJU"}}},"description":"Preview Result response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/preview_result_response-181bkyJU"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Preview Result response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Preview Result","tags":["Account Load Balancer Monitors"]}},"/accounts/{account_identifier}/load_balancers/regions":{"get":{"description":"List all region mappings.","operationId":"load-balancer-regions-list-regions","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-identifier-454QZaBH"}},{"in":"query","name":"subdivision_code","schema":{"$ref":"#/components/schemas/subdivision_code_a2"}},{"in":"query","name":"subdivision_code_a2","schema":{"$ref":"#/components/schemas/subdivision_code_a2"}},{"in":"query","name":"country_code_a2","schema":{"description":"Two-letter alpha-2 country code followed in ISO 3166-1.","example":"US","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/region_components-schemas-response_collection"}}},"description":"List Regions response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/region_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Regions response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Regions","tags":["Load Balancer Regions"]}},"/accounts/{account_identifier}/load_balancers/regions/{region_code}":{"get":{"description":"Get a single region mapping.","operationId":"load-balancer-regions-get-region","parameters":[{"in":"path","name":"region_code","required":true,"schema":{"$ref":"#/components/schemas/region_code"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-identifier-454QZaBH"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-single_response-AhobaCUU"}}},"description":"Get Region response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-single_response-AhobaCUU"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Region response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Region","tags":["Load Balancer Regions"]}},"/accounts/{account_identifier}/load_balancers/search":{"get":{"description":"Search for Load Balancing resources.","operationId":"account-load-balancer-search-search-resources","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-identifier-454QZaBH"}},{"in":"query","name":"search_params","schema":{"$ref":"#/components/schemas/search_params"}},{"in":"query","name":"page","schema":{"minimum":1}},{"in":"query","name":"per_page","schema":{"default":25,"maximum":1000,"minimum":1}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"$ref":"#/components/schemas/search_result"}]}}},"description":"Search Resources response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"$ref":"#/components/schemas/search_result"}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Search Resources response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Search Resources","tags":["Account Load Balancer Search"]}},"/accounts/{account_identifier}/logpush/datasets/{dataset}/fields":{"get":{"description":"Lists all fields available for a dataset. The response result is an object with key-value pairs, where keys are field names, and values are descriptions.","operationId":"get-accounts-account_identifier-logpush-datasets-dataset-fields","parameters":[{"in":"path","name":"dataset","required":true,"schema":{"$ref":"#/components/schemas/dataset"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Gw95Cj70"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logpush_field_response_collection"}}},"description":"List fields response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_field_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List fields response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List fields","tags":["Logpush jobs for an account"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/logpush/datasets/{dataset}/jobs":{"get":{"description":"Lists Logpush jobs for an account for a dataset.","operationId":"get-accounts-account_identifier-logpush-datasets-dataset-jobs","parameters":[{"in":"path","name":"dataset","required":true,"schema":{"$ref":"#/components/schemas/dataset"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Gw95Cj70"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logpush_job_response_collection"}}},"description":"List Logpush jobs for a dataset response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_job_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Logpush jobs for a dataset response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Logpush jobs for a dataset","tags":["Logpush jobs for an account"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/logpush/jobs":{"get":{"description":"Lists Logpush jobs for an account.","operationId":"get-accounts-account_identifier-logpush-jobs","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Gw95Cj70"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logpush_job_response_collection"}}},"description":"List Logpush jobs response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_job_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Logpush jobs response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Logpush jobs","tags":["Logpush jobs for an account"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Creates a new Logpush job for an account.","operationId":"post-accounts-account_identifier-logpush-jobs","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Gw95Cj70"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"dataset":{"$ref":"#/components/schemas/dataset"},"destination_conf":{"$ref":"#/components/schemas/destination_conf"},"enabled":{"$ref":"#/components/schemas/enabled-A6pti18n"},"frequency":{"$ref":"#/components/schemas/frequency"},"logpull_options":{"$ref":"#/components/schemas/logpull_options"},"name":{"$ref":"#/components/schemas/name-rRqaJzmt"},"ownership_challenge":{"$ref":"#/components/schemas/ownership_challenge"}},"required":["destination_conf"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logpush_job_response_single"}}},"description":"Create Logpush job response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_job_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Logpush job response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Logpush job","tags":["Logpush jobs for an account"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/logpush/jobs/{job_identifier}":{"delete":{"description":"Deletes a Logpush job.","operationId":"delete-accounts-account_identifier-logpush-jobs-job_identifier","parameters":[{"in":"path","name":"job_identifier","required":true,"schema":{"$ref":"#/components/schemas/id-Un5diNDY"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Gw95Cj70"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"example":{},"nullable":true,"type":"object"}}}]}}},"description":"Delete Logpush job response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"example":{},"nullable":true,"type":"object"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Logpush job response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Logpush job","tags":["Logpush jobs for an account"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Gets the details of a Logpush job.","operationId":"get-accounts-account_identifier-logpush-jobs-job_identifier","parameters":[{"in":"path","name":"job_identifier","required":true,"schema":{"$ref":"#/components/schemas/id-Un5diNDY"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Gw95Cj70"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logpush_job_response_single"}}},"description":"Get Logpush job details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_job_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Logpush job details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Logpush job details","tags":["Logpush jobs for an account"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Updates a Logpush job.","operationId":"put-accounts-account_identifier-logpush-jobs-job_identifier","parameters":[{"in":"path","name":"job_identifier","required":true,"schema":{"$ref":"#/components/schemas/id-Un5diNDY"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Gw95Cj70"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"destination_conf":{"$ref":"#/components/schemas/destination_conf"},"enabled":{"$ref":"#/components/schemas/enabled-A6pti18n"},"frequency":{"$ref":"#/components/schemas/frequency"},"logpull_options":{"$ref":"#/components/schemas/logpull_options"},"ownership_challenge":{"$ref":"#/components/schemas/ownership_challenge"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logpush_job_response_single"}}},"description":"Update Logpush job response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_job_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Logpush job response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Logpush job","tags":["Logpush jobs for an account"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/logpush/ownership":{"post":{"description":"Gets a new ownership challenge sent to your destination.","operationId":"post-accounts-account_identifier-logpush-ownership","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Gw95Cj70"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"destination_conf":{"$ref":"#/components/schemas/destination_conf"}},"required":["destination_conf"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_ownership_response"}}},"description":"Get ownership challenge response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/get_ownership_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get ownership challenge response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get ownership challenge","tags":["Logpush jobs for an account"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/logpush/ownership/validate":{"post":{"description":"Validates ownership challenge of the destination.","operationId":"post-accounts-account_identifier-logpush-ownership-validate","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Gw95Cj70"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"destination_conf":{"$ref":"#/components/schemas/destination_conf"},"ownership_challenge":{"$ref":"#/components/schemas/ownership_challenge"}},"required":["destination_conf","ownership_challenge"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/validate_ownership_response"}}},"description":"Validate ownership challenge response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/validate_ownership_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Validate ownership challenge response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Validate ownership challenge","tags":["Logpush jobs for an account"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/logpush/validate/destination/exists":{"post":{"description":"Checks if there is an existing job with a destination.","operationId":"delete-accounts-account_identifier-logpush-validate-destination-exists","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Gw95Cj70"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"destination_conf":{"$ref":"#/components/schemas/destination_conf"}},"required":["destination_conf"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/destination_exists_response"}}},"description":"Check destination exists response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/destination_exists_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Check destination exists response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Check destination exists","tags":["Logpush jobs for an account"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/logpush/validate/origin":{"post":{"description":"Validates logpull origin with logpull_options.","operationId":"post-accounts-account_identifier-logpush-validate-origin","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Gw95Cj70"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"logpull_options":{"$ref":"#/components/schemas/logpull_options"}},"required":["logpull_options"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/validate_response-PaQpkUV3"}}},"description":"Validate origin response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/validate_response-PaQpkUV3"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Validate origin response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Validate origin","tags":["Logpush jobs for an account"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/logs/control/cmb/config":{"delete":{"description":"Deletes CMB config.","operationId":"delete-accounts-account_identifier-logs-control-cmb-config","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-59LodGbZ"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"example":{},"nullable":true,"type":"object"}}}]}}},"description":"Delete CMB config response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"example":{},"nullable":true,"type":"object"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete CMB config response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete CMB config","tags":["Logcontrol CMB config for an account"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]}},"get":{"description":"Gets CMB config.","operationId":"get-accounts-account_identifier-logs-control-cmb-config","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-59LodGbZ"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cmb_config_response_single"}}},"description":"Get CMB config response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get CMB config response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get CMB config","tags":["Logcontrol CMB config for an account"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]}},"post":{"description":"Updates CMB config.","operationId":"put-accounts-account_identifier-logs-control-cmb-config","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-59LodGbZ"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cmb_config"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cmb_config_response_single"}}},"description":"Update CMB config response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update CMB config response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update CMB config","tags":["Logcontrol CMB config for an account"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]}}},"/accounts/{account_identifier}/magic/cf_interconnects":{"get":{"description":"Lists interconnects associated with an account.","operationId":"magic-interconnects-list-interconnects","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-tunnels_collection_response"}}},"description":"List interconnects response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-tunnels_collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List interconnects response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List interconnects","tags":["Magic Interconnects"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Updates multiple interconnects associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.","operationId":"magic-interconnects-update-multiple-interconnects","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["id"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-modified_tunnels_collection_response"}}},"description":"Update multiple interconnects response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-modified_tunnels_collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update multiple interconnects response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update multiple interconnects","tags":["Magic Interconnects"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/magic/cf_interconnects/{tunnel_identifier}":{"get":{"description":"Lists details for a specific interconnect.","operationId":"magic-interconnects-list-interconnect-details","parameters":[{"in":"path","name":"tunnel_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-tunnel_single_response"}}},"description":"List interconnect Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-tunnel_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List interconnect Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List interconnect Details","tags":["Magic Interconnects"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Updates a specific interconnect associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.","operationId":"magic-interconnects-update-interconnect","parameters":[{"in":"path","name":"tunnel_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-tunnel_update_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-tunnel_modified_response"}}},"description":"Update interconnect response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-tunnel_modified_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update interconnect response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update interconnect","tags":["Magic Interconnects"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/magic/gre_tunnels":{"get":{"description":"Lists GRE tunnels associated with an account.","operationId":"magic-gre-tunnels-list-gre-tunnels","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnels_collection_response"}}},"description":"List GRE tunnels response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnels_collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List GRE tunnels response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List GRE tunnels","tags":["Magic GRE tunnels"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Creates new GRE tunnels. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.","operationId":"magic-gre-tunnels-create-gre-tunnels","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["name","customer_gre_endpoint","cloudflare_gre_endpoint","interface_address"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnels_collection_response"}}},"description":"Create GRE tunnels response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnels_collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create GRE tunnels response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create GRE tunnels","tags":["Magic GRE tunnels"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Updates multiple GRE tunnels. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.","operationId":"magic-gre-tunnels-update-multiple-gre-tunnels","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["id"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/modified_tunnels_collection_response"}}},"description":"Update multiple GRE tunnels response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/modified_tunnels_collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update multiple GRE tunnels response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update multiple GRE tunnels","tags":["Magic GRE tunnels"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/magic/gre_tunnels/{tunnel_identifier}":{"delete":{"description":"Disables and removes a specific static GRE tunnel. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.","operationId":"magic-gre-tunnels-delete-gre-tunnel","parameters":[{"in":"path","name":"tunnel_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_deleted_response"}}},"description":"Delete GRE Tunnel response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_deleted_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete GRE Tunnel response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete GRE Tunnel","tags":["Magic GRE tunnels"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Lists informtion for a specific GRE tunnel.","operationId":"magic-gre-tunnels-list-gre-tunnel-details","parameters":[{"in":"path","name":"tunnel_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_single_response"}}},"description":"List GRE Tunnel Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List GRE Tunnel Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List GRE Tunnel Details","tags":["Magic GRE tunnels"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Updates a specific GRE tunnel. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.","operationId":"magic-gre-tunnels-update-gre-tunnel","parameters":[{"in":"path","name":"tunnel_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_update_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_modified_response"}}},"description":"Update GRE Tunnel response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_modified_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update GRE Tunnel response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update GRE Tunnel","tags":["Magic GRE tunnels"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/magic/ipsec_tunnels":{"get":{"description":"Lists IPsec tunnels associated with an account.","operationId":"magic-i-psec-tunnels-list-i-psec-tunnels","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-tunnels_collection_response"}}},"description":"List IPsec tunnels response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-tunnels_collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List IPsec tunnels response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List IPsec tunnels","tags":["Magic IPsec tunnels"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Creates new IPsec tunnels associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.","operationId":"magic-i-psec-tunnels-create-i-psec-tunnels","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["name","customer_ipsec_endpoint","cloudflare_ipsec_endpoint","interface_address"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-tunnels_collection_response"}}},"description":"Create IPsec tunnels response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-tunnels_collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create IPsec tunnels response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create IPsec tunnels","tags":["Magic IPsec tunnels"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Update multiple IPsec tunnels associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.","operationId":"magic-i-psec-tunnels-update-multiple-i-psec-tunnels","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["id"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-modified_tunnels_collection_response"}}},"description":"Update multiple IPsec tunnels response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-modified_tunnels_collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update multiple IPsec tunnels response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update multiple IPsec tunnels","tags":["Magic IPsec tunnels"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/magic/ipsec_tunnels/{tunnel_identifier}":{"delete":{"description":"Disables and removes a specific static IPsec Tunnel associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.","operationId":"magic-i-psec-tunnels-delete-i-psec-tunnel","parameters":[{"in":"path","name":"tunnel_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-tunnel_deleted_response"}}},"description":"Delete IPsec Tunnel response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-tunnel_deleted_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete IPsec Tunnel response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete IPsec Tunnel","tags":["Magic IPsec tunnels"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Lists details for a specific IPsec tunnel.","operationId":"magic-i-psec-tunnels-list-i-psec-tunnel-details","parameters":[{"in":"path","name":"tunnel_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-tunnel_single_response"}}},"description":"List IPsec tunnel details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-tunnel_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List IPsec tunnel details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List IPsec tunnel details","tags":["Magic IPsec tunnels"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Updates a specific IPsec tunnel associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.","operationId":"magic-i-psec-tunnels-update-i-psec-tunnel","parameters":[{"in":"path","name":"tunnel_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-tunnel_update_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-tunnel_modified_response"}}},"description":"Update IPsec Tunnel response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-tunnel_modified_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update IPsec Tunnel response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update IPsec Tunnel","tags":["Magic IPsec tunnels"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/magic/ipsec_tunnels/{tunnel_identifier}/psk_generate":{"post":{"description":"Generates a Pre Shared Key for a specific IPsec tunnel used in the IKE session. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. After a PSK is generated, the PSK is immediately persisted to Cloudflare's edge and cannot be retrieved later. Note the PSK in a safe place.","operationId":"magic-i-psec-tunnels-generate-pre-shared-key-(-psk)-for-i-psec-tunnels","parameters":[{"in":"path","name":"tunnel_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/psk_generation_response"}}},"description":"Generate Pre Shared Key (PSK) for IPsec tunnels response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/psk_generation_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Generate Pre Shared Key (PSK) for IPsec tunnels response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Generate Pre Shared Key (PSK) for IPsec tunnels","tags":["Magic IPsec tunnels"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/magic/routes":{"delete":{"description":"Delete multiple Magic static routes.","operationId":"magic-static-routes-delete-many-routes","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/route_delete_many_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/multiple_route_delete_response"}}},"description":"Delete Many Routes response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/multiple_route_delete_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Many Routes response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Many Routes","tags":["Magic Static Routes"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"List all Magic static routes.","operationId":"magic-static-routes-list-routes","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/routes_collection_response"}}},"description":"List Routes response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/routes_collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Routes response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Routes","tags":["Magic Static Routes"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Creates a new Magic static route. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes.","operationId":"magic-static-routes-create-routes","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["prefix","nexthop","priority"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/routes_collection_response"}}},"description":"Create Routes response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/routes_collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Routes response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Routes","tags":["Magic Static Routes"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Update multiple Magic static routes. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes. Only fields for a route that need to be changed need be provided.","operationId":"magic-static-routes-update-many-routes","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/route_update_many_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/multiple_route_modified_response"}}},"description":"Update Many Routes response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/multiple_route_modified_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Many Routes response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Many Routes","tags":["Magic Static Routes"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/magic/routes/{route_identifier}":{"delete":{"description":"Disable and remove a specific Magic static route.","operationId":"magic-static-routes-delete-route","parameters":[{"in":"path","name":"route_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/route_deleted_response"}}},"description":"Delete Route response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/route_deleted_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Route response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Route","tags":["Magic Static Routes"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Get a specific Magic static route.","operationId":"magic-static-routes-route-details","parameters":[{"in":"path","name":"route_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/route_single_response"}}},"description":"Route Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/route_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Route Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Route Details","tags":["Magic Static Routes"],"x-cfPermissionsRequired":{"enum":["#organization:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Update a specific Magic static route. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes.","operationId":"magic-static-routes-update-route","parameters":[{"in":"path","name":"route_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-5dNKLCP5"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/route_update_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/route_modified_response"}}},"description":"Update Route response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/route_modified_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Route response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Route","tags":["Magic Static Routes"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/members":{"get":{"description":"List all members of an account.","operationId":"account-members-list-members","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-D3Kod1Eh"}},{"in":"query","name":"order","schema":{"description":"Field to order results by.","enum":["user.first_name","user.last_name","user.email","status"],"example":"status"}},{"in":"query","name":"status","schema":{"description":"A member's status in the account.","enum":["accepted","pending","rejected"],"example":"accepted","type":"string"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Maximum number of results per page.","maximum":50,"minimum":5,"type":"number"}},{"in":"query","name":"direction","schema":{"description":"Direction to order results.","enum":["asc","desc"],"example":"desc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_collection-NcnbjEgN"}}},"description":"List Members response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_collection-NcnbjEgN"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Members response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Members","tags":["Account Members"],"x-cfPermissionsRequired":{"enum":["#organization:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Add a user to the list of members for this account.","operationId":"account-members-add-member","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-D3Kod1Eh"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_single"}}},"description":"Add Member response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Add Member response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Add Member","tags":["Account Members"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_identifier}/members/{identifier}":{"delete":{"description":"Remove a member from an account.","operationId":"account-members-remove-member","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier-3n9sRq0H"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-D3Kod1Eh"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single-id-u7jsvBJu"}}},"description":"Remove Member response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single-id-u7jsvBJu"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Remove Member response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Remove Member","tags":["Account Members"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Get information about a specific member of an account.","operationId":"account-members-member-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier-3n9sRq0H"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-D3Kod1Eh"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_single"}}},"description":"Member Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Member Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Member Details","tags":["Account Members"],"x-cfPermissionsRequired":{"enum":["#organization:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Modify an account member.","operationId":"account-members-update-member","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier-3n9sRq0H"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-D3Kod1Eh"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-member"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_single"}}},"description":"Update Member response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Member response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Member","tags":["Account Members"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_identifier}/mnm/config":{"delete":{"description":"Delete an existing network monitoring configuration.","operationId":"magic-network-monitoring-configuration-delete-account-configuration","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/config_components-schemas-account_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mnm_config_single_response"}}},"description":"Delete account configuration response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mnm_config_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete account configuration response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete account configuration","tags":["Magic Network Monitoring Configuration"]},"get":{"description":"Lists default sampling and router IPs for account.","operationId":"magic-network-monitoring-configuration-list-account-configuration","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/config_components-schemas-account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mnm_config_single_response"}}},"description":"List account configuration response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mnm_config_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List account configuration response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List account configuration","tags":["Magic Network Monitoring Configuration"]},"patch":{"description":"Update fields in an existing network monitoring configuration.","operationId":"magic-network-monitoring-configuration-update-account-configuration-fields","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/config_components-schemas-account_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mnm_config_single_response"}}},"description":"Update account configuration fields response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mnm_config_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update account configuration fields response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update account configuration fields","tags":["Magic Network Monitoring Configuration"]},"post":{"description":"Create a new network monitoring configuration.","operationId":"magic-network-monitoring-configuration-create-account-configuration","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/config_components-schemas-account_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mnm_config_single_response"}}},"description":"Create account configuration response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mnm_config_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create account configuration response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create account configuration","tags":["Magic Network Monitoring Configuration"]},"put":{"description":"Update an existing network monitoring configuration, requires the entire configuration to be updated at once.","operationId":"magic-network-monitoring-configuration-update-an-entire-account-configuration","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/config_components-schemas-account_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mnm_config_single_response"}}},"description":"Update an entire account configuration response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mnm_config_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update an entire account configuration response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update an entire account configuration","tags":["Magic Network Monitoring Configuration"]}},"/accounts/{account_identifier}/mnm/config/full":{"get":{"description":"Lists default sampling, router IPs, and rules for account.","operationId":"magic-network-monitoring-configuration-list-rules-and-account-configuration","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/config_components-schemas-account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mnm_config_single_response"}}},"description":"List rules and account configuration response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mnm_config_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List rules and account configuration response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List rules and account configuration","tags":["Magic Network Monitoring Configuration"]}},"/accounts/{account_identifier}/mnm/rules":{"get":{"description":"Lists network monitoring rules for account.","operationId":"magic-network-monitoring-rules-list-rules","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/rules_components-schemas-account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mnm_rules_collection_response"}}},"description":"List rules response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mnm_rules_collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List rules response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List rules","tags":["Magic Network Monitoring Rules"]},"post":{"description":"Create network monitoring rules for account.","operationId":"magic-network-monitoring-rules-create-rules","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/rules_components-schemas-account_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mnm_rules_single_response"}}},"description":"Create rules response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mnm_rules_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create rules response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create rules","tags":["Magic Network Monitoring Rules"]},"put":{"description":"Update network monitoring rules for account.","operationId":"magic-network-monitoring-rules-update-rules","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/rules_components-schemas-account_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mnm_rules_single_response"}}},"description":"Update rules response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mnm_rules_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update rules response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update rules","tags":["Magic Network Monitoring Rules"]}},"/accounts/{account_identifier}/mnm/rules/{rule_identifier}":{"delete":{"description":"Delete a network monitoring rule for account.","operationId":"magic-network-monitoring-rules-delete-rule","parameters":[{"in":"path","name":"rule_identifier","required":true,"schema":{"$ref":"#/components/schemas/rule_identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/rules_components-schemas-account_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mnm_rules_single_response"}}},"description":"Delete rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mnm_rules_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete rule","tags":["Magic Network Monitoring Rules"]},"get":{"description":"List a single network monitoring rule for account.","operationId":"magic-network-monitoring-rules-get-rule","parameters":[{"in":"path","name":"rule_identifier","required":true,"schema":{"$ref":"#/components/schemas/rule_identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/rules_components-schemas-account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mnm_rules_single_response"}}},"description":"Get rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mnm_rules_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get rule","tags":["Magic Network Monitoring Rules"]},"patch":{"description":"Update a network monitoring rule for account.","operationId":"magic-network-monitoring-rules-update-rule","parameters":[{"in":"path","name":"rule_identifier","required":true,"schema":{"$ref":"#/components/schemas/rule_identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/rules_components-schemas-account_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mnm_rules_single_response"}}},"description":"Update rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mnm_rules_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update rule","tags":["Magic Network Monitoring Rules"]}},"/accounts/{account_identifier}/mnm/rules/{rule_identifier}/advertisement":{"patch":{"description":"Update advertisement for rule.","operationId":"magic-network-monitoring-rules-update-advertisement-for-rule","parameters":[{"in":"path","name":"rule_identifier","required":true,"schema":{"$ref":"#/components/schemas/rule_identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/rules_components-schemas-account_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mnm_rule_advertisement_single_response"}}},"description":"Update advertisement for rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mnm_rule_advertisement_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update advertisement for rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update advertisement for rule","tags":["Magic Network Monitoring Rules"]}},"/accounts/{account_identifier}/mtls_certificates":{"get":{"description":"Lists all mTLS certificates.","operationId":"m-tls-certificate-management-list-m-tls-certificates","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mtls-management_components-schemas-certificate_response_collection"}}},"description":"List mTLS certificates response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mtls-management_components-schemas-certificate_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List mTLS certificates response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List mTLS certificates","tags":["mTLS Certificate Management"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Upload a certificate that you want to use with mTLS-enabled Cloudflare services.","operationId":"m-tls-certificate-management-upload-m-tls-certificate","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"ca":{"$ref":"#/components/schemas/ca"},"certificates":{"$ref":"#/components/schemas/schemas-certificates"},"name":{"$ref":"#/components/schemas/mtls-management_components-schemas-name"},"private_key":{"$ref":"#/components/schemas/components-schemas-private_key"}},"required":["certificates","private_key","ca"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificate_response_single_post"}}},"description":"Upload mTLS certificate response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificate_response_single_post"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Upload mTLS certificate response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Upload mTLS certificate","tags":["mTLS Certificate Management"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_identifier}/mtls_certificates/{identifier}":{"delete":{"description":"Deletes the mTLS certificate unless the certificate is in use by one or more Cloudflare services.","operationId":"m-tls-certificate-management-delete-m-tls-certificate","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/mtls-management_components-schemas-identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mtls-management_components-schemas-certificate_response_single"}}},"description":"Delete mTLS certificate response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mtls-management_components-schemas-certificate_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete mTLS certificate response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete mTLS certificate","tags":["mTLS Certificate Management"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Fetches a single mTLS certificate.","operationId":"m-tls-certificate-management-get-m-tls-certificate","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/mtls-management_components-schemas-identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/mtls-management_components-schemas-certificate_response_single"}}},"description":"Get mTLS certificate response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/mtls-management_components-schemas-certificate_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get mTLS certificate response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get mTLS certificate","tags":["mTLS Certificate Management"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_identifier}/mtls_certificates/{identifier}/associations":{"get":{"description":"Lists all active associations between the certificate and Cloudflare services.","operationId":"m-tls-certificate-management-list-m-tls-certificate-associations","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/mtls-management_components-schemas-identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/association_response_collection"}}},"description":"List mTLS certificate associations response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/association_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List mTLS certificate associations response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List mTLS certificate associations","tags":["mTLS Certificate Management"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_identifier}/pages/projects":{"get":{"description":"Fetch a list of all user projects.","operationId":"pages-project-get-projects","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-g7jwPNXP"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/projects-response"}}},"description":"Get projects response."},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/projects-response"},{"$ref":"#/components/schemas/api-response-common-failure-C6O0X824"}]}}},"description":"Get projects response failure."}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get projects","tags":["Pages Project"]},"post":{"description":"Create a new project.","operationId":"pages-project-create-project","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-g7jwPNXP"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/projects"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/new-project-response"}}},"description":"Create project response."},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/new-project-response"},{"$ref":"#/components/schemas/api-response-common-failure-C6O0X824"}]}}},"description":"Create project response failure."}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create project","tags":["Pages Project"]}},"/accounts/{account_identifier}/pages/projects/{project_name}":{"delete":{"description":"Delete a project by name.","operationId":"pages-project-delete-project","parameters":[{"in":"path","name":"project_name","required":true,"schema":{"$ref":"#/components/schemas/project_name"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-g7jwPNXP"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"example":{"errors":[],"messages":[],"result":null,"success":true}}}},"description":"Delete project response."},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"example":{"errors":[],"messages":[],"result":null,"success":true}},{"$ref":"#/components/schemas/api-response-common-failure-C6O0X824"}]}}},"description":"Delete project response failure."}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete project","tags":["Pages Project"]},"get":{"description":"Fetch a project by name.","operationId":"pages-project-get-project","parameters":[{"in":"path","name":"project_name","required":true,"schema":{"$ref":"#/components/schemas/project_name"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-g7jwPNXP"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/project-response"}}},"description":"Get project response."},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/project-response"},{"$ref":"#/components/schemas/api-response-common-failure-C6O0X824"}]}}},"description":"Get project response failure."}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get project","tags":["Pages Project"]},"patch":{"description":"Set new attributes for an existing project. Modify environment variables. To delete an environment variable, set the key to null.","operationId":"pages-project-update-project","parameters":[{"in":"path","name":"project_name","required":true,"schema":{"$ref":"#/components/schemas/project_name"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-g7jwPNXP"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/project-patch"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/new-project-response"}}},"description":"Update project response."},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/new-project-response"},{"$ref":"#/components/schemas/api-response-common-failure-C6O0X824"}]}}},"description":"Update project response failure."}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update project","tags":["Pages Project"]}},"/accounts/{account_identifier}/pages/projects/{project_name}/deployments":{"get":{"description":"Fetch a list of project deployments.","operationId":"pages-deployment-get-deployments","parameters":[{"in":"path","name":"project_name","required":true,"schema":{"$ref":"#/components/schemas/project_name"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-g7jwPNXP"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deployment-list-response"}}},"description":"Get deployments response."},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/deployment-list-response"},{"$ref":"#/components/schemas/api-response-common-failure-C6O0X824"}]}}},"description":"Get deployments response failure."}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get deployments","tags":["Pages Deployment"]},"post":{"description":"Start a new deployment from production. The repository and account must have already been authorized on the Cloudflare Pages dashboard.","operationId":"pages-deployment-create-deployment","parameters":[{"in":"path","name":"project_name","required":true,"schema":{"$ref":"#/components/schemas/project_name"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-g7jwPNXP"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"branch":{"description":"The branch to build the new deployment from. The `HEAD` of the branch will be used. If omitted, the production branch will be used by default.","example":"staging","type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deployment-new-deployment"}}},"description":"Create deployment response."},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/deployment-new-deployment"},{"$ref":"#/components/schemas/api-response-common-failure-C6O0X824"}]}}},"description":"Create deployment response failure."}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create deployment","tags":["Pages Deployment"]}},"/accounts/{account_identifier}/pages/projects/{project_name}/deployments/{deployment_identifier}":{"delete":{"description":"Delete a deployment.","operationId":"pages-deployment-delete-deployment","parameters":[{"in":"path","name":"deployment_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-g7jwPNXP"}},{"in":"path","name":"project_name","required":true,"schema":{"$ref":"#/components/schemas/project_name"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-g7jwPNXP"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"example":{"errors":[],"messages":[],"result":null,"success":true}}}},"description":"Delete deployment response."},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"example":{"errors":[],"messages":[],"result":null,"success":true}},{"$ref":"#/components/schemas/api-response-common-failure-C6O0X824"}]}}},"description":"Delete deployment response failure."}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete deployment","tags":["Pages Deployment"]},"get":{"description":"Fetch information about a deployment.","operationId":"pages-deployment-get-deployment-info","parameters":[{"in":"path","name":"deployment_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-g7jwPNXP"}},{"in":"path","name":"project_name","required":true,"schema":{"$ref":"#/components/schemas/project_name"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-g7jwPNXP"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deployment-response-details"}}},"description":"Get deployment info response."},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/deployment-response-details"},{"$ref":"#/components/schemas/api-response-common-failure-C6O0X824"}]}}},"description":"Get deployment info response failure."}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get deployment info","tags":["Pages Deployment"]}},"/accounts/{account_identifier}/pages/projects/{project_name}/deployments/{deployment_identifier}/history/logs":{"get":{"description":"Fetch deployment logs for a project.","operationId":"pages-deployment-get-deployment-logs","parameters":[{"in":"path","name":"deployment_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-g7jwPNXP"}},{"in":"path","name":"project_name","required":true,"schema":{"$ref":"#/components/schemas/project_name"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-g7jwPNXP"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deployment-response-logs"}}},"description":"Get deployment logs response."},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/deployment-response-logs"},{"$ref":"#/components/schemas/api-response-common-failure-C6O0X824"}]}}},"description":"Get deployment logs response failure."}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get deployment logs","tags":["Pages Deployment"]}},"/accounts/{account_identifier}/pages/projects/{project_name}/deployments/{deployment_identifier}/retry":{"post":{"description":"Retry a previous deployment.","operationId":"pages-deployment-retry-deployment","parameters":[{"in":"path","name":"deployment_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-g7jwPNXP"}},{"in":"path","name":"project_name","required":true,"schema":{"$ref":"#/components/schemas/project_name"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-g7jwPNXP"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deployment-new-deployment"}}},"description":"Retry deployment response."},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/deployment-new-deployment"},{"$ref":"#/components/schemas/api-response-common-failure-C6O0X824"}]}}},"description":"Retry deployment response failure."}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Retry deployment","tags":["Pages Deployment"]}},"/accounts/{account_identifier}/pages/projects/{project_name}/deployments/{deployment_identifier}/rollback":{"post":{"description":"Rollback the production deployment to a previous deployment. You can only rollback to succesful builds on production.","operationId":"pages-deployment-rollback-deployment","parameters":[{"in":"path","name":"deployment_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-g7jwPNXP"}},{"in":"path","name":"project_name","required":true,"schema":{"$ref":"#/components/schemas/project_name"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-g7jwPNXP"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deployment-response-details"}}},"description":"Rollback deployment response."},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/deployment-response-details"},{"$ref":"#/components/schemas/api-response-common-failure-C6O0X824"}]}}},"description":"Rollback deployment response failure."}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Rollback deployment","tags":["Pages Deployment"]}},"/accounts/{account_identifier}/pages/projects/{project_name}/domains":{"get":{"description":"Fetch a list of all domains associated with a Pages project.","operationId":"pages-domains-get-domains","parameters":[{"in":"path","name":"project_name","required":true,"schema":{"$ref":"#/components/schemas/project_name"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-g7jwPNXP"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain-response-collection"}}},"description":"Get domains response."},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/domain-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure-C6O0X824"}]}}},"description":"Get domains response failure."}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get domains","tags":["Pages Domains"]},"post":{"description":"Add a new domain for the Pages project.","operationId":"pages-domains-add-domain","parameters":[{"in":"path","name":"project_name","required":true,"schema":{"$ref":"#/components/schemas/project_name"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-g7jwPNXP"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/domains-post"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain-response-single"}}},"description":"Add domain response."},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/domain-response-single"},{"$ref":"#/components/schemas/api-response-common-failure-C6O0X824"}]}}},"description":"Add domain response failure."}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Add domain","tags":["Pages Domains"]}},"/accounts/{account_identifier}/pages/projects/{project_name}/domains/{domain_name}":{"delete":{"description":"Delete a Pages project's domain.","operationId":"pages-domains-delete-domain","parameters":[{"in":"path","name":"domain_name","required":true,"schema":{"$ref":"#/components/schemas/domain_name"}},{"in":"path","name":"project_name","required":true,"schema":{"$ref":"#/components/schemas/project_name"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-g7jwPNXP"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"example":{"errors":[],"messages":[],"result":null,"success":true}}}},"description":"Delete domain response."},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"example":{"errors":[],"messages":[],"result":null,"success":true}},{"$ref":"#/components/schemas/api-response-common-failure-C6O0X824"}]}}},"description":"Delete domain response failure."}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete domain","tags":["Pages Domains"]},"get":{"description":"Fetch a single domain.","operationId":"pages-domains-get-domain","parameters":[{"in":"path","name":"domain_name","required":true,"schema":{"$ref":"#/components/schemas/domain_name"}},{"in":"path","name":"project_name","required":true,"schema":{"$ref":"#/components/schemas/project_name"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-g7jwPNXP"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain-response-single"}}},"description":"Get domain response."},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/domain-response-single"},{"$ref":"#/components/schemas/api-response-common-failure-C6O0X824"}]}}},"description":"Get domain response failure."}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get domain","tags":["Pages Domains"]},"patch":{"description":"Retry the validation status of a single domain.","operationId":"pages-domains-patch-domain","parameters":[{"in":"path","name":"domain_name","required":true,"schema":{"$ref":"#/components/schemas/domain_name"}},{"in":"path","name":"project_name","required":true,"schema":{"$ref":"#/components/schemas/project_name"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-g7jwPNXP"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain-response-single"}}},"description":"Patch domain response."},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/domain-response-single"},{"$ref":"#/components/schemas/api-response-common-failure-C6O0X824"}]}}},"description":"Patch domain response failure."}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Patch domain","tags":["Pages Domains"]}},"/accounts/{account_identifier}/pcaps":{"get":{"description":"Lists all packet capture requests for an account.","operationId":"magic-pcap-collection-list-packet-capture-requests","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pcaps_collection_response"}}},"description":"List packet capture requests response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pcaps_collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List packet capture requests response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List packet capture requests","tags":["Magic PCAP collection"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Create new PCAP request for account.","operationId":"magic-pcap-collection-create-pcap-request","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pcaps_request_pcap"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pcaps_single_response"}}},"description":"Create PCAP request response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pcaps_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create PCAP request response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create PCAP request","tags":["Magic PCAP collection"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/pcaps/ownership":{"get":{"description":"List all buckets configured for use with PCAPs API.","operationId":"magic-pcap-collection-list-pca-ps-bucket-ownership","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pcaps_ownership_collection"}}},"description":"List PCAPs Bucket Ownership response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pcaps_ownership_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List PCAPs Bucket Ownership response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List PCAPs Bucket Ownership","tags":["Magic PCAP collection"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Adds an AWS or GCP bucket to use with full packet captures.","operationId":"magic-pcap-collection-add-buckets-for-full-packet-captures","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pcaps_ownership_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pcaps_ownership_single_response"}}},"description":"Add buckets for full packet captures response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pcaps_ownership_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Add buckets for full packet captures response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Add buckets for full packet captures","tags":["Magic PCAP collection"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/pcaps/ownership/validate":{"post":{"description":"Validates buckets added to the packet captures API.","operationId":"magic-pcap-collection-validate-buckets-for-full-packet-captures","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pcaps_ownership_validate_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pcaps_ownership_single_response"}}},"description":"Validate buckets for full packet captures response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pcaps_ownership_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Validate buckets for full packet captures response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Validate buckets for full packet captures","tags":["Magic PCAP collection"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/pcaps/ownership/{identifier}":{"delete":{"description":"Deletes buckets added to the packet captures API.","operationId":"magic-pcap-collection-delete-buckets-for-full-packet-captures","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{}},"description":"Delete buckets for full packet captures response"},"4xx":{"content":{"application/json":{}},"description":"Delete buckets for full packet captures response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete buckets for full packet captures","tags":["Magic PCAP collection"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/pcaps/{identifier}":{"get":{"description":"Get information for a PCAP request by id.","operationId":"magic-pcap-collection-get-pcap-request","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pcaps_single_response"}}},"description":"Get PCAP request response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pcaps_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get PCAP request response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get PCAP request","tags":["Magic PCAP collection"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/pcaps/{identifier}/download":{"get":{"description":"Download PCAP information into a file. Response is a binary PCAP file.","operationId":"magic-pcap-collection-download-simple-pcap","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{}},"description":"Download Simple PCAP response"},"4xx":{"content":{"application/json":{}},"description":"Download Simple PCAP response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Download Simple PCAP","tags":["Magic PCAP collection"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/r2/buckets":{"get":{"description":"Lists all R2 buckets on your account","operationId":"r-2-bucket-list-buckets","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"name_contains","schema":{"description":"Bucket names to filter by. Only buckets with this phrase in their name will be returned.","example":"my-bucket","type":"string"}},{"in":"query","name":"start_after","schema":{"description":"Bucket name to start searching after. Buckets are ordered lexicographically.","example":"my-bucket","type":"string"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Maximum number of buckets to return in a single call","maximum":1000,"minimum":1,"type":"number"}},{"in":"query","name":"order","schema":{"description":"Field to order buckets by","enum":["name"],"type":"string"}},{"in":"query","name":"direction","schema":{"description":"Direction to order buckets","enum":["asc","desc"],"example":"desc","type":"string"}},{"in":"query","name":"cursor","schema":{"description":"Pagination cursor received during the last List Buckets call. R2 buckets are paginated using cursors instead of page numbers.","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-single-bucket-operation-response"}}},"description":"List Buckets response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2-single-bucket-operation-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Buckets response failure"}},"security":[{"api_token":[]}],"summary":"List Buckets","tags":["R2 Bucket"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.r2.bucket.list"]}},"post":{"description":"Creates a new R2 bucket.","operationId":"r-2-bucket-create-bucket","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"example":"{'name': 'example-bucket'}"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-single-bucket-operation-response"}}},"description":"Create Bucket response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2-single-bucket-operation-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Bucket response failure"}},"security":[{"api_token":[]}],"summary":"Create Bucket","tags":["R2 Bucket"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.r2.bucket.create"]}}},"/accounts/{account_identifier}/r2/buckets/{bucket_name}":{"delete":{"description":"Deletes an existing R2 bucket.","operationId":"r-2-bucket-delete-bucket","parameters":[{"in":"path","name":"bucket_name","required":true,"schema":{"$ref":"#/components/schemas/bucket_name"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/r2-single-bucket-operation-response"}}},"description":"Delete Bucket response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/r2-single-bucket-operation-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Bucket response failure"}},"security":[{"api_token":[]}],"summary":"Delete Bucket","tags":["R2 Bucket"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.r2.bucket.delete"]}}},"/accounts/{account_identifier}/railguns":{"get":{"description":"List, search, sort and filter your Railguns.","operationId":"account-railguns-list-railguns","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Number of items per page.","maximum":50,"minimum":5,"type":"number"}},{"in":"query","name":"direction","schema":{"description":"Sort Railguns in ascending or descending order.","enum":["asc","desc"],"example":"desc"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/railgun_response_collection"}}},"description":"List Railguns response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/railgun_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Railguns response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Railguns","tags":["Account Railguns"],"x-cfPermissionsRequired":{"enum":["#organization:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"post":{"operationId":"account-railguns-create-railgun","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"$ref":"#/components/schemas/railgun_components-schemas-name"}},"required":["name"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/railgun_response_single"}}},"description":"Create Railgun response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/railgun_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Railgun response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Railgun","tags":["Account Railguns"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/railguns/{identifier}":{"delete":{"description":"Disable and delete a Railgun. This will immediately disable the Railgun for any connected zones.","operationId":"account-railguns-delete-a-railgun","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/railgun_response_single_id"}}},"description":"Delete a Railgun response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/railgun_response_single_id"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete a Railgun response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete a Railgun","tags":["Account Railguns"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"get":{"operationId":"account-railguns-railgun-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/railgun_response_single"}}},"description":"Railgun details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/railgun_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Railgun details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Railgun details","tags":["Account Railguns"],"x-cfPermissionsRequired":{"enum":["#organization:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Update a Railgun.","operationId":"account-railguns-update-railgun","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-railgun"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/railgun_response_single"}}},"description":"Update Railgun response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/railgun_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Railgun response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Railgun","tags":["Account Railguns"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/railguns/{railgun_identifier}/connections":{"get":{"description":"List connections associated with the Railgun.","operationId":"railgun-connections-list-connections","parameters":[{"in":"path","name":"railgun_identifier","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"enabled","schema":{"$ref":"#/components/schemas/connection_components-schemas-enabled"}},{"in":"query","name":"page","schema":{"description":"Requested page within paginated list of results.","example":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"description":"Maximum number of results requested.","example":20,"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/connection_collection_response"}}},"description":"List Connections response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/connection_collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Connections response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Connections","tags":["Railgun Connections"],"x-cfPermissionsRequired":{"enum":["#organization:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Associates a zone to the Railgun.","operationId":"railgun-connections-create-connection","parameters":[{"in":"path","name":"railgun_identifier","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/connection_single_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/connection_single_response"}}},"description":"Create connection response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/connection_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create connection response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create connection","tags":["Railgun Connections"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/railguns/{railgun_identifier}/connections/{identifier}":{"delete":{"description":"Disable and remove the connection to a zone.","operationId":"railgun-connections-delete-connection","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/connection_components-schemas-identifier"}},{"in":"path","name":"railgun_identifier","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/connection_single_id_response"}}},"description":"Delete connection response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/connection_single_id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete connection response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete connection","tags":["Railgun Connections"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Get a connection by ID.","operationId":"railgun-connections-connection-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/connection_components-schemas-identifier"}},{"in":"path","name":"railgun_identifier","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/connection_single_response"}}},"description":"Connection details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/connection_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Connection details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Connection details","tags":["Railgun Connections"],"x-cfPermissionsRequired":{"enum":["#organization:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Enable or disable a connection.","operationId":"railgun-connections-update-connection","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/connection_components-schemas-identifier"}},{"in":"path","name":"railgun_identifier","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/connection-Xm0br0wV"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/connection_single_response"}}},"description":"Update connection response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/connection_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update connection response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update connection","tags":["Railgun Connections"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/registrar/domains":{"post":{"description":"List domains handled by Registrar.","operationId":"registrar-domains-list-domains","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"id":{"$ref":"#/components/schemas/domain_names"}},"required":["id"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain_response_collection"}}},"description":"List domains response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/domain_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List domains response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List domains","tags":["Registrar Domains"]}},"/accounts/{account_identifier}/registrar/domains/{domain_name}":{"get":{"description":"Show individual domain.","operationId":"registrar-domains-get-domain","parameters":[{"in":"path","name":"domain_name","required":true,"schema":{"$ref":"#/components/schemas/domain_name-lovco9gj"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain_response_single"}}},"description":"Get domain response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/domain_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get domain response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get domain","tags":["Registrar Domains"]},"put":{"description":"Update individual domain.","operationId":"registrar-domains-update-domain","parameters":[{"in":"path","name":"domain_name","required":true,"schema":{"$ref":"#/components/schemas/domain_name-lovco9gj"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/domain_update_properties"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain_response_single"}}},"description":"Update domain response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/domain_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update domain response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update domain","tags":["Registrar Domains"]}},"/accounts/{account_identifier}/request-tracer/trace":{"post":{"operationId":"account-request-tracer-request-trace","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-gI2sCanq"}}],"requestBody":{"content":{"application/json":{"example":{"body":{"base64":"c29tZV9yZXF1ZXN0X2JvZHk="},"context":{"geoloc":{"city":"London"},"skip_challenge":true},"cookies":{"cookie_name_1":"cookie_value_1","cookie_name_2":"cookie_value_2"},"headers":{"header_name_1":"header_value_1","header_name_2":"header_value_2"},"method":"PUT","protocol":"HTTP/1.1","url":"https://some.zone/some_path"},"schema":{"properties":{"body":{"properties":{"base64":{"description":"Base64 encoded request body","example":"c29tZV9yZXF1ZXN0X2JvZHk=","type":"string"},"json":{"description":"Arbitrary json as request body","type":"object"},"plain_text":{"description":"Request body as plain text","type":"string"}},"type":"object"},"context":{"description":"Additional request parameters","properties":{"bot_score":{"description":"Bot score used for evaluating tracing request processing","type":"integer"},"geoloc":{"description":"Geodata for tracing request","properties":{"city":{"example":"London","type":"string"},"continent":{"type":"string"},"is_eu_country":{"type":"boolean"},"iso_code":{"type":"string"},"latitude":{"type":"number"},"longitude":{"type":"number"},"postal_code":{"type":"string"},"region_code":{"type":"string"},"subdivision_2_iso_code":{"type":"string"},"timezone":{"type":"string"}},"type":"object"},"skip_challenge":{"description":"Whether to skip any challenges for tracing request (e.g.: captcha)","example":true,"type":"boolean"},"threat_score":{"description":"Threat score used for evaluating tracing request processing","type":"integer"}},"type":"object"},"cookies":{"additionalProperties":{"type":"string"},"description":"Cookies added to tracing request","example":{"cookie_name_1":"cookie_value_1","cookie_name_2":"cookie_value_2"},"type":"object"},"headers":{"additionalProperties":{"type":"string"},"description":"Headers added to tracing request","example":{"header_name_1":"header_value_1","header_name_2":"header_value_2"},"type":"object"},"method":{"description":"HTTP Method of tracing request","example":"PUT","type":"string"},"protocol":{"description":"HTTP Protocol of tracing request","example":"HTTP/1.1","type":"string"},"skip_response":{"description":"Skip sending the request to the Origin server after all rules evaluation","type":"boolean"},"url":{"description":"URL to which perform tracing request","example":"https://some.zone/some_path","type":"string"}},"required":["url","method"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"description":"Trace result with an origin status code","properties":{"status_code":{"description":"HTTP Status code of zone response","type":"integer"},"trace":{"$ref":"#/components/schemas/trace"}},"type":"object"}},"type":"object"}],"type":"object"}}},"description":"Request Trace response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Request Trace response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Request Trace","tags":["Account Request Tracer"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_identifier}/roles":{"get":{"description":"Get all available roles for an account.","operationId":"account-roles-list-roles","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-D3Kod1Eh"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_collection-NcnbjEgN"}}},"description":"List Roles response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_collection-NcnbjEgN"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Roles response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Roles","tags":["Account Roles"],"x-cfPermissionsRequired":{"enum":["#organization:read"]}}},"/accounts/{account_identifier}/roles/{identifier}":{"get":{"description":"Get information about a specific role for an account.","operationId":"account-roles-role-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier-3n9sRq0H"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-D3Kod1Eh"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_single"}}},"description":"Role Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Role Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Role Details","tags":["Account Roles"],"x-cfPermissionsRequired":{"enum":["#organization:read"]}}},"/accounts/{account_identifier}/rules/lists":{"get":{"description":"Fetches all lists in the account.","operationId":"lists-get-lists","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists-response-collection"}}},"description":"Get lists response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/lists-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get lists response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get lists","tags":["Lists"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Creates a new list of the specified type.","operationId":"lists-create-a-list","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"description":{"$ref":"#/components/schemas/lists_components-schemas-description"},"kind":{"$ref":"#/components/schemas/kind-ZDHCkJmG"},"name":{"$ref":"#/components/schemas/lists_components-schemas-name"}},"required":["name","kind"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/list-response-collection"}}},"description":"Create a list response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/list-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create a list response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create a list","tags":["Lists"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_identifier}/rules/lists/bulk_operations/{operation_id}":{"get":{"description":"Gets the current status of an asynchronous operation on a list.\n\nThe `status` property can have one of the following values: `pending`, `running`, `completed`, or `failed`. If the status is `failed`, the `error` property will contain a message describing the error.","operationId":"lists-get-bulk-operation-status","parameters":[{"in":"path","name":"operation_id","required":true,"schema":{"$ref":"#/components/schemas/operation_id"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulk-operation-response-collection"}}},"description":"Get bulk operation status response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/bulk-operation-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get bulk operation status response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get bulk operation status","tags":["Lists"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_identifier}/rules/lists/{list_id}":{"delete":{"description":"Deletes a specific list and all its items.","operationId":"lists-delete-a-list","parameters":[{"in":"path","name":"list_id","required":true,"schema":{"$ref":"#/components/schemas/list_id"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/list-delete-response-collection"}}},"description":"Delete a list response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/list-delete-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete a list response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete a list","tags":["Lists"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Fetches the details of a list.","operationId":"lists-get-a-list","parameters":[{"in":"path","name":"list_id","required":true,"schema":{"$ref":"#/components/schemas/list_id"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/list-response-collection"}}},"description":"Get a list response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/list-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get a list response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a list","tags":["Lists"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Updates the description of a list.","operationId":"lists-update-a-list","parameters":[{"in":"path","name":"list_id","required":true,"schema":{"$ref":"#/components/schemas/list_id"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"description":{"$ref":"#/components/schemas/lists_components-schemas-description"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/list-response-collection"}}},"description":"Update a list response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/list-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update a list response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update a list","tags":["Lists"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_identifier}/rules/lists/{list_id}/items":{"delete":{"description":"Removes one or more items from a list.\n\nThis operation is asynchronous. To get current the operation status, invoke the [Get bulk operation status](#lists-get-bulk-operation-status) endpoint with the returned `operation_id`.","operationId":"lists-delete-list-items","parameters":[{"in":"path","name":"list_id","required":true,"schema":{"$ref":"#/components/schemas/list_id"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"items":{"items":{"properties":{"id":{"$ref":"#/components/schemas/item_id"}}},"minItems":1,"type":"array"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists-async-response"}}},"description":"Delete list items response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/lists-async-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete list items response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete list items","tags":["Lists"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Fetches all the items in the list.","operationId":"lists-get-list-items","parameters":[{"in":"path","name":"list_id","required":true,"schema":{"$ref":"#/components/schemas/list_id"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"cursor","schema":{"description":"The pagination cursor. An opaque string token indicating the position from which to continue when requesting the next/previous set of records. Cursor values are provided under `result_info.cursors` in the response. You should make no assumptions about a cursor's content or length.","example":"zzz","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/items-list-response-collection"}}},"description":"Get list items response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/items-list-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get list items response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get list items","tags":["Lists"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Appends new items to the list.\n\nThis operation is asynchronous. To get current the operation status, invoke the [Get bulk operation status](#lists-get-bulk-operation-status) endpoint with the returned `operation_id`.","operationId":"lists-create-list-items","parameters":[{"in":"path","name":"list_id","required":true,"schema":{"$ref":"#/components/schemas/list_id"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/items-update-request-collection"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists-async-response"}}},"description":"Create list items response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/lists-async-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create list items response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create list items","tags":["Lists"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Removes all existing items from the list and adds the provided items to the list.\n\nThis operation is asynchronous. To get current the operation status, invoke the [Get bulk operation status](#lists-get-bulk-operation-status) endpoint with the returned `operation_id`.","operationId":"lists-update-all-list-items","parameters":[{"in":"path","name":"list_id","required":true,"schema":{"$ref":"#/components/schemas/list_id"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/items-update-request-collection"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/lists-async-response"}}},"description":"Update all list items response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/lists-async-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update all list items response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update all list items","tags":["Lists"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_identifier}/rules/lists/{list_id}/items/{item_id}":{"get":{"description":"Fetches a list item in the list.","operationId":"lists-get-a-list-item","parameters":[{"in":"path","name":"item_id","required":true,"schema":{"$ref":"#/components/schemas/item_id"}},{"in":"path","name":"list_id","required":true,"schema":{"$ref":"#/components/schemas/list_id"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/item-response-collection"}}},"description":"Get a list item response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/item-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get a list item response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a list item","tags":["Lists"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_identifier}/secondary_dns/acls":{"get":{"description":"List ACLs.","operationId":"secondary-dns-(-acl)-list-ac-ls","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-DCAPOmrB"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-response_collection-Np6QDZ3m"}}},"description":"List ACLs response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-response_collection-Np6QDZ3m"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List ACLs response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List ACLs","tags":["Secondary DNS (ACL)"],"x-cfPermissionsRequired":{"enum":["#organization:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Create ACL.","operationId":"secondary-dns-(-acl)-create-acl","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-DCAPOmrB"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["name","ip_range"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-single_response-UrWzkhyF"}}},"description":"Create ACL response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-single_response-UrWzkhyF"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create ACL response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create ACL","tags":["Secondary DNS (ACL)"],"x-cfPermissionsRequired":{"enum":["#dns_records:edit","#organization:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/secondary_dns/acls/{identifier}":{"delete":{"description":"Delete ACL.","operationId":"secondary-dns-(-acl)-delete-acl","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-DCAPOmrB"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-id_response"}}},"description":"Delete ACL response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete ACL response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete ACL","tags":["Secondary DNS (ACL)"],"x-cfPermissionsRequired":{"enum":["#dns_records:edit","#organization:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Get ACL.","operationId":"secondary-dns-(-acl)-acl-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-DCAPOmrB"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-single_response-UrWzkhyF"}}},"description":"ACL Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-single_response-UrWzkhyF"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"ACL Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"ACL Details","tags":["Secondary DNS (ACL)"],"x-cfPermissionsRequired":{"enum":["#organization:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Modify ACL.","operationId":"secondary-dns-(-acl)-update-acl","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-DCAPOmrB"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/acl"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-single_response-UrWzkhyF"}}},"description":"Update ACL response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-single_response-UrWzkhyF"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update ACL response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update ACL","tags":["Secondary DNS (ACL)"],"x-cfPermissionsRequired":{"enum":["#dns_records:edit","#organization:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/secondary_dns/peers":{"get":{"description":"List Peers.","operationId":"secondary-dns-(-peer)-list-peers","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-DCAPOmrB"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-response_collection-AREv1gR0"}}},"description":"List Peers response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-response_collection-AREv1gR0"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Peers response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Peers","tags":["Secondary DNS (Peer)"],"x-cfPermissionsRequired":{"enum":["#dns_records:read","#organization:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Create Peer.","operationId":"secondary-dns-(-peer)-create-peer","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-DCAPOmrB"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["name"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-single_response-PJU34P3b"}}},"description":"Create Peer response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-single_response-PJU34P3b"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Peer response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Peer","tags":["Secondary DNS (Peer)"],"x-cfPermissionsRequired":{"enum":["#dns_records:edit","#organization:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/secondary_dns/peers/{identifier}":{"delete":{"description":"Delete Peer.","operationId":"secondary-dns-(-peer)-delete-peer","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-DCAPOmrB"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-id_response"}}},"description":"Delete Peer response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Peer response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Peer","tags":["Secondary DNS (Peer)"],"x-cfPermissionsRequired":{"enum":["#dns_records:edit","#organization:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Get Peer.","operationId":"secondary-dns-(-peer)-peer-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-DCAPOmrB"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-single_response-PJU34P3b"}}},"description":"Peer Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-single_response-PJU34P3b"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Peer Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Peer Details","tags":["Secondary DNS (Peer)"],"x-cfPermissionsRequired":{"enum":["#dns_records:read","#organization:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Modify Peer.","operationId":"secondary-dns-(-peer)-update-peer","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-DCAPOmrB"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/peer"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-single_response-PJU34P3b"}}},"description":"Update Peer response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-single_response-PJU34P3b"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Peer response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Peer","tags":["Secondary DNS (Peer)"],"x-cfPermissionsRequired":{"enum":["#dns_records:edit","#organization:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/secondary_dns/tsigs":{"get":{"description":"List TSIGs.","operationId":"secondary-dns-(-tsig)-list-tsi-gs","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-DCAPOmrB"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_collection-7voDH8b3"}}},"description":"List TSIGs response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_collection-7voDH8b3"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List TSIGs response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List TSIGs","tags":["Secondary DNS (TSIG)"],"x-cfPermissionsRequired":{"enum":["#dns_records:read","#organization:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Create TSIG.","operationId":"secondary-dns-(-tsig)-create-tsig","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-DCAPOmrB"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tsig"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response-X5UPXTbk"}}},"description":"Create TSIG response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response-X5UPXTbk"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create TSIG response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create TSIG","tags":["Secondary DNS (TSIG)"],"x-cfPermissionsRequired":{"enum":["#dns_records:edit","#organization:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/secondary_dns/tsigs/{identifier}":{"delete":{"description":"Delete TSIG.","operationId":"secondary-dns-(-tsig)-delete-tsig","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier-03kXbNiE"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-DCAPOmrB"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-id_response"}}},"description":"Delete TSIG response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete TSIG response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete TSIG","tags":["Secondary DNS (TSIG)"],"x-cfPermissionsRequired":{"enum":["#dns_records:edit","#organization:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Get TSIG.","operationId":"secondary-dns-(-tsig)-tsig-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier-03kXbNiE"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-DCAPOmrB"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response-X5UPXTbk"}}},"description":"TSIG Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response-X5UPXTbk"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"TSIG Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"TSIG Details","tags":["Secondary DNS (TSIG)"],"x-cfPermissionsRequired":{"enum":["#dns_records:read","#organization:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Modify TSIG.","operationId":"secondary-dns-(-tsig)-update-tsig","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier-03kXbNiE"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-DCAPOmrB"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tsig"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response-X5UPXTbk"}}},"description":"Update TSIG response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response-X5UPXTbk"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update TSIG response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update TSIG","tags":["Secondary DNS (TSIG)"],"x-cfPermissionsRequired":{"enum":["#dns_records:edit","#organization:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/accounts/{account_identifier}/storage/analytics":{"get":{"description":"Retrieves Workers KV request metrics for the given account.","operationId":"workers-kv-request-analytics-query-request-analytics","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"query","schema":{"allOf":[{"$ref":"#/components/schemas/query-ju6G02HL"},{"properties":{"dimensions":{"example":["accountId","responseCode"],"items":{"enum":["accountId","responseCode","requestType"]}},"filters":{"example":"requestType==read AND responseCode!=200"},"metrics":{"default":"[\"requests\"]","example":["requests","readKiB"],"items":{"enum":["requests","writeKiB","readKiB"]}},"sort":{"example":["+requests","-responseCode"]}}}]}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/schemas-result"}},"type":"object"}]}}},"description":"Query Request Analytics response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/result-iSgQlUWZ"}},"type":"object"}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Query Request Analytics response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Query Request Analytics","tags":["Workers KV Request Analytics"]}},"/accounts/{account_identifier}/storage/analytics/stored":{"get":{"description":"Retrieves Workers KV stored data metrics for the given account.","operationId":"workers-kv-stored-data-analytics-query-stored-data-analytics","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"query","schema":{"allOf":[{"$ref":"#/components/schemas/query-ju6G02HL"},{"properties":{"dimensions":{"example":["namespaceId"],"items":{"enum":["namespaceId"]}},"filters":{"example":"namespaceId==a4e8cbb7-1b58-4990-925e-e026d40c4c64"},"metrics":{"default":"[\"storedBytes\"]","example":["storedBytes","storedKeys"],"items":{"enum":["storedBytes","storedKeys"]}},"sort":{"example":["+storedBytes","-namespaceId"]}}}]}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/components-schemas-result"}},"type":"object"}]}}},"description":"Query Stored Data Analytics response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/result-iSgQlUWZ"}},"type":"object"}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Query Stored Data Analytics response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Query Stored Data Analytics","tags":["Workers KV Stored Data Analytics"]}},"/accounts/{account_identifier}/storage/kv/namespaces":{"get":{"description":"Returns the namespaces owned by an account.","operationId":"workers-kv-namespace-list-namespaces","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Maximum number of results per page.","maximum":100,"minimum":5,"type":"number"}},{"in":"query","name":"order","schema":{"description":"Field to order results by.","enum":["id","title"],"example":"id"}},{"in":"query","name":"direction","schema":{"description":"Direction to order namespaces.","enum":["asc","desc"],"example":"asc"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/namespace"},"type":"array"}},"type":"object"}]}}},"description":"List Namespaces response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/namespace"},"type":"array"}},"type":"object"}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Namespaces response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Namespaces","tags":["Workers KV Namespace"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.storage.kv.namespace.list"]}},"post":{"description":"Creates a namespace under the given title. A 400 is returned if the account already owns a namespace with this title. A namespace must be explicitly deleted to be replaced.","operationId":"workers-kv-namespace-create-a-namespace","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_rename_namespace_body"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/namespace"}},"type":"object"}]}}},"description":"Create a Namespace response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/namespace"}},"type":"object"}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create a Namespace response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create a Namespace","tags":["Workers KV Namespace"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.storage.kv.namespace.create"]}}},"/accounts/{account_identifier}/storage/kv/namespaces/{namespace_identifier}":{"delete":{"description":"Deletes the namespace corresponding to the given ID.","operationId":"workers-kv-namespace-remove-a-namespace","parameters":[{"in":"path","name":"namespace_identifier","required":true,"schema":{"$ref":"#/components/schemas/namespace_identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single"}}},"description":"Remove a Namespace response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Remove a Namespace response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Remove a Namespace","tags":["Workers KV Namespace"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.storage.kv.namespace.delete"]}},"put":{"description":"Modifies a namespace's title.","operationId":"workers-kv-namespace-rename-a-namespace","parameters":[{"in":"path","name":"namespace_identifier","required":true,"schema":{"$ref":"#/components/schemas/namespace_identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_rename_namespace_body"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single"}}},"description":"Rename a Namespace response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Rename a Namespace response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Rename a Namespace","tags":["Workers KV Namespace"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.storage.kv.namespace.delete"]}}},"/accounts/{account_identifier}/storage/kv/namespaces/{namespace_identifier}/bulk":{"delete":{"description":"Remove multiple KV pairs from the Namespace. Body should be an array of up to 10,000 keys to be removed.","operationId":"workers-kv-namespace-delete-multiple-key-value-pairs","parameters":[{"in":"path","name":"namespace_identifier","required":true,"schema":{"$ref":"#/components/schemas/namespace_identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulk_delete"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single"}}},"description":"Delete multiple key-value pairs response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete multiple key-value pairs response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete multiple key-value pairs","tags":["Workers KV Namespace"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.storage.kv.key.delete"]}},"put":{"description":"Write multiple keys and values at once. Body should be an array of up to 10,000 key-value pairs to be stored, along with optional expiration information. Existing values and expirations will be overwritten. If neither expiration nor expiration_ttl is specified, the key-value pair will never expire. If both are set, `expiration_ttl` is used and `expiration` is ignored. The entire request size must be 100 megabytes or less.","operationId":"workers-kv-namespace-write-multiple-key-value-pairs","parameters":[{"in":"path","name":"namespace_identifier","required":true,"schema":{"$ref":"#/components/schemas/namespace_identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bulk_write"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single"}}},"description":"Write multiple key-value pairs response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Write multiple key-value pairs response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Write multiple key-value pairs","tags":["Workers KV Namespace"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.storage.kv.key.update"]}}},"/accounts/{account_identifier}/storage/kv/namespaces/{namespace_identifier}/keys":{"get":{"description":"Lists a namespace's keys.","operationId":"workers-kv-namespace-list-a-namespace'-s-keys","parameters":[{"in":"path","name":"namespace_identifier","required":true,"schema":{"$ref":"#/components/schemas/namespace_identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"limit","schema":{"default":1000,"description":"The number of keys to return. The cursor attribute may be used to iterate over the next batch of keys if there are more than the limit.","maximum":1000,"minimum":10,"type":"number"}},{"in":"query","name":"prefix","schema":{"description":"A string prefix used to filter down which keys will be returned. Exact matches and any key names that begin with the prefix will be returned.","example":"My-Prefix","type":"string"}},{"in":"query","name":"cursor","schema":{"description":"Opaque token indicating the position from which to continue when requesting the next set of records if the amount of list results was limited by the limit parameter. A valid value for the cursor can be obtained from the cursors object in the result_info structure.","example":"6Ck1la0VxJ0djhidm1MdX2FyDGxLKVeeHZZmORS_8XeSuhz9SjIJRaSa2lnsF01tQOHrfTGAP3R5X1Kv5iVUuMbNKhWNAXHOl6ePB0TUL8nw","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/key"},"type":"array"},"result_info":{"properties":{"count":{"description":"Total results returned based on your list parameters.","example":1,"type":"number"},"cursor":{"$ref":"#/components/schemas/cursor"}}}}}]}}},"description":"List a Namespace's Keys response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/key"},"type":"array"},"result_info":{"properties":{"count":{"description":"Total results returned based on your list parameters.","example":1,"type":"number"},"cursor":{"$ref":"#/components/schemas/cursor"}}}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List a Namespace's Keys response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List a Namespace's Keys","tags":["Workers KV Namespace"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.storage.kv.key.list"]}}},"/accounts/{account_identifier}/storage/kv/namespaces/{namespace_identifier}/metadata/{key_name}":{"get":{"description":"Returns the metadata associated with the given key in the given namespace. Use URL-encoding to use special characters (e.g. :, !, %) in the key name.","operationId":"workers-kv-namespace-read-the-metadata-for-a-key","parameters":[{"in":"path","name":"key_name","required":true,"schema":{"$ref":"#/components/schemas/key_name"}},{"in":"path","name":"namespace_identifier","required":true,"schema":{"$ref":"#/components/schemas/namespace_identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/list_metadata"}}}]}}},"description":"Read the metadata for a key response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/list_metadata"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Read the metadata for a key response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Read the metadata for a key","tags":["Workers KV Namespace"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.storage.kv.key.read"]}}},"/accounts/{account_identifier}/storage/kv/namespaces/{namespace_identifier}/values/{key_name}":{"delete":{"description":"Remove a KV pair from the Namespace. Use URL-encoding to use special characters (e.g. :, !, %) in the key name.","operationId":"workers-kv-namespace-delete-key-value-pair","parameters":[{"in":"path","name":"key_name","required":true,"schema":{"$ref":"#/components/schemas/key_name"}},{"in":"path","name":"namespace_identifier","required":true,"schema":{"$ref":"#/components/schemas/namespace_identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single"}}},"description":"Delete key-value pair response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete key-value pair response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete key-value pair","tags":["Workers KV Namespace"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.storage.kv.key.delete"]}},"get":{"description":"Returns the value associated with the given key in the given namespace. Use URL-encoding to use special characters (e.g. :, !, %) in the key name. If the KV-pair is set to expire at some point, the expiration time as measured in seconds since the UNIX epoch will be returned in the \"Expiration\" response header.","operationId":"workers-kv-namespace-read-key-value-pair","parameters":[{"in":"path","name":"key_name","required":true,"schema":{"$ref":"#/components/schemas/key_name"}},{"in":"path","name":"namespace_identifier","required":true,"schema":{"$ref":"#/components/schemas/namespace_identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/kv_components-schemas-value"}}},"description":"Read key-value pair response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/kv_components-schemas-value"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Read key-value pair response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Read key-value pair","tags":["Workers KV Namespace"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.storage.kv.key.read"]}},"put":{"description":"Write a value identified by a key. Use URL-encoding to use special characters (e.g. :, !, %) in the key name. Body should be the value to be stored along with json metadata to be associated with the key/value pair. Existing values, expirations and metadata will be overwritten. If neither `expiration` nor `expiration_ttl` is specified, the key-value pair will never expire. If both are set, `expiration_ttl` is used and `expiration` is ignored.","operationId":"workers-kv-namespace-write-key-value-pair-with-metadata","parameters":[{"in":"path","name":"key_name","required":true,"schema":{"$ref":"#/components/schemas/key_name"}},{"in":"path","name":"namespace_identifier","required":true,"schema":{"$ref":"#/components/schemas/namespace_identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"metadata":{"$ref":"#/components/schemas/components-schemas-metadata"},"value":{"$ref":"#/components/schemas/kv_components-schemas-value"}},"required":["value","metadata"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single"}}},"description":"Write key-value pair with metadata response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Write key-value pair with metadata response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Write key-value pair with metadata","tags":["Workers KV Namespace"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.storage.kv.key.update"]}}},"/accounts/{account_identifier}/stream":{"get":{"description":"Lists up to 1000 videos from a single request. For a specific range, refer to the optional parameters.","operationId":"stream-videos-list-videos","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-u0eFsPPd"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/video_response_collection"}}},"description":"List videos response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"List videos response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List videos","tags":["Stream Videos"]},"post":{"description":"Initiates a video upload using the TUS protocol. On success, the server responds with a status code 201 (created) and includes a `location` header to indicate where the content should be uploaded. Refer to https://tus.io for protocol details.","operationId":"stream-videos-initiate-video-uploads-using-tus","parameters":[{"in":"header","name":"Tus-Resumable","required":true,"schema":{"$ref":"#/components/schemas/tus_resumable"}},{"in":"header","name":"Upload-Creator","schema":{"$ref":"#/components/schemas/creator"}},{"in":"header","name":"Upload-Length","required":true,"schema":{"$ref":"#/components/schemas/upload_length"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-u0eFsPPd"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{}},"description":"Initiate video uploads using TUS response"},"4xx":{"content":{"application/json":{}},"description":"Initiate video uploads using TUS response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Initiate video uploads using TUS","tags":["Stream Videos"]}},"/accounts/{account_identifier}/stream/clip":{"post":{"description":"Clips a video based on the specified start and end times provided in seconds.","operationId":"stream-video-clipping-clip-videos-given-a-start-and-end-time","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-u0eFsPPd"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/videoClipStandard"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/clipResponseSingle"}}},"description":"Clip videos given a start and end time response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"Clip videos given a start and end time response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Clip videos given a start and end time","tags":["Stream Video Clipping"]}},"/accounts/{account_identifier}/stream/copy":{"post":{"description":"Uploads a video to Stream from a provided URL.","operationId":"stream-videos-upload-videos-from-a-url","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-u0eFsPPd"}},{"in":"header","name":"Upload-Creator","schema":{"$ref":"#/components/schemas/creator"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/video_copy_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/video_response_single"}}},"description":"Upload videos from a URL response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"Upload videos from a URL response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Upload videos from a URL","tags":["Stream Videos"]}},"/accounts/{account_identifier}/stream/direct_upload":{"post":{"description":"Creates a direct upload that allows video uploads without an API key.","operationId":"stream-videos-upload-videos-via-direct-upload-ur-ls","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-u0eFsPPd"}},{"in":"header","name":"Upload-Creator","schema":{"$ref":"#/components/schemas/creator"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/direct_upload_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/direct_upload_response"}}},"description":"Upload videos via direct upload URLs response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"Upload videos via direct upload URLs response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Upload videos via direct upload URLs","tags":["Stream Videos"]}},"/accounts/{account_identifier}/stream/keys":{"get":{"description":"Lists the video ID and creation date and time when a signing key was created.","operationId":"stream-signing-keys-list-signing-keys","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/key_response_collection-FpLR6Wht"}}},"description":"List signing keys response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"List signing keys response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List signing keys","tags":["Stream Signing Keys"]},"post":{"description":"Creates an RSA private key in PEM and JWK formats. Key files are only displayed once after creation. Keys are created, used, and deleted independently of videos, and every key can sign any video.","operationId":"stream-signing-keys-create-signing-keys","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/key_generation_response"}}},"description":"Create signing keys response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"Create signing keys response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create signing keys","tags":["Stream Signing Keys"]}},"/accounts/{account_identifier}/stream/keys/{identifier}":{"delete":{"description":"Deletes signing keys and revokes all signed URLs generated with the key.","operationId":"stream-signing-keys-delete-signing-keys","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deleted_response-7kko7sFR"}}},"description":"Delete signing keys response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"Delete signing keys response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete signing keys","tags":["Stream Signing Keys"]}},"/accounts/{account_identifier}/stream/live_inputs":{"get":{"description":"Lists the live inputs created for an account. To get the credentials needed to stream to a specific live input, request a single live input.","operationId":"stream-live-inputs-list-live-inputs","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/live_input_response_collection"}}},"description":"List live inputs response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"List live inputs response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List live inputs","tags":["Stream Live Inputs"]},"post":{"description":"Creates a live input, and returns credentials that you or your users can use to stream live video to Cloudflare Stream.","operationId":"stream-live-inputs-create-a-live-input","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_input_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/live_input_response_single"}}},"description":"Create a live input response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"Create a live input response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create a live input","tags":["Stream Live Inputs"]}},"/accounts/{account_identifier}/stream/live_inputs/{live_input_identifier}":{"delete":{"description":"Prevents a live input from being streamed to and makes the live input inaccessible to any future API calls.","operationId":"stream-live-inputs-delete-a-live-input","parameters":[{"in":"path","name":"live_input_identifier","required":true,"schema":{"$ref":"#/components/schemas/live_input_identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{}},"description":"Delete a live input response"},"4xx":{"content":{"application/json":{}},"description":"Delete a live input response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete a live input","tags":["Stream Live Inputs"]},"get":{"description":"Retrieves details of an existing live input.","operationId":"stream-live-inputs-retrieve-a-live-input","parameters":[{"in":"path","name":"live_input_identifier","required":true,"schema":{"$ref":"#/components/schemas/live_input_identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/live_input_response_single"}}},"description":"Retrieve a live input response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"Retrieve a live input response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Retrieve a live input","tags":["Stream Live Inputs"]},"put":{"description":"Updates a specified live input.","operationId":"stream-live-inputs-update-a-live-input","parameters":[{"in":"path","name":"live_input_identifier","required":true,"schema":{"$ref":"#/components/schemas/live_input_identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_input_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/live_input_response_single"}}},"description":"Update a live input response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"Update a live input response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update a live input","tags":["Stream Live Inputs"]}},"/accounts/{account_identifier}/stream/live_inputs/{live_input_identifier}/outputs":{"get":{"description":"Retrieves all outputs associated with a specified live input.","operationId":"stream-live-inputs-list-all-outputs-associated-with-a-specified-live-input","parameters":[{"in":"path","name":"live_input_identifier","required":true,"schema":{"$ref":"#/components/schemas/live_input_identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/output_response_collection"}}},"description":"List all outputs associated with a specified live input response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"List all outputs associated with a specified live input response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List all outputs associated with a specified live input","tags":["Stream Live Inputs"]},"post":{"description":"Creates a new output that can be used to simulcast or restream live video to other RTMP or SRT destinations. Outputs are always linked to a specific live input — one live input can have many outputs.","operationId":"stream-live-inputs-create-a-new-output,-connected-to-a-live-input","parameters":[{"in":"path","name":"live_input_identifier","required":true,"schema":{"$ref":"#/components/schemas/live_input_identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_output_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/output_response_single"}}},"description":"Create a new output, connected to a live input response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"Create a new output, connected to a live input response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create a new output, connected to a live input","tags":["Stream Live Inputs"]}},"/accounts/{account_identifier}/stream/live_inputs/{live_input_identifier}/outputs/{output_identifier}":{"delete":{"description":"Deletes an output and removes it from the associated live input.","operationId":"stream-live-inputs-delete-an-output","parameters":[{"in":"path","name":"output_identifier","required":true,"schema":{"$ref":"#/components/schemas/output_identifier"}},{"in":"path","name":"live_input_identifier","required":true,"schema":{"$ref":"#/components/schemas/live_input_identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{}},"description":"Delete an output response"},"4xx":{"content":{"application/json":{}},"description":"Delete an output response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete an output","tags":["Stream Live Inputs"]},"put":{"description":"Updates the state of an output.","operationId":"stream-live-inputs-update-an-output","parameters":[{"in":"path","name":"output_identifier","required":true,"schema":{"$ref":"#/components/schemas/output_identifier"}},{"in":"path","name":"live_input_identifier","required":true,"schema":{"$ref":"#/components/schemas/live_input_identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_output_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/output_response_single"}}},"description":"Update an output response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"Update an output response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update an output","tags":["Stream Live Inputs"]}},"/accounts/{account_identifier}/stream/watermarks":{"get":{"description":"Lists all watermark profiles for an account.","operationId":"stream-watermark-profile-list-watermark-profiles","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-u0eFsPPd"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/watermark_response_collection"}}},"description":"List watermark profiles response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"List watermark profiles response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List watermark profiles","tags":["Stream Watermark Profile"]},"post":{"description":"Creates watermark profiles using a single `HTTP POST multipart/form-data` request.","operationId":"stream-watermark-profile-create-watermark-profiles-via-basic-upload","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-u0eFsPPd"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/watermark_basic_upload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/watermark_response_single"}}},"description":"Create watermark profiles via basic upload response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"Create watermark profiles via basic upload response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create watermark profiles via basic upload","tags":["Stream Watermark Profile"]}},"/accounts/{account_identifier}/stream/watermarks/{identifier}":{"delete":{"description":"Deletes a watermark profile.","operationId":"stream-watermark-profile-delete-watermark-profiles","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/watermark_identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-u0eFsPPd"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"example":"","type":"string"}}}]}}},"description":"Delete watermark profiles response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"Delete watermark profiles response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete watermark profiles","tags":["Stream Watermark Profile"]},"get":{"description":"Retrieves details for a single watermark profile.","operationId":"stream-watermark-profile-watermark-profile-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/watermark_identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-u0eFsPPd"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/watermark_response_single"}}},"description":"Watermark profile details response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"Watermark profile details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Watermark profile details","tags":["Stream Watermark Profile"]}},"/accounts/{account_identifier}/stream/webhook":{"delete":{"description":"Deletes a webhook.","operationId":"stream-webhook-delete-webhooks","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-u0eFsPPd"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deleted_response-7kko7sFR"}}},"description":"Delete webhooks response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"Delete webhooks response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete webhooks","tags":["Stream Webhook"]},"get":{"description":"Retrieves a list of webhooks.","operationId":"stream-webhook-view-webhooks","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-u0eFsPPd"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhook_response_single"}}},"description":"View webhooks response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"View webhooks response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"View webhooks","tags":["Stream Webhook"]},"put":{"description":"Creates a webhook notification.","operationId":"stream-webhook-create-webhooks","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-u0eFsPPd"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhook_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhook_response_single"}}},"description":"Create webhooks response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"Create webhooks response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create webhooks","tags":["Stream Webhook"]}},"/accounts/{account_identifier}/stream/{identifier}":{"delete":{"description":"Deletes a video and its copies from Cloudflare Stream.","operationId":"stream-videos-delete-video","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-XSj9HnWY"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-u0eFsPPd"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{}},"description":"Delete video response"},"4xx":{"content":{"application/json":{}},"description":"Delete video response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete video","tags":["Stream Videos"]},"get":{"description":"Fetches details for a single video.","operationId":"stream-videos-retrieve-video-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-XSj9HnWY"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-u0eFsPPd"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/video_response_single"}}},"description":"Retrieve video details response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"Retrieve video details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Retrieve video details","tags":["Stream Videos"]},"post":{"description":"Update details for a single video.","operationId":"stream-videos-update-video-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-XSj9HnWY"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-u0eFsPPd"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/video_update"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/video_response_single"}}},"description":"Update video details response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"Update video details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update video details","tags":["Stream Videos"]}},"/accounts/{account_identifier}/stream/{identifier}/captions":{"get":{"description":"Lists the available captions or subtitles for a specific video.","operationId":"stream-subtitles/-captions-list-captions-or-subtitles","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-XSj9HnWY"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/language_response_collection"}}},"description":"List captions or subtitles response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"List captions or subtitles response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List captions or subtitles","tags":["Stream Subtitles/Captions"]}},"/accounts/{account_identifier}/stream/{identifier}/captions/{language}":{"delete":{"description":"Removes the captions or subtitles from a video.","operationId":"stream-subtitles/-captions-delete-captions-or-subtitles","parameters":[{"in":"path","name":"language","required":true,"schema":{"$ref":"#/components/schemas/language"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-XSj9HnWY"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"example":"","type":"string"}}}]}}},"description":"Delete captions or subtitles response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"Delete captions or subtitles response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete captions or subtitles","tags":["Stream Subtitles/Captions"]},"put":{"description":"Uploads the caption or subtitle file to the endpoint for a specific BCP47 language. One caption or subtitle file per language is allowed.","operationId":"stream-subtitles/-captions-upload-captions-or-subtitles","parameters":[{"in":"path","name":"language","required":true,"schema":{"$ref":"#/components/schemas/language"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-XSj9HnWY"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/caption_basic_upload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/language_response_single"}}},"description":"Upload captions or subtitles response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"Upload captions or subtitles response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Upload captions or subtitles","tags":["Stream Subtitles/Captions"]}},"/accounts/{account_identifier}/stream/{identifier}/downloads":{"delete":{"description":"Delete the downloads for a video.","operationId":"stream-m-p-4-downloads-delete-downloads","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-XSj9HnWY"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deleted_response-7kko7sFR"}}},"description":"Delete downloads response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"Delete downloads response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete downloads","tags":["Stream MP4 Downloads"]},"get":{"description":"Lists the downloads created for a video.","operationId":"stream-m-p-4-downloads-list-downloads","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-XSj9HnWY"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/downloads_response"}}},"description":"List downloads response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"List downloads response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List downloads","tags":["Stream MP4 Downloads"]},"post":{"description":"Creates a download for a video when a video is ready to view.","operationId":"stream-m-p-4-downloads-create-downloads","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-XSj9HnWY"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/downloads_response"}}},"description":"Create downloads response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"Create downloads response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create downloads","tags":["Stream MP4 Downloads"]}},"/accounts/{account_identifier}/stream/{identifier}/embed":{"get":{"description":"Fetches an HTML code snippet to embed a video in a web page delivered through Cloudflare. On success, returns an HTML fragment for use on web pages to display a video. On failure, returns a JSON response body.","operationId":"stream-videos-retreieve-embed-code-html","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-XSj9HnWY"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-u0eFsPPd"}}],"responses":{"200":{"content":{"application/json":{"schema":{"example":"\u003cstream id=\"ea95132c15732412d22c1476fa83f27a\"\u003e\u003c/stream\u003e\u003cscript data-cfasync=\"false\" defer type=\"text/javascript\" src=\"https://embed.cloudflarestream.com/embed/we4g.fla9.latest.js\"\u003e\u003c/script\u003e"}}},"description":"Retreieve embed Code HTML response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"Retreieve embed Code HTML response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Retreieve embed Code HTML","tags":["Stream Videos"]}},"/accounts/{account_identifier}/stream/{identifier}/token":{"post":{"description":"Creates a signed URL token for a video. If a body is not provided in the request, a token is created with default values.","operationId":"stream-videos-create-signed-url-tokens-for-videos","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-XSj9HnWY"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/account_identifier-u0eFsPPd"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/signed_token_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/signed_token_response"}}},"description":"Create signed URL tokens for videos response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"Create signed URL tokens for videos response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create signed URL tokens for videos","tags":["Stream Videos"]}},"/accounts/{account_identifier}/subscriptions":{"get":{"description":"Lists all of an account's subscriptions.","operationId":"account-subscriptions-list-subscriptions","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account_subscription_response_collection"}}},"description":"List Subscriptions response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/account_subscription_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Subscriptions response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Subscriptions","tags":["Account Subscriptions"],"x-cfPermissionsRequired":{"enum":["#billing:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Creates an account subscription.","operationId":"account-subscriptions-create-subscription","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscription-v2"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account_subscription_response_single"}}},"description":"Create Subscription response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/account_subscription_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Subscription response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Subscription","tags":["Account Subscriptions"],"x-cfPermissionsRequired":{"enum":["#billing:read","#billing:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_identifier}/subscriptions/{subscription_identifier}":{"delete":{"description":"Deletes an account's subscription.","operationId":"account-subscriptions-delete-subscription","parameters":[{"in":"path","name":"subscription_identifier","required":true,"schema":{"$ref":"#/components/schemas/subscription-v2_components-schemas-identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"subscription_id":{"$ref":"#/components/schemas/subscription-v2_components-schemas-identifier"}},"type":"object"}}}]}}},"description":"Delete Subscription response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"subscription_id":{"$ref":"#/components/schemas/subscription-v2_components-schemas-identifier"}},"type":"object"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Subscription response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Subscription","tags":["Account Subscriptions"],"x-cfPermissionsRequired":{"enum":["#billing:edit"]}},"put":{"description":"Updates an account subscription.","operationId":"account-subscriptions-update-subscription","parameters":[{"in":"path","name":"subscription_identifier","required":true,"schema":{"$ref":"#/components/schemas/subscription-v2_components-schemas-identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscription-v2"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account_subscription_response_single"}}},"description":"Update Subscription response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/account_subscription_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Subscription response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Subscription","tags":["Account Subscriptions"],"x-cfPermissionsRequired":{"enum":["#billing:read","#billing:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_identifier}/teamnet/routes":{"get":{"description":"Lists and filters private network routes in an account.","operationId":"tunnel-route-list-tunnel-routes","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}},{"in":"query","name":"comment","schema":{"$ref":"#/components/schemas/comment-ZBQ7qz21"}},{"in":"query","name":"is_deleted","schema":{"description":"If `true`, only include deleted routes. If `false`, exclude deleted routes. If empty, all routes will be included."}},{"in":"query","name":"network_subset","schema":{"description":"If set, only list routes that are contained within this IP range."}},{"in":"query","name":"network_superset","schema":{"description":"If set, only list routes that contain this IP range."}},{"in":"query","name":"existed_at","schema":{"description":"If provided, include only routes that were created (and not deleted) before this time."}},{"in":"query","name":"per_page","schema":{"$ref":"#/components/schemas/schemas-per_page"}},{"in":"query","name":"tunnel_id","schema":{"description":"UUID of the Cloudflare Tunnel serving the route."}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"virtual_network_id","schema":{"description":"UUID of the Tunnel Virtual Network this route belongs to. If no virtual networks are configured, the route is assigned to the default virtual network of the account."}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/route_response_collection"}}},"description":"List tunnel routes response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/route_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List tunnel routes response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List tunnel routes","tags":["Tunnel route"]}},"/accounts/{account_identifier}/teamnet/routes/ip/{ip}":{"get":{"description":"Fetches routes that contain the given IP address.","operationId":"tunnel-route-get-tunnel-route-by-ip","parameters":[{"in":"path","name":"ip","required":true,"schema":{"$ref":"#/components/schemas/teamnet_components-schemas-ip"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}},{"in":"query","name":"virtual_network_id","schema":{"description":"UUID of the Tunnel Virtual Network this route belongs to. If no virtual networks are configured, the route is assigned to the default virtual network of the account."}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/route_response_single"}}},"description":"Get tunnel route by IP response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/route_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get tunnel route by IP response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get tunnel route by IP","tags":["Tunnel route"]}},"/accounts/{account_identifier}/teamnet/routes/network/{ip_network_encoded}":{"delete":{"description":"Deletes a private network route from an account. The CIDR in `ip_network_encoded` must be written in URL-encoded format.","operationId":"tunnel-route-delete-a-tunnel-route","parameters":[{"in":"path","name":"ip_network_encoded","required":true,"schema":{"$ref":"#/components/schemas/ip_network_encoded"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"virtual_network_id":{"$ref":"#/components/schemas/schemas-virtual_network_id"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/route_response_single"}}},"description":"Delete a tunnel route response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/route_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete a tunnel route response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete a tunnel route","tags":["Tunnel route"]},"patch":{"description":"Updates an existing private network route in an account. The CIDR in `ip_network_encoded` must be written in URL-encoded format.","operationId":"tunnel-route-update-a-tunnel-route","parameters":[{"in":"path","name":"ip_network_encoded","required":true,"schema":{"$ref":"#/components/schemas/ip_network_encoded"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"comment":{"$ref":"#/components/schemas/comment-ZBQ7qz21"},"network":{"description":"The new IPv4 or IPv6 range of this route, in CIDR notation."},"tunnel_id":{"description":"UUID of the tunnel this route should belong to."},"virtual_network_id":{"$ref":"#/components/schemas/schemas-virtual_network_id"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/route_response_single"}}},"description":"Update a tunnel route response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/route_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update a tunnel route response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update a tunnel route","tags":["Tunnel route"]},"post":{"description":"Routes a private network through a Cloudflare Tunnel. The CIDR in `ip_network_encoded` must be written in URL-encoded format.","operationId":"tunnel-route-create-a-tunnel-route","parameters":[{"in":"path","name":"ip_network_encoded","required":true,"schema":{"$ref":"#/components/schemas/ip_network_encoded"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"comment":{"$ref":"#/components/schemas/comment-ZBQ7qz21"},"tunnel_id":{"$ref":"#/components/schemas/tunnel_id"},"virtual_network_id":{"$ref":"#/components/schemas/schemas-virtual_network_id"}},"required":["tunnel_id"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/route_response_single"}}},"description":"Create a tunnel route response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/route_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create a tunnel route response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create a tunnel route","tags":["Tunnel route"]}},"/accounts/{account_identifier}/teamnet/virtual_networks":{"get":{"description":"Lists and filters virtual networks in an account.","operationId":"tunnel-virtual-network-list-virtual-networks","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}},{"in":"query","name":"name","schema":{"$ref":"#/components/schemas/vnet_name"}},{"in":"query","name":"is_default","schema":{"description":"If `true`, only include the default virtual network. If `false`, exclude the default virtual network. If empty, all virtual networks will be included."}},{"in":"query","name":"is_deleted","schema":{"description":"If `true`, only include deleted virtual networks. If `false`, exclude deleted virtual networks. If empty, all virtual networks will be included."}},{"in":"query","name":"vnet_name","schema":{"$ref":"#/components/schemas/vnet_name"}},{"in":"query","name":"vnet_id","schema":{"description":"UUID of the virtual network.","example":"f70ff985-a4ef-4643-bbbc-4a0ed4fc8415","maxLength":36,"readOnly":true,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/vnet_response_collection"}}},"description":"List virtual networks response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/vnet_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List virtual networks response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List virtual networks","tags":["Tunnel Virtual Network"]},"post":{"description":"Adds a new virtual network to an account.","operationId":"tunnel-virtual-network-create-a-virtual-network","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"comment":{"$ref":"#/components/schemas/schemas-comment"},"is_default":{"$ref":"#/components/schemas/is_default_network"},"name":{"$ref":"#/components/schemas/vnet_name"}},"required":["name"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/vnet_response_single"}}},"description":"Create a virtual network response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/vnet_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create a virtual network response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create a virtual network","tags":["Tunnel Virtual Network"]}},"/accounts/{account_identifier}/teamnet/virtual_networks/{vnet_id}":{"delete":{"description":"Deletes an existing virtual network.","operationId":"tunnel-virtual-network-delete-a-virtual-network","parameters":[{"in":"path","name":"vnet_id","required":true,"schema":{"$ref":"#/components/schemas/vnet_id"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/vnet_response_single"}}},"description":"Delete a virtual network response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/vnet_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete a virtual network response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete a virtual network","tags":["Tunnel Virtual Network"]},"patch":{"description":"Updates an existing virtual network.","operationId":"tunnel-virtual-network-update-a-virtual-network","parameters":[{"in":"path","name":"vnet_id","required":true,"schema":{"$ref":"#/components/schemas/vnet_id"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"comment":{"$ref":"#/components/schemas/schemas-comment"},"is_default_network":{"$ref":"#/components/schemas/is_default_network"},"name":{"$ref":"#/components/schemas/vnet_name"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/vnet_response_single"}}},"description":"Update a virtual network response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/vnet_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update a virtual network response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update a virtual network","tags":["Tunnel Virtual Network"]}},"/accounts/{account_identifier}/tunnels":{"get":{"deprecated":true,"description":"Lists and filters Argo Tunnels in an account.","operationId":"argo-tunnel-list-argo-tunnels","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}},{"in":"query","name":"uuid","schema":{"$ref":"#/components/schemas/tunnel_id"}},{"in":"query","name":"existed_at","schema":{"$ref":"#/components/schemas/existed_at"}},{"in":"query","name":"tunnel_id","schema":{"$ref":"#/components/schemas/tunnel_id"}},{"in":"query","name":"is_deleted","schema":{"description":"If `true`, only include deleted tunnels. If `false`, exclude deleted tunnels. If empty, all tunnels will be included.","example":true,"type":"boolean"}},{"in":"query","name":"tunnel_name","schema":{"description":"A user-friendly name for the tunnel.","example":"blog","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_response_collection"}}},"description":"List Argo Tunnels response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Argo Tunnels response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Argo Tunnels","tags":["Argo Tunnel"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the equivalent Cloudflare Tunnel APIs.","display":true,"eol":"2024-02-04","id":"argo_tunnel_deprecation"}},"post":{"deprecated":true,"description":"Creates a new Argo Tunnel in an account.","operationId":"argo-tunnel-create-an-argo-tunnel","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"$ref":"#/components/schemas/tunnel_name"},"tunnel_secret":{"description":"Sets the password required to run the tunnel. Must be at least 32 bytes and encoded as a base64 string."}},"required":["name","tunnel_secret"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_response_single"}}},"description":"Create an Argo Tunnel response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create an Argo Tunnel response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create an Argo Tunnel","tags":["Argo Tunnel"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the equivalent Cloudflare Tunnel APIs.","display":true,"eol":"2024-02-04","id":"argo_tunnel_deprecation"}}},"/accounts/{account_identifier}/tunnels/{tunnel_id}":{"delete":{"deprecated":true,"description":"Deletes an Argo Tunnel from an account.","operationId":"argo-tunnel-delete-an-argo-tunnel","parameters":[{"in":"path","name":"tunnel_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_id"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_response_single"}}},"description":"Delete an Argo Tunnel response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete an Argo Tunnel response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete an Argo Tunnel","tags":["Argo Tunnel"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the equivalent Cloudflare Tunnel APIs.","display":true,"eol":"2024-02-04","id":"argo_tunnel_deprecation"}},"get":{"deprecated":true,"description":"Fetches a single Argo Tunnel.","operationId":"argo-tunnel-get-an-argo-tunnel","parameters":[{"in":"path","name":"tunnel_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_id"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tunnel_response_single"}}},"description":"Get an Argo Tunnel response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tunnel_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get an Argo Tunnel response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get an Argo Tunnel","tags":["Argo Tunnel"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the equivalent Cloudflare Tunnel APIs.","display":true,"eol":"2024-02-04","id":"argo_tunnel_deprecation"}}},"/accounts/{account_identifier}/tunnels/{tunnel_id}/connections":{"delete":{"deprecated":true,"description":"Removes connections that are in a disconnected or pending reconnect state. We recommend running this command after shutting down a tunnel.","operationId":"argo-tunnel-clean-up-argo-tunnel-connections","parameters":[{"in":"path","name":"tunnel_id","required":true,"schema":{"$ref":"#/components/schemas/tunnel_id"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/cf_account_id"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-empty_response"}}},"description":"Clean up Argo Tunnel connections response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-empty_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Clean up Argo Tunnel connections response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Clean up Argo Tunnel connections","tags":["Argo Tunnel"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the equivalent Cloudflare Tunnel APIs.","display":true,"eol":"2024-02-04","id":"argo_tunnel_deprecation"}}},"/accounts/{account_identifier}/workers/account-settings":{"get":{"description":"Fetches Worker Account Settings for an account.","operationId":"worker-account-settings-fetch-worker-account-settings","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account-settings-response"}}},"description":"Fetch Worker Account Settings response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/account-settings-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Fetch Worker Account Settings response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Fetch Worker Account Settings","tags":["Worker Account Settings"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.read"]}},"put":{"description":"Creates Worker Account Settings for an account.","operationId":"worker-account-settings-create-worker-account-settings","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"example":"{'default_usage_model': 'unbound'}"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/account-settings-response"}}},"description":"Create Worker Account Settings response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/account-settings-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Worker Account Settings response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Worker Account Settings","tags":["Worker Account Settings"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.update"]}}},"/accounts/{account_identifier}/workers/deployments/by-script/{script_identifier}":{"get":{"operationId":"worker-deployments-list-deployments","parameters":[{"in":"path","name":"script_identifier","required":true,"schema":{"$ref":"#/components/schemas/script_identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deployments-list-response"}}},"description":"List Deployments response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/deployments-list-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Deployments response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Deployments","tags":["Worker Deployments"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.deployment.list"]}}},"/accounts/{account_identifier}/workers/deployments/by-script/{script_identifier}/detail/{deployment_identifier}":{"get":{"operationId":"worker-deployments-get-deployment-detail","parameters":[{"in":"path","name":"deployment_identifier","required":true,"schema":{"$ref":"#/components/schemas/deployment_identifier"}},{"in":"path","name":"script_identifier","required":true,"schema":{"$ref":"#/components/schemas/script_identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/deployments-single-response"}}},"description":"Get Deployment Detail response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/deployments-single-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Deployment Detail response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Deployment Detail","tags":["Worker Deployments"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.deployment.read"]}}},"/accounts/{account_identifier}/workers/domains":{"get":{"description":"Lists all Worker Domains.","operationId":"worker-domain-list-domains","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-account_identifier"}},{"in":"query","name":"zone_name","schema":{"$ref":"#/components/schemas/zone_name"}},{"in":"query","name":"service","schema":{"$ref":"#/components/schemas/schemas-service"}},{"in":"query","name":"zone_identifier","schema":{"$ref":"#/components/schemas/zone_identifier"}},{"in":"query","name":"hostname","schema":{"description":"Hostname of the Worker Domain.","example":"foo.example.com","type":"string"}},{"in":"query","name":"environment","schema":{"description":"Worker environment associated with the zone and hostname.","example":"production","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain-response-collection-7KXX2Ghb"}}},"description":"List Domains response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/domain-response-collection-7KXX2Ghb"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Domains response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Domains","tags":["Worker Domain"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.domain.list"]}},"put":{"description":"Attaches a worker to a zone and hostname.","operationId":"worker-domain-attach-to-domain","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-account_identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"environment":{"$ref":"#/components/schemas/environment"},"hostname":{"$ref":"#/components/schemas/components-schemas-hostname"},"service":{"$ref":"#/components/schemas/schemas-service"},"zone_id":{"$ref":"#/components/schemas/zone_identifier"}},"required":["zone_id","hostname","service","environment"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain-response-single-0j5uvVNJ"}}},"description":"Attach to Domain response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/domain-response-single-0j5uvVNJ"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Attach to Domain response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Attach to Domain","tags":["Worker Domain"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.domain.update"]}}},"/accounts/{account_identifier}/workers/domains/{domain_identifier}":{"delete":{"description":"Detaches a worker from a zone and hostname.","operationId":"worker-domain-detach-from-domain","parameters":[{"in":"path","name":"domain_identifier","required":true,"schema":{"$ref":"#/components/schemas/domain_identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-account_identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{}},"description":"Detach from Domain response"},"4xx":{"content":{"application/json":{}},"description":"Detach from Domain response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Detach from Domain","tags":["Worker Domain"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.domain.delete"]}},"get":{"description":"Gets a Worker Domain.","operationId":"worker-domain-get-a-domain","parameters":[{"in":"path","name":"domain_identifier","required":true,"schema":{"$ref":"#/components/schemas/domain_identifier"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-account_identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/domain-response-single-0j5uvVNJ"}}},"description":"Get a Domain response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/domain-response-single-0j5uvVNJ"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get a Domain response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a Domain","tags":["Worker Domain"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.domain.read"]}}},"/accounts/{account_identifier}/workers/durable_objects/namespaces":{"get":{"description":"Returns the namespaces owned by an account.","operationId":"durable-objects-namespace-list-namespaces","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/schemas-namespace"},"type":"array"}},"type":"object"}]}}},"description":"List Namespaces response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/schemas-namespace"},"type":"array"}},"type":"object"}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Namespaces response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Namespaces","tags":["Durable Objects Namespace"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.durable-object.class.list"]}}},"/accounts/{account_identifier}/workers/durable_objects/namespaces/{id}/objects":{"get":{"description":"Returns the Durable Objects in a given namespace.","operationId":"durable-objects-namespace-list-objects","parameters":[{"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-id"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"limit","schema":{"default":1000,"description":"The number of objects to return. The cursor attribute may be used to iterate over the next batch of objects if there are more than the limit.","maximum":10000,"minimum":10,"type":"number"}},{"in":"query","name":"cursor","schema":{"description":"Opaque token indicating the position from which to continue when requesting the next set of records. A valid value for the cursor can be obtained from the cursors object in the result_info structure.","example":"AAAAANuhDN7SjacTnSVsDu3WW1Lvst6dxJGTjRY5BhxPXdf6L6uTcpd_NVtjhn11OUYRsVEykxoUwF-JQU4dn6QylZSKTOJuG0indrdn_MlHpMRtsxgXjs-RPdHYIVm3odE_uvEQ_dTQGFm8oikZMohns34DLBgrQpc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/object"},"type":"array"},"result_info":{"properties":{"count":{"description":"Total results returned based on your list parameters.","example":1,"type":"number"},"cursor":{"$ref":"#/components/schemas/schemas-cursor"}}}},"type":"object"}]}}},"description":"List Objects response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/object"},"type":"array"},"result_info":{"properties":{"count":{"description":"Total results returned based on your list parameters.","example":1,"type":"number"},"cursor":{"$ref":"#/components/schemas/schemas-cursor"}}}},"type":"object"}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Objects response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Objects","tags":["Durable Objects Namespace"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.durable-object.class.read"]}}},"/accounts/{account_identifier}/workers/queues":{"get":{"description":"Returns the queues owned by an account.","operationId":"queue-list-queues","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"errors":{"nullable":true}}},{"properties":{"messages":{"nullable":true}}},{"properties":{"result_info":{"properties":{"count":{"example":1},"page":{"example":1},"per_page":{"example":100},"total_count":{"example":1},"total_pages":{"example":1}},"type":"object"}}},{"properties":{"result":{"items":{"$ref":"#/components/schemas/queue"},"type":"array"}},"required":["queue_id","queue_name","created_on","modified_on","producers_total_count","producers","consumers_total_count","consumers"],"type":"object"}]}}},"description":"List Queues response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"errors":{"nullable":true}}},{"properties":{"messages":{"nullable":true}}},{"properties":{"result_info":{"properties":{"count":{"example":1},"page":{"example":1},"per_page":{"example":100},"total_count":{"example":1},"total_pages":{"example":1}},"type":"object"}}},{"properties":{"result":{"items":{"$ref":"#/components/schemas/queue"},"type":"array"}},"required":["queue_id","queue_name","created_on","modified_on","producers_total_count","producers","consumers_total_count","consumers"],"type":"object"}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Queues response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Queues","tags":["Queue"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.queue.list"]}},"post":{"description":"Creates a new queue.","operationId":"queue-create-queue","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"example":{"queue_name":"example-queue"}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/queue_created"}],"type":"object"}},"required":["queue_id","queue_name","created_on","modified_on"],"type":"object"}]}}},"description":"Create Queue response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/queue_created"}],"type":"object"}},"required":["queue_id","queue_name","created_on","modified_on"],"type":"object"}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Queue response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Queue","tags":["Queue"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.queue.create"]}}},"/accounts/{account_identifier}/workers/queues/{name}":{"delete":{"description":"Deletes a queue.","operationId":"queue-delete-queue","parameters":[{"in":"path","name":"name","required":true,"schema":{"$ref":"#/components/schemas/queues_components-schemas-name"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"nullable":true,"properties":{"result":{"nullable":true}}}]}}},"description":"Delete Queue response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"nullable":true,"properties":{"result":{"nullable":true}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Queue response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Queue","tags":["Queue"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.queue.delete"]}},"get":{"description":"Get information about a specific queue.","operationId":"queue-queue-details","parameters":[{"in":"path","name":"name","required":true,"schema":{"$ref":"#/components/schemas/queues_components-schemas-name"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/queue"}],"type":"object"}},"required":["queue_id","queue_name","created_on","modified_on"],"type":"object"}]}}},"description":"Queue Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/queue"}],"type":"object"}},"required":["queue_id","queue_name","created_on","modified_on"],"type":"object"}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Queue Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Queue Details","tags":["Queue"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.queue.read"]}},"put":{"description":"Updates a queue.","operationId":"queue-update-queue","parameters":[{"in":"path","name":"name","required":true,"schema":{"$ref":"#/components/schemas/queues_components-schemas-name"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"example":{"queue_name":"renamed-example-queue"}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/queue_updated"}],"type":"object"}},"required":["queue_id","queue_name","created_on","modified_on"],"type":"object"}]}}},"description":"Update Queue response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/queue_updated"}],"type":"object"}},"required":["queue_id","queue_name","created_on","modified_on"],"type":"object"}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Queue response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Queue","tags":["Queue"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.queue.update"]}}},"/accounts/{account_identifier}/workers/queues/{name}/consumers":{"get":{"description":"Returns the consumers for a queue.","operationId":"queue-list-queue-consumers","parameters":[{"in":"path","name":"name","required":true,"schema":{"$ref":"#/components/schemas/queues_components-schemas-name"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"errors":{"nullable":true}}},{"properties":{"messages":{"nullable":true}}},{"properties":{"result_info":{"properties":{"count":{"example":1},"page":{"example":1},"per_page":{"example":100},"total_count":{"example":1},"total_pages":{"example":1}},"type":"object"}}},{"properties":{"result":{"items":{"$ref":"#/components/schemas/consumer"},"type":"array"}},"required":["queue_name","created_on","settings"],"type":"object"}]}}},"description":"List Queue Consumers response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"errors":{"nullable":true}}},{"properties":{"messages":{"nullable":true}}},{"properties":{"result_info":{"properties":{"count":{"example":1},"page":{"example":1},"per_page":{"example":100},"total_count":{"example":1},"total_pages":{"example":1}},"type":"object"}}},{"properties":{"result":{"items":{"$ref":"#/components/schemas/consumer"},"type":"array"}},"required":["queue_name","created_on","settings"],"type":"object"}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Queue Consumers response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Queue Consumers","tags":["Queue"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.queue.list"]}},"post":{"description":"Creates a new consumer for a queue.","operationId":"queue-create-queue-consumer","parameters":[{"in":"path","name":"name","required":true,"schema":{"$ref":"#/components/schemas/queues_components-schemas-name"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"example":{"dead_letter_queue":"example-dlq","environment":"production","script_name":"example-consumer","settings":{"batch_size":10,"max_retries":3,"max_wait_time_ms":5000}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/consumer_created"}],"type":"object"}},"required":["queue_name","script_name","settings","dead_letter_queue","created_on"],"type":"object"}]}}},"description":"Create Queue Consumer response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/consumer_created"}],"type":"object"}},"required":["queue_name","script_name","settings","dead_letter_queue","created_on"],"type":"object"}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Queue Consumer response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Queue Consumer","tags":["Queue"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.queue.create"]}}},"/accounts/{account_identifier}/workers/queues/{name}/consumers/{consumer_name}":{"delete":{"description":"Deletes the consumer for a queue.","operationId":"queue-delete-queue-consumer","parameters":[{"in":"path","name":"consumer_name","required":true,"schema":{"$ref":"#/components/schemas/consumer_name"}},{"in":"path","name":"name","required":true,"schema":{"$ref":"#/components/schemas/queues_components-schemas-name"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"nullable":true,"properties":{"result":{"nullable":true}}}]}}},"description":"Delete Queue Consumer response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"nullable":true,"properties":{"result":{"nullable":true}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Queue Consumer response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Queue Consumer","tags":["Queue"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.queue.delete"]}},"put":{"description":"Updates the consumer for a queue, or creates one if it does not exist.","operationId":"queue-update-queue-consumer","parameters":[{"in":"path","name":"consumer_name","required":true,"schema":{"$ref":"#/components/schemas/consumer_name"}},{"in":"path","name":"name","required":true,"schema":{"$ref":"#/components/schemas/queues_components-schemas-name"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"example":{"dead_letter_queue":"updated-example-dlq","environment":"production","script_name":"example-consumer","settings":{"batch_size":100}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/consumer_updated"}],"type":"object"}},"required":["queue_name","script_name","settings","dead_letter_queue","created_on"],"type":"object"}]}}},"description":"Update Queue Consumer response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/consumer_updated"}],"type":"object"}},"required":["queue_name","script_name","settings","dead_letter_queue","created_on"],"type":"object"}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Queue Consumer response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Queue Consumer","tags":["Queue"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.queue.update"]}}},"/accounts/{account_identifier}/workers/scripts":{"get":{"description":"Fetch a list of uploaded workers.","operationId":"worker-script-list-workers","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/script-response-collection-rhW1Gmt4"}}},"description":"List Workers response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/script-response-collection-rhW1Gmt4"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Workers response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Workers","tags":["Worker Script"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.script.list"]}}},"/accounts/{account_identifier}/workers/scripts/{script_name}":{"delete":{"description":"Delete your worker. This call has no response body on a successful delete.\n\n**Query paramaters**:\n\n1. `force`: boolean; If set to true, delete will not be stopped by associated service binding, durable object, or other binding. Any of these associated bindings/durable objects will be deleted along with the script.","operationId":"worker-script-delete-worker","parameters":[{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/script_name"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{}},"description":"Delete Worker response"},"4xx":{"content":{"application/json":{}},"description":"Delete Worker response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Worker","tags":["Worker Script"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.script.delete"]}},"get":{"description":"Fetch raw script content for your worker. Note this is the original script content, not JSON encoded.","operationId":"worker-script-download-worker","parameters":[{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/script_name"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"undefined":{"schema":{"example":"addEventListener('fetch', event =\u003e { event.respondWith(fetch(event.request)) })"}}},"description":"Download Worker response"},"4xx":{"content":{"undefined":{"schema":{"example":"addEventListener('fetch', event =\u003e { event.respondWith(fetch(event.request)) })"}}},"description":"Download Worker response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Download Worker","tags":["Worker Script"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.script.read"]}},"put":{"description":"Upload a worker module.","operationId":"worker-script-upload-worker-module","parameters":[{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/script_name"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"\"second-file.js\"":{"description":"Worker script.","example":"@second-file.js;type=application/javascript+module","type":"string"},"\"worker.js\"":{"description":"Worker script.","example":"@worker.js;type=application/javascript+module","type":"string"},"metadata":{"description":"Metadata for script such as bindings. Main module needs to be specified with `main_module`.","example":"{\"main_module\": \"worker.js\", \"some_binding\": \"stuff\"}","type":"string"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"example":{"errors":[],"messages":[],"result":{"created_on":"2022-05-05T05:15:11.602148Z","etag":"777f24a43bef5f69174aa69ceaf1dea67968d510a31d1vw3e49d34a0187c06d1","handlers":["fetch"],"id":"this-is_my_script-01","modified_on":"2022-05-20T19:02:56.446492Z","usage_model":"bundled"},"success":true}}}},"description":"Upload Worker Module response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"example":{"errors":[],"messages":[],"result":{"created_on":"2022-05-05T05:15:11.602148Z","etag":"777f24a43bef5f69174aa69ceaf1dea67968d510a31d1vw3e49d34a0187c06d1","handlers":["fetch"],"id":"this-is_my_script-01","modified_on":"2022-05-20T19:02:56.446492Z","usage_model":"bundled"},"success":true}},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Upload Worker Module response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Upload Worker Module","tags":["Worker Script"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.script.create"]}}},"/accounts/{account_identifier}/workers/scripts/{script_name}/schedules":{"get":{"description":"Fetches Cron Triggers for a Worker.","operationId":"worker-cron-trigger-get-cron-triggers","parameters":[{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/script_name"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cron-trigger-response-collection"}}},"description":"Get Cron Triggers response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cron-trigger-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Cron Triggers response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Cron Triggers","tags":["Worker Cron Trigger"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.cron.trigger.read"]}},"put":{"description":"Updates Cron Triggers for a Worker.","operationId":"worker-cron-trigger-update-cron-triggers","parameters":[{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/script_name"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"example":"[{'cron': '*/30 * * * *'}]"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cron-trigger-response-collection"}}},"description":"Update Cron Triggers response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cron-trigger-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Cron Triggers response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Cron Triggers","tags":["Worker Cron Trigger"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.cron.trigger.update"]}}},"/accounts/{account_identifier}/workers/scripts/{script_name}/tails":{"get":{"description":"Get list of tails currently deployed on a worker.","operationId":"worker-tail-logs-list-tails","parameters":[{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/script_name"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tail-response"}}},"description":"List Tails response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tail-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Tails response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Tails","tags":["Worker Tail Logs"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.script.read"]}},"post":{"description":"Starts a tail that receives logs and exception from a Worker.","operationId":"worker-tail-logs-start-tail","parameters":[{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/script_name"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/tail-response"}}},"description":"Start Tail response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/tail-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Start Tail response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Start Tail","tags":["Worker Tail Logs"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.script.read","com.cloudflare.edge.worker.tail.create"]}}},"/accounts/{account_identifier}/workers/scripts/{script_name}/tails/{id}":{"delete":{"description":"Deletes a tail from a Worker.","operationId":"worker-tail-logs-delete-tail","parameters":[{"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/schemas-id-OWr6ZoMG"}},{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/script_name"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common"}}},"description":"Delete Tail response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Tail response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Tail","tags":["Worker Tail Logs"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.script.read","com.cloudflare.edge.worker.tail.create"]}}},"/accounts/{account_identifier}/workers/scripts/{script_name}/usage-model":{"get":{"description":"Fetches the Usage Model for a given Worker.","operationId":"worker-script-fetch-usage-model","parameters":[{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/script_name"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/usage-model-response"}}},"description":"Fetch Usage Model response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/usage-model-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Fetch Usage Model response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Fetch Usage Model","tags":["Worker Script"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.script.read"]}},"put":{"description":"Updates the Usage Model for a given Worker. Requires a Workers Paid subscription.","operationId":"worker-script-update-usage-model","parameters":[{"in":"path","name":"script_name","required":true,"schema":{"$ref":"#/components/schemas/script_name"}},{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"example":"{'usage_model': 'unbound'}"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/usage-model-response"}}},"description":"Update Usage Model response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/usage-model-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Usage Model response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Usage Model","tags":["Worker Script"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.script.create"]}}},"/accounts/{account_identifier}/workers/subdomain":{"get":{"description":"Returns a Workers subdomain for an account.","operationId":"worker-subdomain-get-subdomain","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subdomain-response"}}},"description":"Get Subdomain response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/subdomain-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Subdomain response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Subdomain","tags":["Worker Subdomain"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.cron.subdomain.read"]}},"put":{"description":"Creates a Workers subdomain for an account.","operationId":"worker-subdomain-create-subdomain","parameters":[{"in":"path","name":"account_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"example":"{'subdomain': 'example-subdomain'}"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subdomain-response"}}},"description":"Create Subdomain response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/subdomain-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Subdomain response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Subdomain","tags":["Worker Subdomain"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.cron.subdomain.create"]}}},"/accounts/{account_id}/gateway/categories":{"get":{"description":"List all Categories.","operationId":"zero-trust-gateway-categories-list-categories","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/categories_components-schemas-response_collection"}}},"description":"List Categories response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/categories_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Categories response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Categories","tags":["Zero Trust Gateway Categories"]}},"/accounts/{account_id}/rulesets":{"get":{"description":"Fetches all rulesets at the account level.","operationId":"account-rulesets-list-account-rulesets","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rulesets_response"}}},"description":"List account rulesets response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rulesets_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List account rulesets response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List account rulesets","tags":["Account Rulesets"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Creates a ruleset at the account level.","operationId":"account-rulesets-create-an-account-ruleset","parameters":[{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_ruleset"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}},"description":"Create an account ruleset response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create an account ruleset response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create an account ruleset","tags":["Account Rulesets"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint":{"get":{"description":"Fetches the latest version of the account entry point ruleset for a given phase.","operationId":"account-rulesets-get-an-account-entry-point-ruleset","parameters":[{"in":"path","name":"ruleset_phase","required":true,"schema":{"$ref":"#/components/schemas/phase"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}},"description":"Get an account entry point ruleset response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get an account entry point ruleset response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get an account entry point ruleset","tags":["Account Rulesets"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Updates an account entry point ruleset, creating a new version.","operationId":"account-rulesets-update-an-account-entry-point-ruleset","parameters":[{"in":"path","name":"ruleset_phase","required":true,"schema":{"$ref":"#/components/schemas/phase"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_ruleset"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}},"description":"Update an account entry point ruleset response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update an account entry point ruleset response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update an account entry point ruleset","tags":["Account Rulesets"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions":{"get":{"description":"Fetches the versions of an account entry point ruleset.","operationId":"account-rulesets-list-an-account-entry-point-ruleset'-s-versions","parameters":[{"in":"path","name":"ruleset_phase","required":true,"schema":{"$ref":"#/components/schemas/phase"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rulesets_response"}}},"description":"List an account entry point ruleset's versions response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rulesets_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List an account entry point ruleset's versions response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List an account entry point ruleset's versions","tags":["Account Rulesets"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions/{ruleset_version}":{"get":{"description":"Fetches a specific version of an account entry point ruleset.","operationId":"account-rulesets-get-an-account-entry-point-ruleset-version","parameters":[{"in":"path","name":"ruleset_version","required":true,"schema":{"$ref":"#/components/schemas/version-VHkxmcSG"}},{"in":"path","name":"ruleset_phase","required":true,"schema":{"$ref":"#/components/schemas/phase"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}},"description":"Get an account entry point ruleset version response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get an account entry point ruleset version response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get an account entry point ruleset version","tags":["Account Rulesets"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/rulesets/{ruleset_id}":{"delete":{"description":"Deletes all versions of an existing account ruleset.","operationId":"account-rulesets-delete-an-account-ruleset","parameters":[{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{}},"description":"Delete an account ruleset response"},"4xx":{"content":{"application/json":{}},"description":"Delete an account ruleset response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete an account ruleset","tags":["Account Rulesets"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Fetches the latest version of an account ruleset.","operationId":"account-rulesets-get-an-account-ruleset","parameters":[{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}},"description":"Get an account ruleset response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get an account ruleset response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get an account ruleset","tags":["Account Rulesets"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Updates an account ruleset, creating a new version.","operationId":"account-rulesets-update-an-account-ruleset","parameters":[{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_ruleset"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}},"description":"Update an account ruleset response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update an account ruleset response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update an account ruleset","tags":["Account Rulesets"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/rulesets/{ruleset_id}/rules":{"post":{"description":"Adds a new rule to an account ruleset. The rule will be added to the end of the existing list of rules in the ruleset.","operationId":"account-rulesets-create-an-account-ruleset-rule","parameters":[{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_update_rule"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}},"description":"Create an account ruleset rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create an account ruleset rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create an account ruleset rule","tags":["Account Rulesets"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/rulesets/{ruleset_id}/rules/{rule_id}":{"delete":{"description":"Deletes an existing rule from an account ruleset.","operationId":"account-rulesets-delete-an-account-ruleset-rule","parameters":[{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/rules_components-schemas-id"}},{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}},"description":"Delete an account ruleset rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete an account ruleset rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete an account ruleset rule","tags":["Account Rulesets"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Updates an existing rule in an account ruleset.","operationId":"account-rulesets-update-an-account-ruleset-rule","parameters":[{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/rules_components-schemas-id"}},{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_update_rule"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}},"description":"Update an account ruleset rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update an account ruleset rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update an account ruleset rule","tags":["Account Rulesets"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/rulesets/{ruleset_id}/versions":{"get":{"description":"Fetches the versions of an account ruleset.","operationId":"account-rulesets-list-an-account-ruleset'-s-versions","parameters":[{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rulesets_response"}}},"description":"List an account ruleset's versions response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rulesets_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List an account ruleset's versions response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List an account ruleset's versions","tags":["Account Rulesets"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version}":{"delete":{"description":"Deletes an existing version of an account ruleset.","operationId":"account-rulesets-delete-an-account-ruleset-version","parameters":[{"in":"path","name":"ruleset_version","required":true,"schema":{"$ref":"#/components/schemas/version-VHkxmcSG"}},{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{}},"description":"Delete an account ruleset version response"},"4xx":{"content":{"application/json":{}},"description":"Delete an account ruleset version response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete an account ruleset version","tags":["Account Rulesets"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Fetches a specific version of an account ruleset.","operationId":"account-rulesets-get-an-account-ruleset-version","parameters":[{"in":"path","name":"ruleset_version","required":true,"schema":{"$ref":"#/components/schemas/version-VHkxmcSG"}},{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}},"description":"Get an account ruleset version response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get an account ruleset version response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get an account ruleset version","tags":["Account Rulesets"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version}/by_tag/{rule_tag}":{"get":{"description":"Fetches the rules of a managed account ruleset version for a given tag.","operationId":"account-rulesets-list-an-account-ruleset-version'-s-rules-by-tag","parameters":[{"in":"path","name":"rule_tag","required":true,"schema":{"$ref":"#/components/schemas/category"}},{"in":"path","name":"ruleset_version","required":true,"schema":{"$ref":"#/components/schemas/version-VHkxmcSG"}},{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"in":"path","name":"account_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}},"description":"List an account ruleset version's rules by tag response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List an account ruleset version's rules by tag response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List an account ruleset version's rules by tag","tags":["Account Rulesets"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{identifier}":{"get":{"description":"Get information about a specific account that you are a member of.","operationId":"accounts-account-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier-3n9sRq0H"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_single"}}},"description":"Account Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Account Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Account Details","tags":["Accounts"],"x-cfPermissionsRequired":{"enum":["#organization:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Update an existing account.","operationId":"accounts-update-account","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier-3n9sRq0H"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-account"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_single"}}},"description":"Update Account response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Account response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Account","tags":["Accounts"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/accounts/{identifier}/access/apps":{"get":{"description":"Lists all Access applications in an account.","operationId":"access-applications-list-access-applications","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/apps_components-schemas-response_collection"}}},"description":"List Access applications response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/apps_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Access applications response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Access applications","tags":["Access applications"]},"post":{"description":"Adds a new application to Access.","operationId":"access-applications-add-an-application","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/apps"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/apps_components-schemas-single_response"},{"properties":{"result":{"$ref":"#/components/schemas/apps"}}}]}}},"description":"Add an application response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/apps_components-schemas-single_response"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/bookmark_props"}]}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Add a Bookmark application response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Add an Access Application","tags":["Access applications"]}},"/accounts/{identifier}/access/apps/ca":{"get":{"description":"Lists short-lived certificate CAs and their public keys.","operationId":"access-short-lived-certificate-c-as-list-short-lived-certificate-c-as","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ca_components-schemas-response_collection"}}},"description":"List short-lived certificate CAs response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ca_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List short-lived certificate CAs response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List short-lived certificate CAs","tags":["Access short-lived certificate CAs"]}},"/accounts/{identifier}/access/apps/{app_id}":{"delete":{"description":"Deletes an application from Access.","operationId":"access-applications-delete-an-access-application","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/app_id-akwLjhUv"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-id_response-th0exOPu"}}},"description":"Delete an Access application response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-id_response-th0exOPu"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete an Access application response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete an Access application","tags":["Access applications"]},"get":{"description":"Fetches information about an Access application.","operationId":"access-applications-get-an-access-application","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/app_id-akwLjhUv"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/apps_components-schemas-single_response"}}},"description":"Get an Access application response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/apps_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get an Access application response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get an Access application","tags":["Access applications"]},"put":{"description":"Updates an Access application.","operationId":"access-applications-update-a-bookmark-application","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/app_id-akwLjhUv"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/apps"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/apps_components-schemas-single_response"},{"properties":{"result":{"$ref":"#/components/schemas/apps"}}}]}}},"description":"Update an Access application response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/apps_components-schemas-single_response"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/bookmark_props"}]}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update an Access application response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update an Access application","tags":["Access applications"]}},"/accounts/{identifier}/access/apps/{app_id}/revoke_tokens":{"post":{"description":"Revokes all service tokens used by an application.","operationId":"access-applications-revoke-service-tokens","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/app_id-akwLjhUv"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-empty_response"}}},"description":"Revoke service tokens response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-empty_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Revoke service tokens response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Revoke service tokens","tags":["Access applications"]}},"/accounts/{identifier}/access/apps/{app_id}/user_policy_checks":{"get":{"description":"Tests if a specific user has permission to access an application.","operationId":"access-applications-test-access-policies","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/app_id-akwLjhUv"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/policy_check_response"}}},"description":"Test Access policies response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/policy_check_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Test Access policies response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Test Access policies","tags":["Access applications"]}},"/accounts/{identifier}/access/apps/{uuid1}/policies/{uuid}":{"delete":{"description":"Delete an Access policy.","operationId":"access-policies-delete-an-access-policy","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-uuid"}},{"in":"path","name":"uuid1","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-uuid"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/policies_components-schemas-id_response"}}},"description":"Delete an Access policy response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/policies_components-schemas-id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete an Access policy response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete an Access policy","tags":["Access policies"]},"get":{"description":"Fetches a single Access policy.","operationId":"access-policies-get-an-access-policy","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-uuid"}},{"in":"path","name":"uuid1","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-uuid"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/policies_components-schemas-single_response"}}},"description":"Get an Access policy response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/policies_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get an Access policy response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get an Access policy","tags":["Access policies"]},"put":{"description":"Update a configured Access policy.","operationId":"access-policies-update-an-access-policy","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-uuid"}},{"in":"path","name":"uuid1","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-uuid"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"approval_groups":{"$ref":"#/components/schemas/approval_groups"},"approval_required":{"$ref":"#/components/schemas/approval_required"},"decision":{"$ref":"#/components/schemas/decision"},"exclude":{"$ref":"#/components/schemas/schemas-exclude"},"include":{"$ref":"#/components/schemas/include"},"name":{"$ref":"#/components/schemas/policies_components-schemas-name"},"precedence":{"$ref":"#/components/schemas/precedence-GXhj5toi"},"purpose_justification_prompt":{"$ref":"#/components/schemas/purpose_justification_prompt"},"purpose_justification_required":{"$ref":"#/components/schemas/purpose_justification_required"},"require":{"$ref":"#/components/schemas/schemas-require"}},"required":["name","decision","include"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/policies_components-schemas-single_response"}}},"description":"Update an Access policy response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/policies_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update an Access policy response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update an Access policy","tags":["Access policies"]}},"/accounts/{identifier}/access/apps/{uuid}/ca":{"delete":{"description":"Deletes a short-lived certificate CA.","operationId":"access-short-lived-certificate-c-as-delete-a-short-lived-certificate-ca","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-id_response-77ATe4Eu"}}},"description":"Delete a short-lived certificate CA response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-id_response-77ATe4Eu"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete a short-lived certificate CA response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete a short-lived certificate CA","tags":["Access short-lived certificate CAs"]},"get":{"description":"Fetches a short-lived certificate CA and its public key.","operationId":"access-short-lived-certificate-c-as-get-a-short-lived-certificate-ca","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ca_components-schemas-single_response"}}},"description":"Get a short-lived certificate CA response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ca_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get a short-lived certificate CA response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a short-lived certificate CA","tags":["Access short-lived certificate CAs"]},"post":{"description":"Generates a new short-lived certificate CA and public key.","operationId":"access-short-lived-certificate-c-as-create-a-short-lived-certificate-ca","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ca_components-schemas-single_response"}}},"description":"Create a short-lived certificate CA response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ca_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create a short-lived certificate CA response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create a short-lived certificate CA","tags":["Access short-lived certificate CAs"]}},"/accounts/{identifier}/access/apps/{uuid}/policies":{"get":{"description":"Lists Access policies configured for an application.","operationId":"access-policies-list-access-policies","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-uuid"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/policies_components-schemas-response_collection"}}},"description":"List Access policies response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/policies_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Access policies response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Access policies","tags":["Access policies"]},"post":{"description":"Create a new Access policy for an application.","operationId":"access-policies-create-an-access-policy","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-uuid"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"approval_groups":{"$ref":"#/components/schemas/approval_groups"},"approval_required":{"$ref":"#/components/schemas/approval_required"},"decision":{"$ref":"#/components/schemas/decision"},"exclude":{"$ref":"#/components/schemas/schemas-exclude"},"include":{"$ref":"#/components/schemas/include"},"name":{"$ref":"#/components/schemas/policies_components-schemas-name"},"precedence":{"$ref":"#/components/schemas/precedence-GXhj5toi"},"purpose_justification_prompt":{"$ref":"#/components/schemas/purpose_justification_prompt"},"purpose_justification_required":{"$ref":"#/components/schemas/purpose_justification_required"},"require":{"$ref":"#/components/schemas/schemas-require"}},"required":["name","decision","include"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/policies_components-schemas-single_response"}}},"description":"Create an Access policy response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/policies_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create an Access policy response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create an Access policy","tags":["Access policies"]}},"/accounts/{identifier}/access/bookmarks":{"get":{"deprecated":true,"description":"Lists Bookmark applications.","operationId":"access-bookmark-applications-(-deprecated)-list-bookmark-applications","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bookmarks_components-schemas-response_collection"}}},"description":"List Bookmark applications response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/bookmarks_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Bookmark applications response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Bookmark applications","tags":["Access Bookmark applications (Deprecated)"],"x-cfDeprecation":{"description":"This endpoint is deprecated in favor of using a specialized Access Application App Type.","display":true,"eol":"2023-03-19","id":"bookmarks_deprecation"}}},"/accounts/{identifier}/access/bookmarks/{uuid}":{"delete":{"deprecated":true,"description":"Deletes a Bookmark application.","operationId":"access-bookmark-applications-(-deprecated)-delete-a-bookmark-application","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-id_response-th0exOPu"}}},"description":"Delete a Bookmark application response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-id_response-th0exOPu"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete a Bookmark application response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete a Bookmark application","tags":["Access Bookmark applications (Deprecated)"],"x-cfDeprecation":{"description":"This endpoint is deprecated in favor of using a specialized Access Application App Type.","display":true,"eol":"2023-03-19","id":"bookmarks_deprecation"}},"get":{"deprecated":true,"description":"Fetches a single Bookmark application.","operationId":"access-bookmark-applications-(-deprecated)-get-a-bookmark-application","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bookmarks_components-schemas-single_response"}}},"description":"Get a Bookmark application response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/bookmarks_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get a Bookmark application response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a Bookmark application","tags":["Access Bookmark applications (Deprecated)"],"x-cfDeprecation":{"description":"This endpoint is deprecated in favor of using a specialized Access Application App Type.","display":true,"eol":"2023-03-19","id":"bookmarks_deprecation"}},"post":{"deprecated":true,"description":"Create a new Bookmark application.","operationId":"access-bookmark-applications-(-deprecated)-create-a-bookmark-application","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bookmarks_components-schemas-single_response"}}},"description":"Create a Bookmark application response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/bookmarks_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create a Bookmark application response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create a Bookmark application","tags":["Access Bookmark applications (Deprecated)"],"x-cfDeprecation":{"description":"This endpoint is deprecated in favor of using a specialized Access Application App Type.","display":true,"eol":"2023-03-19","id":"bookmarks_deprecation"}},"put":{"deprecated":true,"description":"Updates a configured Bookmark application.","operationId":"access-bookmark-applications-(-deprecated)-update-a-bookmark-application","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/bookmarks_components-schemas-single_response"}}},"description":"Update a Bookmark application response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/bookmarks_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update a Bookmark application response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update a Bookmark application","tags":["Access Bookmark applications (Deprecated)"],"x-cfDeprecation":{"description":"This endpoint is deprecated in favor of using a specialized Access Application App Type.","display":true,"eol":"2023-03-19","id":"bookmarks_deprecation"}}},"/accounts/{identifier}/access/certificates":{"get":{"description":"Lists all mTLS root certificates.","operationId":"access-m-tls-authentication-list-m-tls-certificates","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificates_components-schemas-response_collection"}}},"description":"List mTLS certificates response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificates_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List mTLS certificates response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List mTLS certificates","tags":["Access mTLS authentication"]},"post":{"description":"Adds a new mTLS root certificate to Access.","operationId":"access-m-tls-authentication-add-an-m-tls-certificate","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"associated_hostnames":{"$ref":"#/components/schemas/associated_hostnames"},"certificate":{"description":"The certificate content.","example":"-----BEGIN CERTIFICATE-----\nMIIGAjCCA+qgAwIBAgIJAI7kymlF7CWT...N4RI7KKB7nikiuUf8vhULKy5IX10\nDrUtmu/B\n-----END CERTIFICATE-----","type":"string"},"name":{"$ref":"#/components/schemas/certificates_components-schemas-name"}},"required":["name","certificate"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificates_components-schemas-single_response"}}},"description":"Add an mTLS certificate response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificates_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Add an mTLS certificate response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Add an mTLS certificate","tags":["Access mTLS authentication"]}},"/accounts/{identifier}/access/certificates/{uuid}":{"delete":{"description":"Deletes an mTLS certificate.","operationId":"access-m-tls-authentication-delete-an-m-tls-certificate","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-id_response-th0exOPu"}}},"description":"Delete an mTLS certificate response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-id_response-th0exOPu"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete an mTLS certificate response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete an mTLS certificate","tags":["Access mTLS authentication"]},"get":{"description":"Fetches a single mTLS certificate.","operationId":"access-m-tls-authentication-get-an-m-tls-certificate","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificates_components-schemas-single_response"}}},"description":"Get an mTLS certificate response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificates_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get an mTLS certificate response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get an mTLS certificate","tags":["Access mTLS authentication"]},"put":{"description":"Updates a configured mTLS certificate.","operationId":"access-m-tls-authentication-update-an-m-tls-certificate","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"associated_hostnames":{"$ref":"#/components/schemas/associated_hostnames"},"name":{"$ref":"#/components/schemas/certificates_components-schemas-name"}},"required":["name","associated_hostnames"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificates_components-schemas-single_response"}}},"description":"Update an mTLS certificate response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificates_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update an mTLS certificate response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update an mTLS certificate","tags":["Access mTLS authentication"]}},"/accounts/{identifier}/access/groups":{"get":{"description":"Lists all Access groups.","operationId":"access-groups-list-access-groups","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-response_collection-4HEckTYK"}}},"description":"List Access groups response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-response_collection-4HEckTYK"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Access groups response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Access groups","tags":["Access groups"]},"post":{"description":"Creates a new Access group.","operationId":"access-groups-create-an-access-group","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"exclude":{"$ref":"#/components/schemas/exclude"},"include":{"$ref":"#/components/schemas/include"},"name":{"$ref":"#/components/schemas/components-schemas-name-4G3Rlgj8"},"require":{"$ref":"#/components/schemas/require"}},"required":["name","include"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-single_response-gP2O4PI2"}}},"description":"Create an Access group response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-single_response-gP2O4PI2"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create an Access group response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create an Access group","tags":["Access groups"]}},"/accounts/{identifier}/access/groups/{uuid}":{"delete":{"description":"Deletes an Access group.","operationId":"access-groups-delete-an-access-group","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/schemas-uuid-JmfIpL8C"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/id_response-DDywCCxj"}}},"description":"Delete an Access group response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/id_response-DDywCCxj"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete an Access group response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete an Access group","tags":["Access groups"]},"get":{"description":"Fetches a single Access group.","operationId":"access-groups-get-an-access-group","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/schemas-uuid-JmfIpL8C"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-single_response-gP2O4PI2"}}},"description":"Get an Access group response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-single_response-gP2O4PI2"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get an Access group response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get an Access group","tags":["Access groups"]},"put":{"description":"Updates a configured Access group.","operationId":"access-groups-update-an-access-group","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/schemas-uuid-JmfIpL8C"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"exclude":{"$ref":"#/components/schemas/exclude"},"include":{"$ref":"#/components/schemas/include"},"name":{"$ref":"#/components/schemas/components-schemas-name-4G3Rlgj8"},"require":{"$ref":"#/components/schemas/require"}},"required":["name","include"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-single_response-gP2O4PI2"}}},"description":"Update an Access group response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-single_response-gP2O4PI2"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update an Access group response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update an Access group","tags":["Access groups"]}},"/accounts/{identifier}/access/identity_providers":{"get":{"description":"Lists all configured identity providers.","operationId":"access-identity-providers-list-access-identity-providers","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_collection-oP3HzZox"}}},"description":"List Access identity providers response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_collection-oP3HzZox"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Access identity providers response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Access identity providers","tags":["Access identity providers"]},"post":{"description":"Adds a new identity provider to Access.","operationId":"access-identity-providers-add-an-access-identity-provider","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity-providers"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-single_response-CwUTnlnC"}}},"description":"Add an Access identity provider response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-single_response-CwUTnlnC"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Add an Access identity provider response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Add an Access identity provider","tags":["Access identity providers"]}},"/accounts/{identifier}/access/identity_providers/{uuid}":{"delete":{"description":"Deletes an identity provider from Access.","operationId":"access-identity-providers-delete-an-access-identity-provider","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single-id"}}},"description":"Delete an Access identity provider response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-single_response-CwUTnlnC"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete an Access identity provider response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete an Access identity provider","tags":["Access identity providers"]},"get":{"description":"Fetches a configured identity provider.","operationId":"access-identity-providers-get-an-access-identity-provider","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-single_response-CwUTnlnC"}}},"description":"Get an Access identity provider response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-single_response-CwUTnlnC"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get an Access identity provider response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get an Access identity provider","tags":["Access identity providers"]},"put":{"description":"Updates a configured identity provider.","operationId":"access-identity-providers-update-an-access-identity-provider","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity-providers"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-single_response-CwUTnlnC"}}},"description":"Update an Access identity provider response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-single_response-CwUTnlnC"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update an Access identity provider response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update an Access identity provider","tags":["Access identity providers"]}},"/accounts/{identifier}/access/keys":{"get":{"description":"Gets the Access key rotation settings for an account.","operationId":"access-key-configuration-get-the-access-key-configuration","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/keys_components-schemas-single_response"}}},"description":"Get the Access key configuration response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/keys_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get the Access key configuration response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get the Access key configuration","tags":["Access key configuration"]},"put":{"description":"Updates the Access key rotation settings for an account.","operationId":"access-key-configuration-update-the-access-key-configuration","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"key_rotation_interval_days":{"$ref":"#/components/schemas/key_rotation_interval_days"}},"required":["key_rotation_interval_days"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/keys_components-schemas-single_response"}}},"description":"Update the Access key configuration response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/keys_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update the Access key configuration response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update the Access key configuration","tags":["Access key configuration"]}},"/accounts/{identifier}/access/keys/rotate":{"post":{"description":"Perfoms a key rotation for an account.","operationId":"access-key-configuration-rotate-access-keys","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/keys_components-schemas-single_response"}}},"description":"Rotate Access keys response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/keys_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Rotate Access keys response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Rotate Access keys","tags":["Access key configuration"]}},"/accounts/{identifier}/access/logs/access_requests":{"get":{"description":"Gets a list of Access authentication audit logs for an account.","operationId":"access-authentication-logs-get-access-authentication-logs","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/access-requests_components-schemas-response_collection"}}},"description":"Get Access authentication logs response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/access-requests_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Access authentication logs response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Access authentication logs","tags":["Access authentication logs"]}},"/accounts/{identifier}/access/organizations":{"get":{"description":"Returns the configuration for your Zero Trust organization.","operationId":"zero-trust-organization-get-your-zero-trust-organization","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response-x2K6CTG8"}}},"description":"Get your Zero Trust organization response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response-x2K6CTG8"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get your Zero Trust organization response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get your Zero Trust organization","tags":["Zero Trust organization"]},"post":{"description":"Sets up a Zero Trust organization for your account.","operationId":"zero-trust-organization-create-your-zero-trust-organization","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"auth_domain":{"$ref":"#/components/schemas/auth_domain"},"auto_redirect_to_identity":{"$ref":"#/components/schemas/auto_redirect_to_identity"},"is_ui_read_only":{"$ref":"#/components/schemas/is_ui_read_only"},"login_design":{"$ref":"#/components/schemas/login_design"},"name":{"$ref":"#/components/schemas/name-xgxcxGi8"},"ui_read_only_toggle_reason":{"$ref":"#/components/schemas/ui_read_only_toggle_reason"},"user_seat_expiration_inactive_time":{"$ref":"#/components/schemas/user_seat_expiration_inactive_time"}},"required":["name","auth_domain"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response-x2K6CTG8"}}},"description":"Create your Zero Trust organization response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response-x2K6CTG8"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create your Zero Trust organization response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create your Zero Trust organization","tags":["Zero Trust organization"]},"put":{"description":"Updates the configuration for your Zero Trust organization.","operationId":"zero-trust-organization-update-your-zero-trust-organization","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"auth_domain":{"$ref":"#/components/schemas/auth_domain"},"auto_redirect_to_identity":{"$ref":"#/components/schemas/auto_redirect_to_identity"},"is_ui_read_only":{"$ref":"#/components/schemas/is_ui_read_only"},"login_design":{"$ref":"#/components/schemas/login_design"},"name":{"$ref":"#/components/schemas/name-xgxcxGi8"},"ui_read_only_toggle_reason":{"$ref":"#/components/schemas/ui_read_only_toggle_reason"},"user_seat_expiration_inactive_time":{"$ref":"#/components/schemas/user_seat_expiration_inactive_time"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response-x2K6CTG8"}}},"description":"Update your Zero Trust organization response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response-x2K6CTG8"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update your Zero Trust organization response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update your Zero Trust organization","tags":["Zero Trust organization"]}},"/accounts/{identifier}/access/organizations/revoke_user":{"post":{"description":"Revokes a user's access across all applications.","operationId":"zero-trust-organization-revoke-all-access-tokens-for-a-user","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"email":{"description":"The email of the user to revoke.","example":"test@example.com","type":"string"}},"required":["email"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/empty_response-47a5DGxM"}}},"description":"Revoke all Access tokens for a user response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/empty_response-47a5DGxM"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Revoke all Access tokens for a user response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Revoke all Access tokens for a user","tags":["Zero Trust organization"]}},"/accounts/{identifier}/access/seats":{"patch":{"description":"Removes a user from a Zero Trust seat when both `access_seat` and `gateway_seat` are set to false.","operationId":"zero-trust-seats-update-a-user-seat","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/seats_definition"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/seats_components-schemas-response_collection"}}},"description":"Update a user seat response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/seats_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update a user seat response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update a user seat","tags":["Zero Trust seats"]}},"/accounts/{identifier}/access/service_tokens":{"get":{"description":"Lists all service tokens.","operationId":"access-service-tokens-list-service-tokens","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-response_collection-Qou49Scv"}}},"description":"List service tokens response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-response_collection-Qou49Scv"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List service tokens response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List service tokens","tags":["Access service tokens"]},"post":{"description":"Generates a new service token. **Note:** This is the only time you can get the Client Secret. If you lose the Client Secret, you will have to rotate the Client Secret or create a new service token.","operationId":"access-service-tokens-create-a-service-token","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"$ref":"#/components/schemas/service-tokens_components-schemas-name"}},"required":["name"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_response"}}},"description":"Create a service token response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/create_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create a service token response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create a service token","tags":["Access service tokens"]}},"/accounts/{identifier}/access/service_tokens/{uuid}":{"delete":{"description":"Deletes a service token.","operationId":"access-service-tokens-delete-a-service-token","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/service-tokens_components-schemas-single_response"}}},"description":"Delete a service token response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/service-tokens_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete a service token response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete a service token","tags":["Access service tokens"]},"put":{"description":"Updates a configured service token.","operationId":"access-service-tokens-update-a-service-token","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"$ref":"#/components/schemas/service-tokens_components-schemas-name"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/service-tokens_components-schemas-single_response"}}},"description":"Update a service token response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/service-tokens_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update a service token response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update a service token","tags":["Access service tokens"]}},"/accounts/{identifier}/access/service_tokens/{uuid}/refresh":{"post":{"description":"Refreshes the expiration of a service token.","operationId":"access-service-tokens-refresh-a-service-token","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/service-tokens_components-schemas-single_response"}}},"description":"Refresh a service token response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/service-tokens_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Refresh a service token response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Refresh a service token","tags":["Access service tokens"]}},"/accounts/{identifier}/access/service_tokens/{uuid}/rotate":{"post":{"description":"Generates a new Client Secret for a service token and revokes the old one.","operationId":"access-service-tokens-rotate-a-service-token","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_response"}}},"description":"Rotate a service token response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/create_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Rotate a service token response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Rotate a service token","tags":["Access service tokens"]}},"/accounts/{identifier}/access/users":{"get":{"description":"Gets a list of users for an account.","operationId":"zero-trust-users-get-users","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/users_components-schemas-response_collection"}}},"description":"Get users response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/users_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get users response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get users","tags":["Zero Trust users"]}},"/accounts/{identifier}/access/users/{id}/failed_logins":{"get":{"description":"Get all failed login attempts for a single user.","operationId":"zero-trust-users-get-failed-logins","parameters":[{"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/schemas-id"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/failed_login_response"}}},"description":"Get failed logins response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/failed_login_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get failed logins response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get failed logins","tags":["Zero Trust users"]}},"/accounts/{identifier}/alerting/v3/destinations/eligible":{"get":{"description":"Get a list of all delivery mechanism types for which an account is eligible.","operationId":"notification-mechanism-eligibility-get-delivery-mechanism-eligibility","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/eligibility_components-schemas-response_collection"}}},"description":"Get delivery mechanism eligibility response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/eligibility_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get delivery mechanism eligibility response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get delivery mechanism eligibility","tags":["Notification Mechanism Eligibility"]}},"/accounts/{identifier}/alerting/v3/destinations/pagerduty":{"get":{"description":"Get a list of all configured PagerDuty services.","operationId":"notification-destinations-with-pager-duty-list-pager-duty-services","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pagerduty_components-schemas-response_collection"}}},"description":"List PagerDuty services response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pagerduty_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List PagerDuty services response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List PagerDuty services","tags":["Notification destinations with PagerDuty"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/accounts/{identifier}/alerting/v3/destinations/webhooks":{"get":{"description":"Gets a list of all configured webhook destinations.","operationId":"notification-webhooks-list-webhooks","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhooks_components-schemas-response_collection"}}},"description":"List webhooks response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/webhooks_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List webhooks response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List webhooks","tags":["Notification webhooks"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"post":{"description":"Creates a new webhook destination.","operationId":"notification-webhooks-create-a-webhook","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"$ref":"#/components/schemas/webhooks_components-schemas-name"},"secret":{"$ref":"#/components/schemas/secret-QjCIBSp3"},"url":{"$ref":"#/components/schemas/webhooks_components-schemas-url"}},"required":["name","url"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhooks_components-schemas-id_response"}}},"description":"Create a webhook response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/webhooks_components-schemas-id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create a webhook response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create a webhook","tags":["Notification webhooks"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/accounts/{identifier}/alerting/v3/destinations/webhooks/{uuid}":{"delete":{"description":"Delete a configured webhook destination.","operationId":"notification-webhooks-delete-a-webhook","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-s0SXln0q"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-collection"}}},"description":"Delete a webhook response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete a webhook response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete a webhook","tags":["Notification webhooks"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"get":{"description":"Get details for a single webhooks destination.","operationId":"notification-webhooks-get-a-webhook","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-s0SXln0q"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhooks_components-schemas-single_response"}}},"description":"Get a webhook response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/webhooks_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get a webhook response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a webhook","tags":["Notification webhooks"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"put":{"description":"Update a webhook destination.","operationId":"notification-webhooks-update-a-webhook","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-s0SXln0q"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"$ref":"#/components/schemas/webhooks_components-schemas-name"},"secret":{"$ref":"#/components/schemas/secret-QjCIBSp3"},"url":{"$ref":"#/components/schemas/webhooks_components-schemas-url"}},"required":["name","url"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhooks_components-schemas-id_response"}}},"description":"Update a webhook response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/webhooks_components-schemas-id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update a webhook response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update a webhook","tags":["Notification webhooks"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/accounts/{identifier}/alerting/v3/history":{"get":{"description":"Gets a list of history records for notifications sent to an account. The records are displayed for last `x` number of days based on the zone plan (free = 30, pro = 30, biz = 30, ent = 90).","operationId":"notification-history-list-history","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"per_page","schema":{"$ref":"#/components/schemas/history_components-schemas-per_page"}},{"in":"query","name":"before","schema":{"$ref":"#/components/schemas/before"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"since","schema":{"description":"Limit the returned results to history records newer than the specified date. This must be a timestamp that conforms to RFC3339.","example":"2022-05-19T20:29:58.679897Z","format":"date-time","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/history_components-schemas-response_collection"}}},"description":"List History response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/history_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List History response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List History","tags":["Notification History"]}},"/accounts/{identifier}/alerting/v3/policies":{"get":{"description":"Get a list of all Notification policies.","operationId":"notification-policies-list-notification-policies","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/policies_components-schemas-response_collection-2"}}},"description":"List Notification policies response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/policies_components-schemas-response_collection-2"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Notification policies response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Notification policies","tags":["Notification policies"]},"post":{"description":"Creates a new Notification policy.","operationId":"notification-policies-create-a-notification-policy","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"alert_type":{"$ref":"#/components/schemas/alert_type"},"description":{"$ref":"#/components/schemas/policies_components-schemas-description"},"enabled":{"$ref":"#/components/schemas/policies_components-schemas-enabled"},"filters":{"$ref":"#/components/schemas/components-schemas-filters"},"mechanisms":{"$ref":"#/components/schemas/mechanisms"},"name":{"$ref":"#/components/schemas/policies_components-schemas-name-2"}},"required":["name","alert_type","enabled","mechanisms"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/policies_components-schemas-id_response-2"}}},"description":"Create a Notification policy response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/policies_components-schemas-id_response-2"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create a Notification policy response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create a Notification policy","tags":["Notification policies"]}},"/accounts/{identifier}/alerting/v3/policies/{uuid}":{"delete":{"description":"Delete a Notification policy.","operationId":"notification-policies-delete-a-notification-policy","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-s0SXln0q"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-collection"}}},"description":"Delete a Notification policy response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete a Notification policy response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete a Notification policy","tags":["Notification policies"]},"get":{"description":"Get details for a single policy.","operationId":"notification-policies-get-a-notification-policy","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-s0SXln0q"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/policies_components-schemas-single_response-2"}}},"description":"Get a Notification policy response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/policies_components-schemas-single_response-2"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get a Notification policy response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a Notification policy","tags":["Notification policies"]},"put":{"description":"Update a Notification policy.","operationId":"notification-policies-update-a-notification-policy","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-s0SXln0q"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"alert_type":{"$ref":"#/components/schemas/alert_type"},"description":{"$ref":"#/components/schemas/policies_components-schemas-description"},"enabled":{"$ref":"#/components/schemas/policies_components-schemas-enabled"},"filters":{"$ref":"#/components/schemas/components-schemas-filters"},"mechanisms":{"$ref":"#/components/schemas/mechanisms"},"name":{"$ref":"#/components/schemas/policies_components-schemas-name-2"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/policies_components-schemas-id_response-2"}}},"description":"Update a Notification policy response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/policies_components-schemas-id_response-2"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update a Notification policy response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update a Notification policy","tags":["Notification policies"]}},"/accounts/{identifier}/custom_ns":{"get":{"description":"List an account's custom nameservers.","operationId":"account-level-custom-nameservers-list-account-custom-nameservers","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-oBX6a2Mp"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/acns_response_collection"}}},"description":"List Account Custom Nameservers response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/acns_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Account Custom Nameservers response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Account Custom Nameservers","tags":["Account-Level Custom Nameservers"],"x-cfPermissionsRequired":{"enum":["#organization:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"post":{"operationId":"account-level-custom-nameservers-add-account-custom-nameserver","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-oBX6a2Mp"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomNSInput"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/acns_response_single"}}},"description":"Add Account Custom Nameserver response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/acns_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Add Account Custom Nameserver response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Add Account Custom Nameserver","tags":["Account-Level Custom Nameservers"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/accounts/{identifier}/custom_ns/availability":{"get":{"operationId":"account-level-custom-nameservers-get-eligible-zones-for-account-custom-nameservers","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-oBX6a2Mp"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/availability_response"}}},"description":"Get Eligible Zones for Account Custom Nameservers response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/availability_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Eligible Zones for Account Custom Nameservers response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Eligible Zones for Account Custom Nameservers","tags":["Account-Level Custom Nameservers"],"x-cfPermissionsRequired":{"enum":["#organization:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/accounts/{identifier}/custom_ns/verify":{"post":{"deprecated":true,"operationId":"account-level-custom-nameservers-verify-account-custom-nameserver-glue-records","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-oBX6a2Mp"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/acns_response_collection"}}},"description":"Verify Account Custom Nameserver Glue Records response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/acns_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Verify Account Custom Nameserver Glue Records response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Verify Account Custom Nameserver Glue Records","tags":["Account-Level Custom Nameservers"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/accounts/{identifier}/custom_ns/{ns_name}":{"delete":{"operationId":"account-level-custom-nameservers-delete-account-custom-nameserver","parameters":[{"in":"path","name":"ns_name","required":true,"schema":{"$ref":"#/components/schemas/ns_name"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-oBX6a2Mp"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/empty_response-V46LqGZw"}}},"description":"Delete Account Custom Nameserver response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/empty_response-V46LqGZw"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Account Custom Nameserver response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Account Custom Nameserver","tags":["Account-Level Custom Nameservers"],"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/accounts/{identifier}/devices":{"get":{"description":"List Enrolled Devices.","operationId":"devices-list-devices","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/devices_response"}}},"description":"List Devices response."},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/devices_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Devices response failure."}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Devices","tags":["Devices"]}},"/accounts/{identifier}/devices/dex_tests":{"get":{"description":"Fetch all DEX tests.","operationId":"device-dex-test-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dex-response_collection"}}},"description":"Device DEX test details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dex-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Device DEX test response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Device DEX tests","tags":["Device DEX Tests"]},"post":{"description":"Create a DEX test.","operationId":"device-dex-test-create-device-dex-test","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/device-dex-test-schemas-http"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dex-single_response"}}},"description":"Update Dex test response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dex-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Dex test response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Device DEX test","tags":["Device DEX Tests"]}},"/accounts/{identifier}/devices/dex_tests/{uuid}":{"delete":{"description":"Delete a Device DEX test. Returns the remaining device dex tests for the account.","operationId":"device-dex-test-delete-device-dex-test","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}},{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-l20MFQPz"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dex-response_collection"}}},"description":"Delete Device DEX test response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dex-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete DEX test response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Device DEX test","tags":["Device DEX Tests"]},"get":{"description":"Fetch a single DEX test.","operationId":"device-dex-test-get-device-dex-test","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}},{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-l20MFQPz"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dex-single_response"}}},"description":"Device DEX test details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dex-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Device DEX test response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Device DEX test","tags":["Device DEX Tests"]},"put":{"description":"Update a DEX test.","operationId":"device-dex-test-update-device-dex-test","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}},{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-l20MFQPz"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/device-dex-test-schemas-http"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dex-single_response"}}},"description":"Update Dex test response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dex-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Dex test response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Device DEX test","tags":["Device DEX Tests"]}},"/accounts/{identifier}/devices/networks":{"get":{"description":"List Managed Networks for an account.","operationId":"device-managed-networks-list-device-managed-networks","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-response_collection-6gfWBAmq"}}},"description":"List Device Managed Networks response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-response_collection-6gfWBAmq"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Device Managed Networks response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Device Managed Networks","tags":["Device Managed Networks"]},"post":{"description":"Create a new Device Managed Network.","operationId":"device-managed-networks-create-device-managed-network","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"config":{"$ref":"#/components/schemas/schemas-config_request"},"name":{"$ref":"#/components/schemas/device-managed-networks_components-schemas-name"},"type":{"$ref":"#/components/schemas/components-schemas-type-KlrF1JPW"}},"required":["name","type","config"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-single_response-ar7Y7q7I"}}},"description":"Create Device Managed Network response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-single_response-ar7Y7q7I"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Device Managed Network response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Device Managed Network","tags":["Device Managed Networks"]}},"/accounts/{identifier}/devices/networks/{uuid}":{"delete":{"description":"Delete a Device Managed Network. Returns the remaining Device Managed Networks for the account.","operationId":"device-managed-networks-delete-device-managed-network","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-l20MFQPz"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-response_collection-6gfWBAmq"}}},"description":"Delete Device Managed Network response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-response_collection-6gfWBAmq"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Device Managed Network response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Device Managed Network","tags":["Device Managed Networks"]},"get":{"description":"Fetch a single Managed Network.","operationId":"device-managed-networks-device-managed-network-details","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-l20MFQPz"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-single_response-ar7Y7q7I"}}},"description":"Device Managed Network Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-single_response-ar7Y7q7I"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Device Managed Network Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Device Managed Network Details","tags":["Device Managed Networks"]},"put":{"description":"Update a Device Managed Network.","operationId":"device-managed-networks-update-device-managed-network","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-l20MFQPz"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"config":{"$ref":"#/components/schemas/schemas-config_request"},"name":{"$ref":"#/components/schemas/device-managed-networks_components-schemas-name"},"type":{"$ref":"#/components/schemas/components-schemas-type-KlrF1JPW"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-single_response-ar7Y7q7I"}}},"description":"Update Device Managed Network response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-single_response-ar7Y7q7I"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Device Managed Network response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Device Managed Network","tags":["Device Managed Networks"]}},"/accounts/{identifier}/devices/policies":{"get":{"description":"Lists the device settings policies for an account.","operationId":"devices-list-device-settings-policies","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_settings_response_collection"}}},"description":"List Device Settings Policies response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/device_settings_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Device Settings Policies response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Device Settings Policies","tags":["Devices"]}},"/accounts/{identifier}/devices/policy":{"get":{"description":"Get the default device settings policy for an account.","operationId":"devices-get-default-device-settings-policy","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/default_device_settings_response"}}},"description":"Get Default Device Settings Policy response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/default_device_settings_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Default Device Settings Policy response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Default Device Settings Policy","tags":["Devices"]},"patch":{"description":"Update the default device settings policy for an account.","operationId":"devices-update-default-device-settings-policy","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"allow_mode_switch":{"$ref":"#/components/schemas/allow_mode_switch"},"allow_updates":{"$ref":"#/components/schemas/allow_updates"},"allowed_to_leave":{"$ref":"#/components/schemas/allowed_to_leave"},"auto_connect":{"$ref":"#/components/schemas/auto_connect"},"captive_portal":{"$ref":"#/components/schemas/captive_portal"},"disable_auto_fallback":{"$ref":"#/components/schemas/disable_auto_fallback"},"exclude_office_ips":{"$ref":"#/components/schemas/exclude_office_ips"},"service_mode_v2":{"$ref":"#/components/schemas/service_mode_v2"},"support_url":{"$ref":"#/components/schemas/support_url"},"switch_locked":{"$ref":"#/components/schemas/switch_locked"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/default_device_settings_response"}}},"description":"Update Default Device Settings Policy response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/default_device_settings_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Default Device Settings Policy response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Default Device Settings Policy","tags":["Devices"]},"post":{"description":"Create a device settings policy to be applied to certain devices matching the criteria.","operationId":"devices-create-device-settings-policy","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"allow_mode_switch":{"$ref":"#/components/schemas/allow_mode_switch"},"allow_updates":{"$ref":"#/components/schemas/allow_updates"},"allowed_to_leave":{"$ref":"#/components/schemas/allowed_to_leave"},"auto_connect":{"$ref":"#/components/schemas/auto_connect"},"captive_portal":{"$ref":"#/components/schemas/captive_portal"},"description":{"$ref":"#/components/schemas/schemas-description-jdg4o19i"},"disable_auto_fallback":{"$ref":"#/components/schemas/disable_auto_fallback"},"enabled":{"description":"Whether the policy will be applied to matching devices.","example":true,"type":"boolean"},"exclude_office_ips":{"$ref":"#/components/schemas/exclude_office_ips"},"match":{"$ref":"#/components/schemas/schemas-match-ImQchlrH"},"name":{"description":"The name of the device settings policy.","example":"Allow Developers","maxLength":100,"type":"string"},"precedence":{"$ref":"#/components/schemas/precedence-HZLvpi3q"},"service_mode_v2":{"$ref":"#/components/schemas/service_mode_v2"},"support_url":{"$ref":"#/components/schemas/support_url"},"switch_locked":{"$ref":"#/components/schemas/switch_locked"}},"required":["name","precedence","match"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_settings_response"}}},"description":"Create Device Settings Policy response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/device_settings_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Device Settings Policy response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Device Settings Policy","tags":["Devices"]}},"/accounts/{identifier}/devices/policy/exclude":{"get":{"description":"Get the list of routes excluded from the WARP client's tunnel.","operationId":"devices-get-split-tunnel-exclude-list","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/split_tunnel_response_collection"}}},"description":"Get Split Tunnel Exclude List response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/split_tunnel_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Split Tunnel Exclude List response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Split Tunnel Exclude List","tags":["Devices"]},"put":{"description":"Set the list of routes excluded from the WARP client's tunnel.","operationId":"devices-set-split-tunnel-exclude-list","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/split_tunnel"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/split_tunnel_response_collection"}}},"description":"Set Split Tunnel Exclude List response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/split_tunnel_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Set Split Tunnel Exclude List response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Set Split Tunnel Exclude List","tags":["Devices"]}},"/accounts/{identifier}/devices/policy/fallback_domains":{"get":{"description":"Get the list of domains to bypass Gateway for DNS resolution and instead use the specified server.","operationId":"devices-get-local-domain-fallback-list","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/fallback_domain_response_collection"}}},"description":"Get Local Domain Fallback List response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/fallback_domain_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Local Domain Fallback List response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Local Domain Fallback List","tags":["Devices"]},"put":{"description":"Set the list of domains to bypass Gateway for DNS resolution and instead use the specified server.","operationId":"devices-set-local-domain-fallback-list","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/fallback_domain"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/fallback_domain_response_collection"}}},"description":"Set Local Domain Fallback List response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/fallback_domain_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Set Local Domain Fallback List response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Set Local Domain Fallback List","tags":["Devices"]}},"/accounts/{identifier}/devices/policy/include":{"get":{"description":"Get the list of routes included in the WARP client's tunnel.","operationId":"devices-get-split-tunnel-include-list","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/split_tunnel_include_response_collection"}}},"description":"Get Split Tunnel Include List response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/split_tunnel_include_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Split Tunnel Include List response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Split Tunnel Include List","tags":["Devices"]},"put":{"description":"Set the list of routes included in the WARP client's tunnel.","operationId":"devices-set-split-tunnel-include-list","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/split_tunnel_include"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/split_tunnel_include_response_collection"}}},"description":"Set Split Tunnel Include List response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/split_tunnel_include_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Set Split Tunnel Include List response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Set Split Tunnel Include List","tags":["Devices"]}},"/accounts/{identifier}/devices/policy/{uuid}":{"delete":{"description":"Delete a device settings policy. Returns the remaining policies for the account.","operationId":"devices-delete-device-settings-policy","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/schemas-uuid-lt6l49Ob"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_settings_response_collection"}}},"description":"Delete Device Settings Policy response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/device_settings_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Device Settings Policy response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Device Settings Policy","tags":["Devices"]},"get":{"description":"Get the device settings policy by ID.","operationId":"devices-get-device-settings-policy-by-id","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/schemas-uuid-lt6l49Ob"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_settings_response"}}},"description":"Get Device Settings Policy by ID response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/device_settings_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Device Settings Policy by ID response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Device Settings Policy by ID","tags":["Devices"]},"patch":{"description":"Update a device settings policy.","operationId":"devices-update-device-settings-policy","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/schemas-uuid-lt6l49Ob"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"allow_mode_switch":{"$ref":"#/components/schemas/allow_mode_switch"},"allow_updates":{"$ref":"#/components/schemas/allow_updates"},"allowed_to_leave":{"$ref":"#/components/schemas/allowed_to_leave"},"auto_connect":{"$ref":"#/components/schemas/auto_connect"},"captive_portal":{"$ref":"#/components/schemas/captive_portal"},"description":{"$ref":"#/components/schemas/schemas-description-jdg4o19i"},"disable_auto_fallback":{"$ref":"#/components/schemas/disable_auto_fallback"},"enabled":{"description":"Whether the policy will be applied to matching devices.","example":true,"type":"boolean"},"exclude_office_ips":{"$ref":"#/components/schemas/exclude_office_ips"},"match":{"$ref":"#/components/schemas/schemas-match-ImQchlrH"},"name":{"description":"The name of the device settings policy.","example":"Allow Developers","maxLength":100,"type":"string"},"precedence":{"$ref":"#/components/schemas/precedence-HZLvpi3q"},"service_mode_v2":{"$ref":"#/components/schemas/service_mode_v2"},"support_url":{"$ref":"#/components/schemas/support_url"},"switch_locked":{"$ref":"#/components/schemas/switch_locked"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_settings_response"}}},"description":"Update Device Settings Policy response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/device_settings_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Device Settings Policy response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Device Settings Policy","tags":["Devices"]}},"/accounts/{identifier}/devices/policy/{uuid}/exclude":{"get":{"description":"Get the list of routes excluded from the WARP client's tunnel for one specific device settings policy.","operationId":"devices-get-split-tunnel-exclude-list-for-a-device-settings-policy","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/schemas-uuid-lt6l49Ob"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/split_tunnel_response_collection"}}},"description":"Get Split Tunnel Exclude List for a Device Settings Policy response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/split_tunnel_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Split Tunnel Exclude List for a Device Settings Policy response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Split Tunnel Exclude List for a Device Settings Policy","tags":["Devices"]},"put":{"description":"Set the list of routes excluded from the WARP client's tunnel for one specific device settings policy.","operationId":"devices-set-split-tunnel-exclude-list-for-a-device-settings-policy","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/schemas-uuid-lt6l49Ob"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/split_tunnel"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/split_tunnel_response_collection"}}},"description":"Set Split Tunnel Exclude List for a Device Settings Policy response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/split_tunnel_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Set Split Tunnel Exclude List for a Device Settings Policy response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Set Split Tunnel Exclude List for a Device Settings Policy","tags":["Devices"]}},"/accounts/{identifier}/devices/policy/{uuid}/fallback_domains":{"get":{"description":"Get the list of domains to bypass Gateway for DNS resolution and instead use the specified server.","operationId":"devices-get-local-domain-fallback-list-for-a-device-settings-policy","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/schemas-uuid-lt6l49Ob"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/fallback_domain_response_collection"}}},"description":"Get Local Domain Fallback List for a Device Settings Policy response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/fallback_domain_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Local Domain Fallback List for a Device Settings Policy response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Local Domain Fallback List for a Device Settings Policy","tags":["Devices"]},"put":{"description":"Set the list of domains to bypass Gateway for DNS resolution and instead use the specified server.","operationId":"devices-set-local-domain-fallback-list-for-a-device-settings-policy","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/schemas-uuid-lt6l49Ob"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/fallback_domain"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/fallback_domain_response_collection"}}},"description":"Set Local Domain Fallback List for a Device Settings Policy response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/fallback_domain_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Set Local Domain Fallback List for a Device Settings Policy response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Set Local Domain Fallback List for a Device Settings Policy","tags":["Devices"]}},"/accounts/{identifier}/devices/policy/{uuid}/include":{"get":{"description":"Get the list of routes included in the WARP client's tunnel for one specific device settings policy.","operationId":"devices-get-split-tunnel-include-list-for-a-device-settings-policy","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/schemas-uuid-lt6l49Ob"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/split_tunnel_include_response_collection"}}},"description":"Get Split Tunnel Include List for a Device Settings Policy response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/split_tunnel_include_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Split Tunnel Include List for a Device Settings Policy response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Split Tunnel Include List for a Device Settings Policy","tags":["Devices"]},"put":{"description":"Set the list of routes included in the WARP client's tunnel for one specific device settings policy.","operationId":"devices-set-split-tunnel-include-list-for-a-device-settings-policy","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/schemas-uuid-lt6l49Ob"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/split_tunnel_include"},"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/split_tunnel_include_response_collection"}}},"description":"Set Split Tunnel Include List for a Device Settings Policy response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/split_tunnel_include_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Set Split Tunnel Include List for a Device Settings Policy response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Set Split Tunnel Include List for a Device Settings Policy","tags":["Devices"]}},"/accounts/{identifier}/devices/posture":{"get":{"description":"List Device Posture Rules for an account.","operationId":"device-posture-rules-list-device-posture-rules","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_collection-Oi5s0tkV"}}},"description":"List Device Posture Rules response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_collection-Oi5s0tkV"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Device Posture Rules response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Device Posture Rules","tags":["Device Posture Rules"]},"post":{"description":"Create a new Device Posture Rule.","operationId":"device-posture-rules-create-device-posture-rule","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"description":{"$ref":"#/components/schemas/description-HWZDzyev"},"expiration":{"$ref":"#/components/schemas/expiration-9DsFtGHX"},"input":{"$ref":"#/components/schemas/input-NaZjecAw"},"match":{"$ref":"#/components/schemas/match-gWGZ7MOw"},"name":{"$ref":"#/components/schemas/name-wyyCMADI"},"schedule":{"$ref":"#/components/schemas/schedule-kOC57cA0"},"type":{"$ref":"#/components/schemas/type-tb4QXpPC"}},"required":["name","type"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response-UJHycgfI"}}},"description":"Create Device Posture Rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response-UJHycgfI"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Device Posture Rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Device Posture Rule","tags":["Device Posture Rules"]}},"/accounts/{identifier}/devices/posture/integration":{"get":{"description":"List Device Posture Integrations for an account.","operationId":"device-posture-integrations-list-device-posture-integrations","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-response_collection-CSlm0TuB"}}},"description":"List Device Posture Integrations response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-response_collection-CSlm0TuB"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Device Posture Integrations response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Device Posture Integrations","tags":["Device Posture Integrations"]},"post":{"description":"Create a new Device Posture Integration.","operationId":"device-posture-integrations-create-device-posture-integration","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"config":{"$ref":"#/components/schemas/config_request-dR6XwB2B"},"interval":{"$ref":"#/components/schemas/interval-FAyugCvL"},"name":{"$ref":"#/components/schemas/components-schemas-name-4QGVxQIe"},"type":{"$ref":"#/components/schemas/schemas-type-BQBcyQpN"}},"required":["name","type","interval","config"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-single_response-aU3syxnr"}}},"description":"Create Device Posture Integration response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-single_response-aU3syxnr"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Device Posture Integration response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Device Posture Integration","tags":["Device Posture Integrations"]}},"/accounts/{identifier}/devices/posture/integration/{uuid}":{"delete":{"description":"Delete a Device Posture Integration.","operationId":"device-posture-integrations-delete-device-posture-integration","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-l20MFQPz"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-id_response-ZaI3kQGy"}}},"description":"Delete Device Posture Integration response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-id_response-ZaI3kQGy"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Device Posture Integration response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Device Posture Integration","tags":["Device Posture Integrations"]},"get":{"description":"Fetch a single Device Posture Integration.","operationId":"device-posture-integrations-device-posture-integration-details","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-l20MFQPz"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-single_response-aU3syxnr"}}},"description":"Device Posture Integration Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-single_response-aU3syxnr"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Device Posture Integration Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Device Posture Integration Details","tags":["Device Posture Integrations"]},"patch":{"description":"Update a Device Posture Integration.","operationId":"device-posture-integrations-update-device-posture-integration","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-l20MFQPz"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"config":{"$ref":"#/components/schemas/config_request-dR6XwB2B"},"interval":{"$ref":"#/components/schemas/interval-FAyugCvL"},"name":{"$ref":"#/components/schemas/components-schemas-name-4QGVxQIe"},"type":{"$ref":"#/components/schemas/schemas-type-BQBcyQpN"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-single_response-aU3syxnr"}}},"description":"Update Device Posture Integration response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-single_response-aU3syxnr"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Device Posture Integration response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Device Posture Integration","tags":["Device Posture Integrations"]}},"/accounts/{identifier}/devices/posture/{uuid}":{"delete":{"description":"Delete a Device Posture Rule.","operationId":"device-posture-rules-delete-device-posture-rule","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-l20MFQPz"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/id_response-eHg5OKOR"}}},"description":"Delete Device Posture Rule response."},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/id_response-eHg5OKOR"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Device Posture Rule response failure."}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Device Posture Rule","tags":["Device Posture Rules"]},"get":{"description":"Fetch a single Device Posture Rule.","operationId":"device-posture-rules-device-posture-rules-details","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-l20MFQPz"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response-UJHycgfI"}}},"description":"Device Posture Rules Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response-UJHycgfI"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Device Posture Rules Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Device Posture Rules Details","tags":["Device Posture Rules"]},"put":{"description":"Update a Device Posture Rule.","operationId":"device-posture-rules-update-device-posture-rule","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-l20MFQPz"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"description":{"$ref":"#/components/schemas/description-HWZDzyev"},"expiration":{"$ref":"#/components/schemas/expiration-9DsFtGHX"},"input":{"$ref":"#/components/schemas/input-NaZjecAw"},"match":{"$ref":"#/components/schemas/match-gWGZ7MOw"},"name":{"$ref":"#/components/schemas/name-wyyCMADI"},"schedule":{"$ref":"#/components/schemas/schedule-kOC57cA0"},"type":{"$ref":"#/components/schemas/type-tb4QXpPC"}},"required":["name","type"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response-UJHycgfI"}}},"description":"Update Device Posture Rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response-UJHycgfI"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Device Posture Rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Device Posture Rule","tags":["Device Posture Rules"]}},"/accounts/{identifier}/devices/revoke":{"post":{"description":"Revoke a list of devices.","operationId":"devices-revoke-devices","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/revoke_devices_request-zLb49AXe"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single"}}},"description":"Revoke Devices response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Revoke Devices response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Revoke Devices","tags":["Devices"]}},"/accounts/{identifier}/devices/settings":{"get":{"description":"Describes the current device settings Zero Trust account.","operationId":"zero-trust-accounts-get-device-settings-for-zero-trust-account","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gateway-account-device-settings-response"}}},"description":"Get device settings for Zero Trust account response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/gateway-account-device-settings-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get device settings for Zero Trust account response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get device settings for Zero Trust account","tags":["Zero Trust accounts"]},"put":{"description":"Updates the current device settings for Zero Trust account.","operationId":"zero-trust-accounts-update-device-settings-for-the-zero-trust-account","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gateway-account-device-settings"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gateway-account-device-settings-response"}}},"description":"Update device settings for the Zero Trust account response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/gateway-account-device-settings-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update device settings for the Zero Trust account response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update device settings for the Zero Trust account","tags":["Zero Trust accounts"]}},"/accounts/{identifier}/devices/unrevoke":{"post":{"description":"Unrevoke a list of devices.","operationId":"devices-unrevoke-devices","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/unrevoke_devices_request-bkyFobOE"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single"}}},"description":"Unrevoke Devices response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Unrevoke Devices response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Unrevoke Devices","tags":["Devices"]}},"/accounts/{identifier}/devices/{uuid}":{"get":{"description":"Fetch a single Device.","operationId":"devices-device-details","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/schemas-uuid-lt6l49Ob"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_response"}}},"description":"Device Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/device_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Device Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Device Details","tags":["Devices"]}},"/accounts/{identifier}/devices/{uuid}/override_codes":{"get":{"description":"Fetch one-time use admin override code for a device. This relies on the Admin Override setting being enabled in your device configuration.","operationId":"devices-list-admin-override-code-for-device","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/schemas-uuid-lt6l49Ob"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/override_codes_response"}}},"description":"List Admin Override code for device response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/override_codes_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Admin Override code for device response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Admin Override code for device","tags":["Devices"]}},"/accounts/{identifier}/gateway":{"get":{"description":"Get Zero Trust account information.","operationId":"zero-trust-accounts-get-zero-trust-account-information","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gateway_account"}}},"description":"Get Zero Trust account information response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/gateway_account"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Zero Trust account information response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Zero Trust account information","tags":["Zero Trust accounts"]},"post":{"description":"Create Zero Trust account with existing cloudflare account.","operationId":"zero-trust-accounts-create-zero-trust-account","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"account_id":{"$ref":"#/components/schemas/cf_account_id"}},"required":["account_id"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gateway_account"}}},"description":"Create Zero Trust account response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/gateway_account"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Zero Trust account response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Zero Trust account","tags":["Zero Trust accounts"]}},"/accounts/{identifier}/gateway/app_types":{"get":{"description":"List all Application and Application Type mappings.","operationId":"zero-trust-gateway-application-and-application-type-mappings-list-application-and-application-type-mappings","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/app-types_components-schemas-response_collection"}}},"description":"List Application and Application Type mappings response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/app-types_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Application and Application Type mappings response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Application and Application Type mappings","tags":["Zero Trust Gateway Application and Application Type mappings"]}},"/accounts/{identifier}/gateway/configuration":{"get":{"description":"Describes current Zero Trust account configuration.","operationId":"zero-trust-accounts-get-zero-trust-account-configuration","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gateway_account_config"}}},"description":"Get Zero Trust account configuration response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/gateway_account_config"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Zero Trust account configuration response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Zero Trust account configuration","tags":["Zero Trust accounts"]},"patch":{"description":"Patches the current Zero Trust account configuration. This end point helps you to update single sub collection of settings like antivirus, tls_decrypt, activity_log, block_page, browser_isolation, fips, body_scanning or custom_certificate, without updating the whole configuration object. Returns error if a single collection of setting is not properly configured.","operationId":"zero-trust-accounts-patch-zero-trust-account-configuration","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gateway-account-settings"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gateway_account_config"}}},"description":"Update Zero Trust account configuration response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/gateway_account_config"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Zero Trust account configuration response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Patch Zero Trust account configuration","tags":["Zero Trust accounts"]},"put":{"description":"Updates the current Zero Trust account configuration.","operationId":"zero-trust-accounts-update-zero-trust-account-configuration","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gateway-account-settings"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gateway_account_config"}}},"description":"Update Zero Trust account configuration response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/gateway_account_config"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Zero Trust account configuration response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Zero Trust account configuration","tags":["Zero Trust accounts"]}},"/accounts/{identifier}/gateway/lists":{"get":{"description":"List Zero Trust Lists for an account.","operationId":"zero-trust-lists-list-zero-trust-lists","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_collection"}}},"description":"List Zero Trust Lists response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Zero Trust Lists response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Zero Trust Lists","tags":["Zero Trust Lists"]},"post":{"description":"Create a new Zero Trust List.","operationId":"zero-trust-lists-create-zero-trust-list","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"description":{"$ref":"#/components/schemas/description"},"items":{"$ref":"#/components/schemas/items"},"name":{"$ref":"#/components/schemas/name"},"type":{"$ref":"#/components/schemas/type"}},"required":["name","type"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response_with_list_items"}}},"description":"Create Zero Trust List response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response_with_list_items"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Zero Trust List response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Zero Trust List","tags":["Zero Trust Lists"]}},"/accounts/{identifier}/gateway/lists/{uuid}":{"delete":{"description":"Delete a Zero Trust List.","operationId":"zero-trust-lists-delete-zero-trust-list","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/empty_response"}}},"description":"Delete Zero Trust List response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/empty_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Zero Trust List response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Zero Trust List","tags":["Zero Trust Lists"]},"get":{"description":"Fetch a single Zero Trust List.","operationId":"zero-trust-lists-zero-trust-list-details","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response"}}},"description":"Zero Trust List Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Zero Trust List Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Zero Trust List Details","tags":["Zero Trust Lists"]},"patch":{"description":"Append or remove an item from a configured Zero Trust List.","operationId":"zero-trust-lists-patch-zero-trust-list","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"append":{"$ref":"#/components/schemas/items"},"remove":{"description":"A list of the item values you want to remove.","items":{"$ref":"#/components/schemas/value"},"type":"array"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response"}}},"description":"Patch Zero Trust List response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Patch Zero Trust List response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Patch Zero Trust List","tags":["Zero Trust Lists"]},"put":{"description":"Update a configured Zero Trust List.","operationId":"zero-trust-lists-update-zero-trust-list","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"description":{"$ref":"#/components/schemas/description"},"name":{"$ref":"#/components/schemas/name"}},"required":["name"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response"}}},"description":"Update Zero Trust List response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Zero Trust List response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Zero Trust List","tags":["Zero Trust Lists"]}},"/accounts/{identifier}/gateway/lists/{uuid}/items":{"get":{"description":"Fetch all items of a single Zero Trust List.","operationId":"zero-trust-lists-zero-trust-list-items","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/list_item_response_collection"}}},"description":"Zero Trust List Items response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/list_item_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Zero Trust List Items response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Zero Trust List Items","tags":["Zero Trust Lists"]}},"/accounts/{identifier}/gateway/locations":{"get":{"description":"List Zero Trust Gateway Locations for an account.","operationId":"zero-trust-gateway-locations-list-zero-trust-gateway-locations","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-response_collection"}}},"description":"List Zero Trust Gateway Locations response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Zero Trust Gateway Locations response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Zero Trust Gateway Locations","tags":["Zero Trust Gateway Locations"]},"post":{"description":"Create a new Zero Trust Gateway Location.","operationId":"zero-trust-gateway-locations-create-zero-trust-gateway-location","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"client_default":{"$ref":"#/components/schemas/client-default"},"ecs_support":{"$ref":"#/components/schemas/ecs-support"},"name":{"$ref":"#/components/schemas/schemas-name"},"networks":{"$ref":"#/components/schemas/network"}},"required":["name"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-single_response"}}},"description":"Create Zero Trust Gateway Location response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Zero Trust Gateway Location response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Zero Trust Gateway Location","tags":["Zero Trust Gateway Locations"]}},"/accounts/{identifier}/gateway/locations/{uuid}":{"delete":{"description":"Delete a Zero Trust Gateway Location.","operationId":"zero-trust-gateway-locations-delete-zero-trust-gateway-location","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/schemas-uuid"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/empty_response"}}},"description":"Delete Zero Trust Gateway Location response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/empty_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Zero Trust Gateway Location response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Zero Trust Gateway Location","tags":["Zero Trust Gateway Locations"]},"get":{"description":"Fetch a single Zero Trust Gateway Location.","operationId":"zero-trust-gateway-locations-zero-trust-gateway-location-details","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/schemas-uuid"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-single_response"}}},"description":"Zero Trust Gateway Location Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Zero Trust Gateway Location Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Zero Trust Gateway Location Details","tags":["Zero Trust Gateway Locations"]},"put":{"description":"Update a configured Zero Trust Gateway Location.","operationId":"zero-trust-gateway-locations-update-zero-trust-gateway-location","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/schemas-uuid"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"client_default":{"$ref":"#/components/schemas/client-default"},"ecs_support":{"$ref":"#/components/schemas/ecs-support"},"name":{"$ref":"#/components/schemas/schemas-name"},"networks":{"$ref":"#/components/schemas/network"}},"required":["name"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-single_response"}}},"description":"Update Zero Trust Gateway Location response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Zero Trust Gateway Location response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Zero Trust Gateway Location","tags":["Zero Trust Gateway Locations"]}},"/accounts/{identifier}/gateway/logging":{"get":{"description":"Describes the current logging settings for Zero Trust account.","operationId":"zero-trust-accounts-get-logging-settings-for-the-zero-trust-account","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gateway-account-logging-settings-response"}}},"description":"Get logging settings for the Zero Trust account response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/gateway-account-logging-settings-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get logging settings for the Zero Trust account response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get logging settings for the Zero Trust account","tags":["Zero Trust accounts"]},"put":{"description":"Updates the current logging settings for the Zero Trust accounty.","operationId":"zero-trust-accounts-update-logging-settings-for-the-zero-trust-account","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gateway-account-logging-settings"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/gateway-account-logging-settings-response"}}},"description":"Update logging settings for the Zero Trust account response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/gateway-account-logging-settings-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update logging settings for the Zero Trust account response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update logging settings for the Zero Trust account","tags":["Zero Trust accounts"]}},"/accounts/{identifier}/gateway/proxy_endpoints":{"get":{"description":"Fetch a single Zero Trust Gateway Proxy Endpoint.","operationId":"zero-trust-gateway-proxy-endpoints-list-proxy-endpoints","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/proxy-endpoints_components-schemas-response_collection"}}},"description":"List Proxy Endpoints response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/proxy-endpoints_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Proxy Endpoints response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Proxy Endpoints","tags":["Zero Trust Gateway Proxy Endpoints"]},"post":{"description":"Create a new Zero Trust Gateway Proxy Endpoint.","operationId":"zero-trust-gateway-proxy-endpoints-create-proxy-endpoint","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"ips":{"$ref":"#/components/schemas/ips"},"name":{"$ref":"#/components/schemas/proxy-endpoints_components-schemas-name"},"subdomain":{"$ref":"#/components/schemas/schemas-subdomain"}},"required":["name","ips"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/proxy-endpoints_components-schemas-single_response"}}},"description":"Create Proxy Endpoint response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/proxy-endpoints_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Proxy Endpoint response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Proxy Endpoint","tags":["Zero Trust Gateway Proxy Endpoints"]}},"/accounts/{identifier}/gateway/proxy_endpoints/{uuid}":{"delete":{"description":"Delete a Zero Trust Gateway Proxy Endpoint.","operationId":"zero-trust-gateway-proxy-endpoints-delete-proxy-endpoint","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/schemas-uuid"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/empty_response"}}},"description":"Delete Proxy Endpoint response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/empty_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Proxy Endpoint response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Proxy Endpoint","tags":["Zero Trust Gateway Proxy Endpoints"]},"get":{"description":"List Zero Trust Gateway Proxy Endpoints for an account.","operationId":"zero-trust-gateway-proxy-endpoints-proxy-endpoint-details","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/schemas-uuid"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/proxy-endpoints_components-schemas-single_response"}}},"description":"Proxy Endpoint Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/proxy-endpoints_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Proxy Endpoint Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Proxy Endpoint Details","tags":["Zero Trust Gateway Proxy Endpoints"]},"patch":{"description":"Update a new Zero Trust Gateway Proxy Endpoint.","operationId":"zero-trust-gateway-proxy-endpoints-update-proxy-endpoint","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/schemas-uuid"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"ips":{"$ref":"#/components/schemas/ips"},"name":{"$ref":"#/components/schemas/proxy-endpoints_components-schemas-name"},"subdomain":{"$ref":"#/components/schemas/schemas-subdomain"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/proxy-endpoints_components-schemas-single_response"}}},"description":"Update Proxy Endpoint response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/proxy-endpoints_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Proxy Endpoint response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Proxy Endpoint","tags":["Zero Trust Gateway Proxy Endpoints"]}},"/accounts/{identifier}/gateway/rules":{"get":{"description":"List Zero Trust Gateway Rules for an account.","operationId":"zero-trust-gateway-rules-list-zero-trust-gateway-rules","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-response_collection"}}},"description":"List Zero Trust Gateway Rules response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Zero Trust Gateway Rules response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Zero Trust Gateway Rules","tags":["Zero Trust Gateway Rules"]},"post":{"description":"Create a new Zero Trust Gateway Rule.","operationId":"zero-trust-gateway-rules-create-zero-trust-gateway-rule","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"action":{"$ref":"#/components/schemas/action"},"description":{"$ref":"#/components/schemas/schemas-description"},"device_posture":{"$ref":"#/components/schemas/device_posture"},"enabled":{"$ref":"#/components/schemas/enabled"},"filters":{"$ref":"#/components/schemas/filters"},"identity":{"$ref":"#/components/schemas/identity"},"name":{"$ref":"#/components/schemas/components-schemas-name"},"precedence":{"$ref":"#/components/schemas/precedence"},"rule_settings":{"$ref":"#/components/schemas/rule-settings"},"schedule":{"$ref":"#/components/schemas/schedule"},"traffic":{"$ref":"#/components/schemas/traffic"}},"required":["name","action"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-single_response"}}},"description":"Create Zero Trust Gateway Rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Zero Trust Gateway Rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Zero Trust Gateway Rule","tags":["Zero Trust Gateway Rules"]}},"/accounts/{identifier}/gateway/rules/{uuid}":{"delete":{"description":"Delete a Zero Trust Gateway Rule.","operationId":"zero-trust-gateway-rules-delete-zero-trust-gateway-rule","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/empty_response"}}},"description":"Delete Zero Trust Gateway Rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/empty_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Zero Trust Gateway Rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Zero Trust Gateway Rule","tags":["Zero Trust Gateway Rules"]},"get":{"description":"Fetch a single Zero Trust Gateway Rule.","operationId":"zero-trust-gateway-rules-zero-trust-gateway-rule-details","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-single_response"}}},"description":"Zero Trust Gateway Rule Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Zero Trust Gateway Rule Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Zero Trust Gateway Rule Details","tags":["Zero Trust Gateway Rules"]},"put":{"description":"Update a configured Zero Trust Gateway Rule.","operationId":"zero-trust-gateway-rules-update-zero-trust-gateway-rule","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"action":{"$ref":"#/components/schemas/action"},"description":{"$ref":"#/components/schemas/schemas-description"},"device_posture":{"$ref":"#/components/schemas/device_posture"},"enabled":{"$ref":"#/components/schemas/enabled"},"filters":{"$ref":"#/components/schemas/filters"},"identity":{"$ref":"#/components/schemas/identity"},"name":{"$ref":"#/components/schemas/components-schemas-name"},"precedence":{"$ref":"#/components/schemas/precedence"},"rule_settings":{"$ref":"#/components/schemas/rule-settings"},"schedule":{"$ref":"#/components/schemas/schedule"},"traffic":{"$ref":"#/components/schemas/traffic"}},"required":["name","action"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-single_response"}}},"description":"Update Zero Trust Gateway Rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Zero Trust Gateway Rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Zero Trust Gateway Rule","tags":["Zero Trust Gateway Rules"]}},"/certificates":{"get":{"description":"List all existing Origin CA certificates for a given zone. Use your Origin CA Key as your User Service Key when calling this endpoint ([see above](#requests)).","operationId":"origin-ca-list-certificates","parameters":[{"in":"query","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"identifier","schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-certificate_response_collection"}}},"description":"List Certificates response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-certificate_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Certificates response failure"}},"security":[{"user_service_key":[]},{"api_token":[]}],"summary":"List Certificates","tags":["Origin CA"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Create an Origin CA certificate. Use your Origin CA Key as your User Service Key when calling this endpoint ([see above](#requests)).","operationId":"origin-ca-create-certificate","requestBody":{"content":{"application/json":{"schema":{"properties":{"csr":{"$ref":"#/components/schemas/csr"},"hostnames":{"$ref":"#/components/schemas/hostnames"},"request_type":{"$ref":"#/components/schemas/request_type"},"requested_validity":{"$ref":"#/components/schemas/requested_validity"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-certificate_response_single"}}},"description":"Create Certificate response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-certificate_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Certificate response failure"}},"security":[{"user_service_key":[]},{"api_token":[]}],"summary":"Create Certificate","tags":["Origin CA"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/certificates/{identifier}":{"delete":{"description":"Revoke an existing Origin CA certificate by its serial number. Use your Origin CA Key as your User Service Key when calling this endpoint ([see above](#requests)).","operationId":"origin-ca-revoke-certificate","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/certificates_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificate_response_single_id-NbTd4zHr"}}},"description":"Revoke Certificate response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificate_response_single_id-NbTd4zHr"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Revoke Certificate response failure"}},"security":[{"user_service_key":[]},{"api_token":[]}],"summary":"Revoke Certificate","tags":["Origin CA"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Get an existing Origin CA certificate by its serial number. Use your Origin CA Key as your User Service Key when calling this endpoint ([see above](#requests)).","operationId":"origin-ca-get-certificate","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/certificates_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-certificate_response_single"}}},"description":"Get Certificate response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-certificate_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Certificate response failure"}},"security":[{"user_service_key":[]},{"api_token":[]}],"summary":"Get Certificate","tags":["Origin CA"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/ips":{"get":{"description":"Get IPs used on the Cloudflare network, see https://www.cloudflare.com/ips.","operationId":"cloudflare-i-ps-cloudflare-ip-details","responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/ips-BbJyXXsk"}}}]}}},"description":"Cloudflare IP Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/ips-BbJyXXsk"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Cloudflare IP Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Cloudflare IP Details","tags":["Cloudflare IPs"]}},"/ips?networks=jdcloud":{"get":{"description":"Get IPs used by JD Cloud data centers in China, see https://developers.cloudflare.com/china-network/reference/infrastructure/.","operationId":"cloudflare-i-ps-cloudflare-ip-details-jdcloud","parameters":[{"description":"Specified as `jdcloud` to list IPs used by JD Cloud data centers.","in":"query","name":"networks","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/ips_jdcloud"}}}]}}},"description":"JD Cloud IP Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/ips_jdcloud"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"JD Cloud IP Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"JD Cloud IP Details","tags":["Cloudflare IPs"]}},"/memberships":{"get":{"description":"List memberships of accounts the user can access.","operationId":"user'-s-account-memberships-list-memberships","parameters":[{"in":"query","name":"account.name","schema":{"$ref":"#/components/schemas/properties-name"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Number of memberships per page.","maximum":50,"minimum":5,"type":"number"}},{"in":"query","name":"order","schema":{"description":"Field to order memberships by.","enum":["id","account.name","status"],"example":"status","type":"string"}},{"in":"query","name":"direction","schema":{"description":"Direction to order memberships.","enum":["asc","desc"],"example":"desc","type":"string"}},{"in":"query","name":"name","schema":{"$ref":"#/components/schemas/properties-name"}},{"in":"query","name":"status","schema":{"description":"Status of this membership.","enum":["accepted","pending","rejected"],"example":"accepted","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/collection_membership_response"}}},"description":"List Memberships response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/collection_membership_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Memberships response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Memberships","tags":["User's Account Memberships"]}},"/memberships/{identifier}":{"delete":{"description":"Remove the associated member from an account.","operationId":"user'-s-account-memberships-delete-membership","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/membership_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/membership_components-schemas-identifier"}}}},"type":"object"}]}}},"description":"Delete Membership response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/membership_components-schemas-identifier"}}}},"type":"object"}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Membership response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Membership","tags":["User's Account Memberships"]},"get":{"description":"Get a specific membership.","operationId":"user'-s-account-memberships-membership-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/membership_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_membership_response"}}},"description":"Membership Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_membership_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Membership Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Membership Details","tags":["User's Account Memberships"]},"put":{"description":"Accept or reject this account invitation.","operationId":"user'-s-account-memberships-update-membership","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/membership_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"status":{"description":"Whether to accept or reject this account invitation.","enum":["accepted","rejected"],"example":"accepted"}},"required":["status"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_membership_response"}}},"description":"Update Membership response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_membership_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Membership response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Membership","tags":["User's Account Memberships"]}},"/organizations/{identifier}":{"get":{"deprecated":true,"description":"Get information about a specific organization that you are a member of.","operationId":"organizations-(-deprecated)-organization-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_organization_response"}}},"description":"Organization Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_organization_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Organization Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Organization Details","tags":["Organizations (Deprecated)"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.","display":true,"eol":"2020-02-04","id":"org_deprecation"},"x-cfPermissionsRequired":{"enum":["#organization:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"patch":{"deprecated":true,"description":"Update an existing Organization.","operationId":"organizations-(-deprecated)-edit-organization","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"$ref":"#/components/schemas/schemas-name-Usb6SCq8"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_organization_response"}}},"description":"Edit Organization response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_organization_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Edit Organization response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Edit Organization","tags":["Organizations (Deprecated)"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.","display":true,"eol":"2020-02-04","id":"org_deprecation"},"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/organizations/{organization_identifier}/audit_logs":{"get":{"deprecated":true,"description":"Gets a list of audit logs for an organization. The list can be filtered by who made the change, which zone was the change made on, and the timeframe of the change.","operationId":"audit-logs-get-organization-audit-logs","parameters":[{"in":"path","name":"organization_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"id","schema":{"description":"Finds a specific log by its ID.","example":"f174be97-19b1-40d6-954d-70cd5fbd52db","type":"string"}},{"in":"query","name":"export","schema":{"description":"Indicates that this request is an export of logs in CSV format.","example":true,"type":"boolean"}},{"in":"query","name":"action.type","schema":{"description":"Filters by the action type.","example":"add","type":"string"}},{"in":"query","name":"actor.ip","schema":{"description":"Filters by the IP address of the request that made the change by specific IP address or valid CIDR Range.","example":"17.168.228.63","type":"string"}},{"in":"query","name":"actor.email","schema":{"description":"Filters by the email address of the actor that made the change.","example":"alice@example.com","format":"email","type":"string"}},{"in":"query","name":"since","schema":{"description":"Limits the returned results to logs newer than the specified date. This can be a date string `2019-04-30` or an absolute timestamp that conforms to RFC3339.","example":"2019-04-30T01:12:20Z","format":"date-time","type":"string"}},{"in":"query","name":"before","schema":{"description":"Limits the returned results to logs older than the specified date. This can be a date string `2019-04-30` or an absolute timestamp that conforms to RFC3339.","example":"2019-04-30T01:12:20Z","format":"date-time","type":"string"}},{"in":"query","name":"zone.name","schema":{"description":"Filters by the name of the zone associated to the change.","example":"example.com","type":"string"}},{"in":"query","name":"direction","schema":{"default":"desc","description":"Changes the direction of the chronological sorting.","enum":["desc","asc"],"example":"desc","type":"string"}},{"in":"query","name":"per_page","schema":{"default":100,"description":"Sets the number of results to return per page.","example":25,"maximum":1000,"minimum":1,"type":"number"}},{"in":"query","name":"page","schema":{"default":1,"description":"Defines which page of results to return.","example":50,"minimum":1,"type":"number"}},{"in":"query","name":"hide_user_logs","schema":{"default":false,"description":"Indicates whether or not to hide user level audit logs.","type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/audit_logs_response_collection"}}},"description":"Get organization audit logs response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/audit_logs_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get organization audit logs response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get organization audit logs","tags":["Audit Logs"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.","display":true,"eol":"2020-02-04","id":"org_deprecation"},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/organizations/{organization_identifier}/invites":{"get":{"deprecated":true,"description":"List all invitations associated with an organization.","operationId":"organization-invites-list-invitations","parameters":[{"in":"path","name":"organization_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/collection_invite_response"}}},"description":"List Invitations response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/collection_invite_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Invitations response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Invitations","tags":["Organization Invites"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.","display":true,"eol":"2020-02-04","id":"org_deprecation"},"x-cfPermissionsRequired":{"enum":["#organization:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"deprecated":true,"description":"Invite a User to become a Member of an Organization.","operationId":"organization-invites-create-invitation","parameters":[{"in":"path","name":"organization_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"auto_accept":{"default":false,"description":"When present and set to true, allows for the invited user to be automatically accepted to the organization. No invitation is sent.","example":true,"type":"boolean"},"invited_member_email":{"$ref":"#/components/schemas/invited_member_email"},"roles":{"description":"Array of Roles associated with the invited user.","example":[{"id":"5a7805061c76ada191ed06f989cc3dac"},{"id":"9a7806061c88ada191ed06f989cc3dac"}],"items":{"properties":{"description":{"$ref":"#/components/schemas/description-gV3mXO2g"},"id":{"$ref":"#/components/schemas/role_components-schemas-identifier"},"name":{"$ref":"#/components/schemas/components-schemas-name-l3W5RvJP"},"permissions":{"$ref":"#/components/schemas/schemas-permissions"}},"required":["id"],"type":"object"},"type":"array"}},"required":["invited_member_email","roles"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_invite_response"}}},"description":"Create Invitation response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_invite_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Invitation response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Invitation","tags":["Organization Invites"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.","display":true,"eol":"2020-02-04","id":"org_deprecation"},"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/organizations/{organization_identifier}/invites/{identifier}":{"delete":{"deprecated":true,"description":"Cancel an existing invitation.","operationId":"organization-invites-cancel-invitation","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/invite_components-schemas-identifier"}},{"in":"path","name":"organization_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"$ref":"#/components/schemas/invite_components-schemas-identifier"}}}}},"description":"Cancel Invitation response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"properties":{"id":{"$ref":"#/components/schemas/invite_components-schemas-identifier"}}},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Cancel Invitation response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Cancel Invitation","tags":["Organization Invites"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.","display":true,"eol":"2020-02-04","id":"org_deprecation"},"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"deprecated":true,"description":"Get the details of an invitation.","operationId":"organization-invites-invitation-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/invite_components-schemas-identifier"}},{"in":"path","name":"organization_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_invite_response"}}},"description":"Invitation Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_invite_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Invitation Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Invitation Details","tags":["Organization Invites"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.","display":true,"eol":"2020-02-04","id":"org_deprecation"},"x-cfPermissionsRequired":{"enum":["#organization:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"patch":{"deprecated":true,"description":"Change the Roles of a Pending Invite.","operationId":"organization-invites-edit-invitation-roles","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/invite_components-schemas-identifier"}},{"in":"path","name":"organization_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"roles":{"description":"Array of Roles associated with the invited user.","items":{"$ref":"#/components/schemas/role_components-schemas-identifier"},"type":"array"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_invite_response"}}},"description":"Edit Invitation Roles response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_invite_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Edit Invitation Roles response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Edit Invitation Roles","tags":["Organization Invites"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.","display":true,"eol":"2020-02-04","id":"org_deprecation"},"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/organizations/{organization_identifier}/members":{"get":{"deprecated":true,"description":"List all members of a organization.","operationId":"organization-members-list-members","parameters":[{"in":"path","name":"organization_identifier","required":true,"schema":{"$ref":"#/components/schemas/organization_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/collection_member_response"}}},"description":"List Members response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/collection_member_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Members response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Members","tags":["Organization Members"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.","display":true,"eol":"2020-02-04","id":"org_deprecation"},"x-cfPermissionsRequired":{"enum":["#organization:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/organizations/{organization_identifier}/members/{identifier}":{"delete":{"deprecated":true,"description":"Remove a member from an organization.","operationId":"organization-members-remove-member","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"path","name":"organization_identifier","required":true,"schema":{"$ref":"#/components/schemas/organization_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}}}},"description":"Remove Member response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"properties":{"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Remove Member response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Remove Member","tags":["Organization Members"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.","display":true,"eol":"2020-02-04","id":"org_deprecation"},"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"deprecated":true,"description":"Get information about a specific member of an organization.","operationId":"organization-members-member-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"path","name":"organization_identifier","required":true,"schema":{"$ref":"#/components/schemas/organization_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_member_response"}}},"description":"Member Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_member_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Member Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Member Details","tags":["Organization Members"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.","display":true,"eol":"2020-02-04","id":"org_deprecation"},"x-cfPermissionsRequired":{"enum":["#organization:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"patch":{"deprecated":true,"description":"Change the Roles of an Organization's Member.","operationId":"organization-members-edit-member-roles","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"path","name":"organization_identifier","required":true,"schema":{"$ref":"#/components/schemas/organization_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"roles":{"description":"Array of Roles associated with this Member.","items":{"$ref":"#/components/schemas/role_components-schemas-identifier"},"type":"array"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_member_response"}}},"description":"Edit Member Roles response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_member_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Edit Member Roles response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Edit Member Roles","tags":["Organization Members"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.","display":true,"eol":"2020-02-04","id":"org_deprecation"},"x-cfPermissionsRequired":{"enum":["#organization:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/organizations/{organization_identifier}/railguns":{"get":{"deprecated":true,"description":"List, search, sort and filter your Railguns.","operationId":"organization-railgun-list-railguns","parameters":[{"in":"path","name":"organization_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Number of items per page.","maximum":50,"minimum":5,"type":"number"}},{"in":"query","name":"direction","schema":{"description":"Sort Railguns in ascending or descending order.","enum":["asc","desc"],"example":"desc"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/railgun_response_collection"}}},"description":"List Railguns response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/railgun_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Railguns response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Railguns","tags":["Organization Railgun"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.","display":true,"eol":"2020-02-04","id":"org_deprecation"},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"post":{"deprecated":true,"operationId":"organization-railgun-create-railgun","parameters":[{"in":"path","name":"organization_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"$ref":"#/components/schemas/railgun_components-schemas-name"}},"required":["name"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/railgun_response_single"}}},"description":"Create Railgun response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/railgun_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Railgun response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Railgun","tags":["Organization Railgun"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.","display":true,"eol":"2020-02-04","id":"org_deprecation"},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/organizations/{organization_identifier}/railguns/{identifier}":{"delete":{"deprecated":true,"description":"Disable and delete a Railgun. This will immediately disable the Railgun for any connected zones.","operationId":"organization-railgun-delete-railgun","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"}},{"in":"path","name":"organization_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/railgun_response_single_id"}}},"description":"Delete Railgun response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/railgun_response_single_id"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Railgun response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Railgun","tags":["Organization Railgun"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.","display":true,"eol":"2020-02-04","id":"org_deprecation"},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"get":{"deprecated":true,"operationId":"organization-railgun-railgun-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"}},{"in":"path","name":"organization_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/railgun_response_single"}}},"description":"Railgun details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/railgun_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Railgun details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Railgun details","tags":["Organization Railgun"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.","display":true,"eol":"2020-02-04","id":"org_deprecation"},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"patch":{"deprecated":true,"description":"Enable or disable a Railgun for all zones connected to it.","operationId":"organization-railgun-enable-or-disable-a-railgun","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"}},{"in":"path","name":"organization_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"enabled":{"$ref":"#/components/schemas/railgun_components-schemas-enabled"}},"required":["enabled"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/railgun_response_single"}}},"description":"Enable or disable a Railgun response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/railgun_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Enable or disable a Railgun response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Enable or disable a Railgun","tags":["Organization Railgun"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.","display":true,"eol":"2020-02-04","id":"org_deprecation"},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/organizations/{organization_identifier}/railguns/{identifier}/zones":{"get":{"deprecated":true,"description":"Lists the zones that are currently using this Railgun.","operationId":"organization-railgun-get-railgun-zones","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"}},{"in":"path","name":"organization_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/components-schemas-zone"},"type":"array"}}}]}}},"description":"Get Railgun zones response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/components-schemas-zone"},"type":"array"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Railgun zones response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Railgun zones","tags":["Organization Railgun"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.","display":true,"eol":"2020-02-04","id":"org_deprecation"},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/organizations/{organization_identifier}/roles":{"get":{"deprecated":true,"description":"Get all available roles for an organization.","operationId":"organization-roles-list-roles","parameters":[{"in":"path","name":"organization_identifier","required":true,"schema":{"$ref":"#/components/schemas/organization_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/collection_role_response"}}},"description":"List Roles response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/collection_role_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Roles response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Roles","tags":["Organization Roles"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.","display":true,"eol":"2020-02-04","id":"org_deprecation"},"x-cfPermissionsRequired":{"enum":["#organization:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/organizations/{organization_identifier}/roles/{identifier}":{"get":{"deprecated":true,"description":"Get information about a specific role for an organization.","operationId":"organization-roles-role-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/role_components-schemas-identifier"}},{"in":"path","name":"organization_identifier","required":true,"schema":{"$ref":"#/components/schemas/organization_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_role_response"}}},"description":"Role Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_role_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Role Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Role Details","tags":["Organization Roles"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.","display":true,"eol":"2020-02-04","id":"org_deprecation"},"x-cfPermissionsRequired":{"enum":["#organization:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/radar/annotations/outages":{"get":{"operationId":"radar_get_AnnotationsOutages","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Number of objects to skip before grabbing results.","in":"query","name":"offset","schema":{"default":0,"description":"Number of objects to skip before grabbing results.","example":0,"type":"integer"}},{"description":"Shorthand date ranges for the last X days - use when you don't need specific start and end dates.","in":"query","name":"dateRange","schema":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"}},{"description":"Start of the date range (inclusive).","in":"query","name":"dateStart","schema":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"annotations":{"items":{"properties":{"asns":{"items":{"example":189,"type":"integer"},"type":"array"},"asnsDetails":{"items":{"properties":{"asn":{"example":189,"type":"integer"},"locations":{"properties":{"asn":{"example":"US","type":"string"},"name":{"example":"United States","type":"string"}},"required":["asn","name"],"type":"object"},"name":{"example":"LUMEN-LEGACY-L3-PARTITION","type":"string"}},"required":["asn","name","locations"],"type":"object"},"type":"array"},"dataSource":{"example":"ALL","type":"string"},"description":{"example":"example","type":"string"},"endDate":{"example":"2022-09-08T10:00:28Z","type":"string"},"eventType":{"example":"OUTAGE","type":"string"},"linkedUrl":{"example":"http://example.com","type":"string"},"locations":{"items":{"example":"US","type":"string"},"type":"array"},"locationsDetails":{"items":{"properties":{"code":{"example":"US","type":"string"},"name":{"example":"United States","type":"string"}},"required":["code","name"],"type":"object"},"type":"array"},"outage":{"properties":{"outageCause":{"example":"CABLE_CUT","type":"string"},"outageType":{"example":"NATIONWIDE","type":"string"}},"required":["outageCause","outageType"],"type":"object"},"scope":{"example":"Colima, Michoacán, México","type":"string"},"startDate":{"example":"2022-09-06T10:00:28Z","type":"string"}},"required":["dataSource","startDate","asns","asnsDetails","locations","locationsDetails","eventType","outage"],"type":"object"},"type":"array"}},"required":["annotations"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get outages annotations","tags":["Radar Annotations"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/annotations/outages/locations":{"get":{"operationId":"radar_get_AnnotationsOutagesTop","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Shorthand date ranges for the last X days - use when you don't need specific start and end dates.","in":"query","name":"dateRange","schema":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"}},{"description":"Start of the date range (inclusive).","in":"query","name":"dateStart","schema":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"annotations":{"items":{"properties":{"clientCountryAlpha2":{"example":"PT","type":"string"},"clientCountryName":{"example":"Portugal","type":"string"},"value":{"example":"5","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["annotations"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top outages annotations","tags":["Radar Annotations"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/as112/summary/dnssec":{"get":{"description":"Percentage distribution of dns requests classified per DNSSEC.","operationId":"radar_get_AS112DNSSECSummary","parameters":[{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"summary_0":{"properties":{"NOT_SUPPORTED":{"example":"16","type":"string"},"SUPPORTED":{"example":"84","type":"string"}},"required":["SUPPORTED","NOT_SUPPORTED"],"type":"object"}},"required":["meta","summary_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a summary of DNSSEC","tags":["Radar AS112"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/as112/summary/edns":{"get":{"description":"Percentage distribution of dns requests classified per EDNS.","operationId":"radar_get_AS112EDNSSummary","parameters":[{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"summary_0":{"properties":{"NOT_SUPPORTED":{"example":"6","type":"string"},"SUPPORTED":{"example":"94","type":"string"}},"required":["SUPPORTED","NOT_SUPPORTED"],"type":"object"}},"required":["meta","summary_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a summary of EDNS","tags":["Radar AS112"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/as112/summary/ip_version":{"get":{"description":"Percentage distribution of dns requests classified per IP Version.","operationId":"radar_get_AS112IPVersionSummary","parameters":[{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"summary_0":{"properties":{"IPv4":{"example":"80","type":"string"},"IPv6":{"example":"20","type":"string"}},"required":["IPv4","IPv6"],"type":"object"}},"required":["meta","summary_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a summary of IP Version","tags":["Radar AS112"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/as112/summary/protocol":{"get":{"description":"Percentage distribution of dns requests classified per Protocol.","operationId":"radar_get_AS112ProtocolSummary","parameters":[{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"summary_0":{"properties":{"tcp":{"example":"1","type":"string"},"udp":{"example":"99","type":"string"}},"required":["udp","tcp"],"type":"object"}},"required":["meta","summary_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a summary of Protocol","tags":["Radar AS112"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/as112/summary/query_type":{"get":{"description":"Percentage distribution of dns requests classified per Query Type.","operationId":"radar_get_AS112QueryTypeSummary","parameters":[{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"summary_0":{"properties":{"A":{"example":"19","type":"string"},"AAAA":{"example":"1","type":"string"},"PTR":{"example":"74","type":"string"},"SOA":{"example":"5","type":"string"},"SRV":{"example":"1","type":"string"}},"required":["PTR","A","SOA","AAAA","SRV"],"type":"object"}},"required":["meta","summary_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a summary of Query Type","tags":["Radar AS112"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/as112/summary/response_codes":{"get":{"description":"Percentage distribution of dns requests classified per Response Codes.","operationId":"radar_get_AS112ResponseCodesSummary","parameters":[{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"summary_0":{"properties":{"NOERROR":{"example":"6","type":"string"},"NXDOMAIN":{"example":"94","type":"string"}},"required":["NXDOMAIN","NOERROR"],"type":"object"}},"required":["meta","summary_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a summary of Response Codes","tags":["Radar AS112"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/as112/timeseries":{"get":{"description":"Get AS112 queries change over time.","operationId":"radar_get_AS112Timeseries","parameters":[{"description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"enum":["15m","1h","1d","1w"],"type":"string"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"aggInterval":{"example":"1h","type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"example":"ALL","type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"example":"OUTAGE","type":"string"},"linkedUrl":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime","linkedUrl"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"lastUpdated":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["confidenceInfo","dateRange","aggInterval","lastUpdated"],"type":"object"},"serie_0":{"properties":{"timestamps":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"},"values":{"items":{"example":0.56,"type":"string"},"type":"array"}},"required":["timestamps","values"],"type":"object"}},"required":["meta","serie_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get AS112 time series","tags":["Radar AS112"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/as112/timeseries/dnssec":{"get":{"description":"Percentage distribution of dns requests classified per DNSSEC over time.","operationId":"radar_get_AS112DNSSECTimeseriesGroup","parameters":[{"description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"enum":["15m","1h","1d","1w"],"type":"string"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"serie_0":{"properties":{"NOT_SUPPORTED":{"items":{"example":"16","type":"string"},"type":"array"},"SUPPORTED":{"items":{"example":"84","type":"string"},"type":"array"}},"required":["SUPPORTED","NOT_SUPPORTED"],"type":"object"}},"required":["meta","serie_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a time series of DNSSEC","tags":["Radar AS112"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/as112/timeseries/edns":{"get":{"description":"Percentage distribution of dns requests classified per EDNS over time.","operationId":"radar_get_AS112EDNSTimeseriesGroup","parameters":[{"description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"enum":["15m","1h","1d","1w"],"type":"string"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"serie_0":{"properties":{"NOT_SUPPORTED":{"items":{"example":"6","type":"string"},"type":"array"},"SUPPORTED":{"items":{"example":"94","type":"string"},"type":"array"}},"required":["SUPPORTED","NOT_SUPPORTED"],"type":"object"}},"required":["meta","serie_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a time series of EDNS","tags":["Radar AS112"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/as112/timeseries/ip_version":{"get":{"description":"Percentage distribution of dns requests classified per IP Version over time.","operationId":"radar_get_AS112IPVersionTimeseriesGroup","parameters":[{"description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"enum":["15m","1h","1d","1w"],"type":"string"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"serie_0":{"properties":{"IPv4":{"items":{"example":"80","type":"string"},"type":"array"},"IPv6":{"items":{"example":"20","type":"string"},"type":"array"}},"required":["IPv4","IPv6"],"type":"object"}},"required":["meta","serie_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a time series of IP Version","tags":["Radar AS112"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/as112/timeseries/protocol":{"get":{"description":"Percentage distribution of dns requests classified per Protocol over time.","operationId":"radar_get_AS112ProtocolTimeseriesGroup","parameters":[{"description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"enum":["15m","1h","1d","1w"],"type":"string"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"serie_0":{"properties":{"tcp":{"items":{"example":"1","type":"string"},"type":"array"},"udp":{"items":{"example":"99","type":"string"},"type":"array"}},"required":["udp","tcp"],"type":"object"}},"required":["meta","serie_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a time series of Protocol","tags":["Radar AS112"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/as112/timeseries/query_type":{"get":{"description":"Percentage distribution of dns requests classified per Query Type over time.","operationId":"radar_get_AS112QueryTypeTimeseriesGroup","parameters":[{"description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"enum":["15m","1h","1d","1w"],"type":"string"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"serie_0":{"properties":{"A":{"items":{"example":"19","type":"string"},"type":"array"},"AAAA":{"items":{"example":"1","type":"string"},"type":"array"},"PTR":{"items":{"example":"74","type":"string"},"type":"array"},"SOA":{"items":{"example":"5","type":"string"},"type":"array"},"SRV":{"items":{"example":"1","type":"string"},"type":"array"}},"required":["PTR","A","SOA","AAAA","SRV"],"type":"object"}},"required":["meta","serie_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a time series of Query Type","tags":["Radar AS112"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/as112/timeseries/response_codes":{"get":{"description":"Percentage distribution of dns requests classified per Response Codes over time.","operationId":"radar_get_AS112ResponseCodesTimeseriesGroup","parameters":[{"description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"enum":["15m","1h","1d","1w"],"type":"string"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"serie_0":{"properties":{"NOERROR":{"items":{"example":"6","type":"string"},"type":"array"},"NXDOMAIN":{"items":{"example":"94","type":"string"},"type":"array"}},"required":["NXDOMAIN","NOERROR"],"type":"object"}},"required":["meta","serie_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a time series of Response Codes","tags":["Radar AS112"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/as112/top/locations":{"get":{"description":"Get the top locations by HTTP traffic. Values are a percentage out of the total traffic.","operationId":"radar_get_AS112TopLocations","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"US","type":"string"},"clientCountryName":{"example":"United States","type":"string"},"value":{"example":"65","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top autonomous systems by HTTP requests","tags":["Radar AS112"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/as112/top/locations/dnssec/{dnssec}":{"get":{"description":"Get the locations, by AS112 queries, of DNSSEC validations.","operationId":"radar_get_AS112TopLocationsByDnssec","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"DNSSEC.","in":"path","name":"dnssec","required":true,"schema":{"enum":["SUPPORTED","NOT_SUPPORTED"],"type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"US","type":"string"},"clientCountryName":{"example":"United States","type":"string"},"value":{"example":"65","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top locations by DNSSEC validations","tags":["Radar AS112"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/as112/top/locations/edns/{edns}":{"get":{"description":"Get the locations, by AS112 queries, of EDNS validations.","operationId":"radar_get_AS112TopLocationsByEdns","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"EDNS.","in":"path","name":"edns","required":true,"schema":{"enum":["SUPPORTED","NOT_SUPPORTED"],"type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"US","type":"string"},"clientCountryName":{"example":"United States","type":"string"},"value":{"example":"65","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top locations by EDNS validations","tags":["Radar AS112"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/as112/top/locations/ip_version/{ip_version}":{"get":{"description":"Get the locations, by AS112 queries, of IP version.","operationId":"radar_get_AS112TopLocationsByIpVersion","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"IP Version.","in":"path","name":"ip_version","required":true,"schema":{"enum":["IPv4","IPv6"],"type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"US","type":"string"},"clientCountryName":{"example":"United States","type":"string"},"value":{"example":"65","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top locations by IP version","tags":["Radar AS112"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/attacks/layer3/summary":{"get":{"description":"Percentage distribution of network protocols in layer 3/4 attacks.","operationId":"radar_get_AttacksLayer3Summary","parameters":[{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"example":"ALL","type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"example":"OUTAGE","type":"string"},"linkedUrl":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime","linkedUrl"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"summary_0":{"properties":{"gre":{"example":"0.9","type":"string"},"icmp":{"example":"0.1","type":"string"},"tcp":{"example":"60","type":"string"},"udp":{"example":"39","type":"string"}},"required":["tcp","udp","gre","icmp"],"type":"object"}},"required":["meta","summary_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a summary of layer 3 attacks","tags":["Radar Attacks"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/attacks/layer3/timeseries":{"get":{"description":"Get layer 3/4 attacks change over time. Values are normalized using min-max by default, with the minimum set to 0. When asking for multiple time series, you can also get the percentual relative change of the 1st/main series, with respect to the 2nd/control series - for example, to get the relative change of this week from the previous week, the 1st series would have a date range of 7d, the 2nd, a date range of 7dControl, and the normalization would be set to PERCENTAGE_CHANGE.","operationId":"radar_get_AttacksLayer3Timeseries","parameters":[{"description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"enum":["15m","1h","1d","1w"],"type":"string"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of L3/4 attack types.","in":"query","name":"attack","schema":{"items":{"enum":["UDP","TCP","ICMP","GRE"],"type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","in":"query","name":"normalization","schema":{"enum":["PERCENTAGE_CHANGE","MIN0_MAX"],"type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"aggInterval":{"example":"1h","type":"string"},"confidenceInfo":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"dateRange":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"lastUpdated":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["confidenceInfo","dateRange","aggInterval","lastUpdated"],"type":"object"},"serie_0":{"properties":{"timestamps":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"},"values":{"items":{"example":0.56,"type":"string"},"type":"array"}},"required":["timestamps","values"],"type":"object"}},"required":["meta","serie_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get layer 3 attacks time series","tags":["Radar Attacks"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/attacks/layer3/timeseries_groups":{"get":{"description":"Get percentage of what type of network protocols are used in layer 3/4 attacks, over time.","operationId":"radar_get_AttacksLayer3TimeseriesGroups","parameters":[{"description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"enum":["15m","1h","1d","1w"],"type":"string"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"aggInterval":{"example":"1h","type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"example":"ALL","type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"example":"OUTAGE","type":"string"},"linkedUrl":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime","linkedUrl"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"lastUpdated":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["confidenceInfo","dateRange","aggInterval","lastUpdated"],"type":"object"},"serie_0":{"properties":{"gre":{"items":{"example":"0.9","type":"string"},"type":"array"},"icmp":{"items":{"example":"0.1","type":"string"},"type":"array"},"tcp":{"items":{"example":"70","type":"string"},"type":"array"},"timestamps":{"items":{"type":"string"},"type":"array"},"udp":{"items":{"example":"29","type":"string"},"type":"array"}},"required":["timestamps","udp","tcp","gre","icmp"],"type":"object"}},"required":["meta","serie_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get layer 3 attacks by network protocol, over time","tags":["Radar Attacks"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/attacks/layer7/summary":{"get":{"description":"Percentage distribution of mitigation techniques in layer 7 attacks.","operationId":"radar_get_AttacksLayer7Summary","parameters":[{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"example":"ALL","type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"example":"OUTAGE","type":"string"},"linkedUrl":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime","linkedUrl"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"summary_0":{"properties":{"access_rules":{"example":"0.9","type":"string"},"api_shield":{"example":"0.9","type":"string"},"bot_management":{"example":"0.9","type":"string"},"data_loss_prevention":{"example":"0.9","type":"string"},"ddos":{"example":"34","type":"string"},"ip_reputation":{"example":"0.1","type":"string"},"waf":{"example":"65","type":"string"}},"required":["waf","ddos","ip_reputation","access_rules","bot_management","api_shield","data_loss_prevention"],"type":"object"}},"required":["meta","summary_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a summary of layer 7 attacks","tags":["Radar Attacks"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/attacks/layer7/timeseries":{"get":{"description":"Get layer 7 attacks change over time. Values are normalized using min-max by default, with the minimum set to 0. When asking for multiple time series, you can also get the percentage relative change of the first/main series, with respect to the second/control series - for example, to get the relative change of this week from the previous week, the first series would have a date range of `7d`, the second, a date range of `7dControl`, and the normalization would be set to `PERCENTAGE_CHANGE`.","operationId":"radar_get_AttacksLayer7Timeseries","parameters":[{"description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"enum":["15m","1h","1d","1w"],"type":"string"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of L7 attack types.","in":"query","name":"attack","schema":{"items":{"enum":["DDOS","WAF","BOT_MANAGEMENT","ACCESS_RULES","IP_REPUTATION","API_SHIELD","DATA_LOSS_PREVENTION"],"type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","in":"query","name":"normalization","schema":{"enum":["PERCENTAGE_CHANGE","MIN0_MAX"],"type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"aggInterval":{"example":"1h","type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"example":"ALL","type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"example":"OUTAGE","type":"string"},"linkedUrl":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime","linkedUrl"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"lastUpdated":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["confidenceInfo","dateRange","aggInterval","lastUpdated"],"type":"object"},"serie_0":{"properties":{"timestamps":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"},"values":{"items":{"example":0.56,"type":"string"},"type":"array"}},"required":["timestamps","values"],"type":"object"}},"required":["meta","serie_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get attacks layer 7 time series","tags":["Radar Attacks"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/attacks/layer7/timeseries_groups":{"get":{"description":"Get percentage of what type of mitigation techniques are used to block layer 7 attacks, over time.","operationId":"radar_get_AttacksLayer7TimeseriesGroups","parameters":[{"description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"enum":["15m","1h","1d","1w"],"type":"string"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"aggInterval":{"example":"1h","type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"example":"ALL","type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"example":"OUTAGE","type":"string"},"linkedUrl":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime","linkedUrl"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"lastUpdated":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["confidenceInfo","dateRange","aggInterval","lastUpdated"],"type":"object"},"serie_0":{"properties":{"access_rules":{"items":{"example":"5","type":"string"},"type":"array"},"api_shield":{"items":{"example":"5","type":"string"},"type":"array"},"bot_management":{"items":{"example":"5","type":"string"},"type":"array"},"data_loss_prevention":{"items":{"example":"5","type":"string"},"type":"array"},"ddos":{"items":{"example":"60","type":"string"},"type":"array"},"ip_reputation":{"items":{"example":"5","type":"string"},"type":"array"},"timestamps":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"},"waf":{"items":{"example":"30","type":"string"},"type":"array"}},"required":["timestamps","waf","ddos","ip_reputation","access_rules","bot_management","api_shield","data_loss_prevention"],"type":"object"}},"required":["meta","serie_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get layer 7 attacks by mitigation technique, over time","tags":["Radar Attacks"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/attacks/layer7/top/ases/origin":{"get":{"description":"Get the top origin ASes by layer 7 attacks. Values are a percentage out of the total layer 7 attacks. The origin location is determined by the client IP.","operationId":"radar_get_AttacksLayer7TopOriginASes","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of locations (alpha-2 country codes).","in":"query","name":"location","schema":{"items":{"description":"Array of locations (alpha-2 country codes).","example":"US","type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"top_0":{"items":{"properties":{"originAsn":{"example":16509,"type":"number"},"originAsnName":{"example":"AMAZON-02","type":"string"},"rank":{"example":1,"type":"integer"},"value":{"example":"0.73996","type":"string"}},"required":["originAsn","originAsnName","value","rank"],"type":"object"},"type":"array"}},"required":["top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get layer 7 top origin ASes","tags":["Radar Attacks"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/attacks/layer7/top/attacks":{"get":{"description":"Get the top attacks from origin to target location. Values are a percentage out of the total layer 7 attacks (with billing country). The attack magnitude can be defined by the number of mitigated requests or by the number of zones affected. You can optionally limit the number of attacks per origin/target location (useful if all the top attacks are from or to the same location).","operationId":"radar_get_AttacksLayer7TopAttacks","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Attack magnitude can be defined by total requests mitigated or by total zones attacked.","in":"query","name":"magnitude","schema":{"enum":["AFFECTED_ZONES","MITIGATED_REQUESTS"],"type":"string"}},{"description":"Array of attack origin/target location attack limits. Together with `limitPerLocation`, limits how many objects will be fetched per origin/target location.","in":"query","name":"limitDirection","schema":{"enum":["ORIGIN","TARGET"],"type":"string"}},{"description":"Limit the number of attacks per origin/target (refer to `limitDirection` parameter) location.","in":"query","name":"limitPerLocation","schema":{"default":10,"description":"Limit the number of attacks per origin/target (refer to `limitDirection` parameter) location.","example":10,"type":"integer"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"top_0":{"items":{"properties":{"originCountryAlpha2":{"example":"US","type":"string"},"originCountryName":{"example":"United States","type":"string"},"rank":{"example":1,"type":"integer"},"targetCountryAlpha2":{"example":"PT","type":"string"},"targetCountryName":{"example":"Portugal","type":"string"},"value":{"example":"0.73996","type":"string"}},"required":["originCountryName","originCountryAlpha2","targetCountryName","targetCountryAlpha2","value","rank"],"type":"object"},"type":"array"}},"required":["top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get layer 7 top attack pairs (origin and target locations)","tags":["Radar Attacks"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/attacks/layer7/top/locations/origin":{"get":{"description":"Get the top origin locations of and by layer 7 attacks. Values are a percentage out of the total layer 7 attacks. The origin location is determined by the client IP.","operationId":"radar_get_AttacksLayer7TopOriginLocations","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"top_0":{"items":{"properties":{"originCountryAlpha2":{"example":"US","type":"string"},"originCountryName":{"example":"United States","type":"string"},"rank":{"example":1,"type":"integer"},"value":{"example":"0.73996","type":"string"}},"required":["originCountryName","originCountryAlpha2","value","rank"],"type":"object"},"type":"array"}},"required":["top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get layer 7 top origin locations","tags":["Radar Attacks"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/attacks/layer7/top/locations/target":{"get":{"description":"Get the top target locations of and by layer 7 attacks. Values are a percentage out of the total layer 7 attacks. The target location is determined by the attacked zone's billing country, when available.","operationId":"radar_get_AttacksLayer7TopTargetLocations","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"top_0":{"items":{"properties":{"rank":{"example":1,"type":"integer"},"targetCountryAlpha2":{"example":"US","type":"string"},"targetCountryName":{"example":"United States","type":"string"},"value":{"example":"0.73996","type":"string"}},"required":["targetCountryName","targetCountryAlpha2","value","rank"],"type":"object"},"type":"array"}},"required":["top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get layer 7 top target locations","tags":["Radar Attacks"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/bgp/leaks/events":{"get":{"description":"Get the BGP route leak events.","operationId":"radar_get_BGPRouteLeakEvents","parameters":[{"description":"Current page number, starting from 1","in":"query","name":"page","schema":{"default":1,"description":"Current page number, starting from 1","type":"integer"}},{"description":"Number of entries per page","in":"query","name":"per_page","schema":{"default":50,"description":"Number of entries per page","type":"integer"}},{"description":"The leaking AS of a route leak event","in":"query","name":"leakAsn","schema":{"description":"The leaking AS of a route leak event","type":"integer"}},{"description":"ASN that is causing or affected by a route leak event","in":"query","name":"involvedAsn","schema":{"description":"ASN that is causing or affected by a route leak event","type":"integer"}},{"description":"Shorthand date ranges for the last X days - use when you don't need specific start and end dates.","in":"query","name":"dateRange","schema":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"}},{"description":"Start of the date range (inclusive).","in":"query","name":"dateStart","schema":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},{"description":"Sort events by field","in":"query","name":"sortBy","schema":{"enum":["ID","LEAKS","PEERS","PREFIXES","ORIGINS","TIME"],"type":"string"}},{"description":"Sort order","in":"query","name":"sortOrder","schema":{"enum":["ASC","DESC"],"type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"asn_info":{"items":{"properties":{"asn":{"type":"integer"},"org_name":{"type":"string"}},"required":["asn","org_name"],"type":"object"},"type":"array"},"events":{"items":{"properties":{"detected_ts":{"type":"string"},"finished":{"type":"boolean"},"id":{"type":"integer"},"leak_asn":{"type":"integer"},"leak_count":{"type":"integer"},"leak_seg":{"items":{"type":"integer"},"type":"array"},"leak_type":{"type":"integer"},"max_ts":{"type":"string"},"min_ts":{"type":"string"},"origin_count":{"type":"integer"},"peer_count":{"type":"integer"},"prefix_count":{"type":"integer"}},"required":["detected_ts","finished","id","leak_asn","leak_count","leak_seg","leak_type","max_ts","min_ts","origin_count","peer_count","prefix_count"],"type":"object"},"type":"array"}},"required":["asn_info","events"],"type":"object"},"result_info":{"properties":{"count":{"type":"integer"},"page":{"type":"integer"},"per_page":{"type":"integer"},"total_count":{"type":"integer"}},"required":["count","total_count","page","per_page"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","result_info","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get BGP route leak events","tags":["Radar BGP"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/bgp/timeseries":{"get":{"description":"Gets BGP updates change over time. Raw values are returned. When requesting updates of an autonomous system (AS), only BGP updates of type announcement are returned.","operationId":"radar_get_BgpTimeseries","parameters":[{"description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"enum":["15m","1h","1d","1w"],"type":"string"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Network prefix, IPv4 or IPv6.","in":"query","name":"prefix","schema":{"description":"Network prefix, IPv4 or IPv6.","example":"1.1.1.0/24","type":"string"}},{"description":"Array of BGP update types.","in":"query","name":"updateType","schema":{"items":{"enum":["ANNOUNCEMENT","WITHDRAWAL"],"type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"aggInterval":{"example":"1h","type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"example":"ALL","type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"example":"OUTAGE","type":"string"},"linkedUrl":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime","linkedUrl"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"lastUpdated":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["confidenceInfo","dateRange","aggInterval","lastUpdated"],"type":"object"},"serie_0":{"properties":{"timestamps":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"},"values":{"items":{"example":0.56,"type":"string"},"type":"array"}},"required":["timestamps","values"],"type":"object"}},"required":["meta","serie_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get BGP time series","tags":["Radar BGP"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/bgp/top/ases":{"get":{"description":"Get the top autonomous systems (AS) by BGP updates (announcements only). Values are a percentage out of the total updates.","operationId":"radar_get_BGPTopASes","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of BGP network prefixes.","in":"query","name":"prefix","schema":{"items":{"description":"Array of BGP network prefixes.","example":"1.1.1.0/24","type":"string"},"type":"array"}},{"description":"Array of BGP update types.","in":"query","name":"updateType","schema":{"items":{"enum":["ANNOUNCEMENT","WITHDRAWAL"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"dateRange":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["dateRange"],"type":"object"},"top_0":{"items":{"properties":{"ASName":{"example":"Apple-Engineering","type":"string"},"asn":{"example":714,"type":"integer"},"value":{"description":"Percentage of updates by this AS out of the total updates by all autonomous systems.","example":"0.73996","type":"string"}},"required":["asn","ASName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top autonomous systems","tags":["Radar BGP"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/bgp/top/prefixes":{"get":{"description":"Get the top network prefixes by BGP updates. Values are a percentage out of the total BGP updates.","operationId":"radar_get_BGPTopPrefixes","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of BGP update types.","in":"query","name":"updateType","schema":{"items":{"enum":["ANNOUNCEMENT","WITHDRAWAL"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"dateRange":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["dateRange"],"type":"object"},"top_0":{"items":{"properties":{"prefix":{"example":"2804:77cc:8000::/33","type":"string"},"value":{"example":"0.73996","type":"string"}},"required":["prefix","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top prefixes","tags":["Radar BGP"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/datasets":{"get":{"description":"Get a list of datasets.","operationId":"radar_get_DatasetList","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Number of objects to skip before grabbing results.","in":"query","name":"offset","schema":{"default":0,"description":"Number of objects to skip before grabbing results.","example":0,"type":"integer"}},{"description":"Dataset type.","in":"query","name":"datasetType","schema":{"enum":["RANKING_BUCKET","REPORT"],"type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"datasets":{"items":{"properties":{"description":{"example":"This dataset contains a list of the op 20000 domains globally","type":"string"},"id":{"example":3,"type":"integer"},"meta":{"type":"object"},"tags":{"items":{"example":"global","type":"string"},"type":"array"},"title":{"example":"Top bucket 20000 domains","type":"string"},"type":{"example":"RANKING_BUCKET","type":"string"}},"required":["id","title","description","type","tags","meta"],"type":"object"},"type":"array"}},"required":["datasets"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Datasets","tags":["Radar Datasets"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/datasets/download":{"post":{"description":"Get a url to download a single dataset.","operationId":"radar_post_DatasetDownload","parameters":[{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"datasetId":{"example":3,"type":"integer"}},"required":["datasetId"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"dataset":{"properties":{"url":{"example":"https://example.com/download","type":"string"}},"required":["url"],"type":"object"}},"required":["dataset"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Dataset download url","tags":["Radar Datasets"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/datasets/{alias}":{"get":{"description":"Get the csv content of a given dataset by alias or id. When getting the content by alias the latest dataset is returned, optionally filtered by the latest available at a given date.","operationId":"radar_get_DatasetStream","parameters":[{"description":"Dataset alias or id","in":"path","name":"alias","required":true,"schema":{"description":"Dataset alias or id","example":"ranking_top_1000","type":"string"}},{"description":"Filter dataset alias by date","in":"query","name":"date","schema":{"description":"Filter dataset alias by date","example":"2022-09-15","format":"date","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Dataset csv Stream","tags":["Radar Datasets"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/dns/top/ases":{"get":{"description":"Get top autonomous systems by DNS queries made to Cloudflare's public DNS resolver.","operationId":"radar_get_DnsTopAses","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"Array of domain names.","in":"query","name":"domain","required":true,"schema":{"items":{"description":"Array of domain names.","example":"google.com","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientASN":{"example":174,"type":"integer"},"clientASName":{"example":"Cogent-174","type":"string"},"value":{"example":"65","type":"string"}},"required":["clientASN","clientASName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top autonomous systems by DNS queries.","tags":["Radar DNS"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/dns/top/locations":{"get":{"description":"Get top locations by DNS queries made to Cloudflare's public DNS resolver.","operationId":"radar_get_DnsTopLocations","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"Array of domain names.","in":"query","name":"domain","required":true,"schema":{"items":{"description":"Array of domain names.","example":"google.com","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"PT","type":"string"},"clientCountryName":{"example":"Portugal","type":"string"},"value":{"example":"65","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top locations by DNS queries","tags":["Radar DNS"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/summary/arc":{"get":{"description":"Percentage distribution of emails classified per Arc validation.","operationId":"radar_get_EmailSecurityArcSummary","parameters":[{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for dkim.","in":"query","name":"dkim","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dmarc.","in":"query","name":"dmarc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for spf.","in":"query","name":"spf","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"summary_0":{"properties":{"FAIL":{"example":"2","type":"string"},"NONE":{"example":"53","type":"string"},"PASS":{"example":"45","type":"string"}},"required":["NONE","PASS","FAIL"],"type":"object"}},"required":["meta","summary_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a summary of ARC validations","tags":["Radar Email"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/summary/dkim":{"get":{"description":"Percentage distribution of emails classified per DKIM validation.","operationId":"radar_get_EmailSecurityDkimSummary","parameters":[{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for arc (Authenticated Received Chain).","in":"query","name":"arc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dmarc.","in":"query","name":"dmarc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for spf.","in":"query","name":"spf","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"summary_0":{"properties":{"FAIL":{"example":"2","type":"string"},"NONE":{"example":"53","type":"string"},"PASS":{"example":"45","type":"string"}},"required":["NONE","PASS","FAIL"],"type":"object"}},"required":["meta","summary_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a summary of DKIM validations","tags":["Radar Email"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/summary/dmarc":{"get":{"description":"Percentage distribution of emails classified per DMARC validation.","operationId":"radar_get_EmailSecurityDmarcSummary","parameters":[{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for arc (Authenticated Received Chain).","in":"query","name":"arc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dkim.","in":"query","name":"dkim","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for spf.","in":"query","name":"spf","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"summary_0":{"properties":{"FAIL":{"example":"2","type":"string"},"NONE":{"example":"53","type":"string"},"PASS":{"example":"45","type":"string"}},"required":["NONE","PASS","FAIL"],"type":"object"}},"required":["meta","summary_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a summary of DMARC validations","tags":["Radar Email"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/summary/malicious":{"get":{"description":"Percentage distribution of emails classified as MALICIOUS.","operationId":"radar_get_EmailSecurityMaliciousSummary","parameters":[{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for arc (Authenticated Received Chain).","in":"query","name":"arc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dkim.","in":"query","name":"dkim","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dmarc.","in":"query","name":"dmarc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for spf.","in":"query","name":"spf","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"summary_0":{"properties":{"MALICIOUS":{"example":"65","type":"string"},"NOT_MALICIOUS":{"example":"35","type":"string"}},"required":["MALICIOUS","NOT_MALICIOUS"],"type":"object"}},"required":["meta","summary_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a summary of MALICIOUS validations","tags":["Radar Email"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/summary/spam":{"get":{"description":"Percentage distribution of emails classified as SPAM.","operationId":"radar_get_EmailSecuritySpamSummary","parameters":[{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for arc (Authenticated Received Chain).","in":"query","name":"arc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dkim.","in":"query","name":"dkim","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dmarc.","in":"query","name":"dmarc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for spf.","in":"query","name":"spf","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"summary_0":{"properties":{"NOT_SPAM":{"example":"35","type":"string"},"SPAM":{"example":"65","type":"string"}},"required":["SPAM","NOT_SPAM"],"type":"object"}},"required":["meta","summary_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a summary of SPAM validations","tags":["Radar Email"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/summary/spf":{"get":{"description":"Percentage distribution of emails classified per SPF validation.","operationId":"radar_get_EmailSecuritySpfSummary","parameters":[{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for arc (Authenticated Received Chain).","in":"query","name":"arc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dkim.","in":"query","name":"dkim","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dmarc.","in":"query","name":"dmarc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"summary_0":{"properties":{"FAIL":{"example":"2","type":"string"},"NONE":{"example":"53","type":"string"},"PASS":{"example":"45","type":"string"}},"required":["NONE","PASS","FAIL"],"type":"object"}},"required":["meta","summary_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a summary of SPF validations","tags":["Radar Email"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/summary/threat_category":{"get":{"description":"Percentage distribution of emails classified in Threat Categories.","operationId":"radar_get_EmailSecurityThreatCategorySummary","parameters":[{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for arc (Authenticated Received Chain).","in":"query","name":"arc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dkim.","in":"query","name":"dkim","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dmarc.","in":"query","name":"dmarc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for spf.","in":"query","name":"spf","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"summary_0":{"properties":{"BrandImpersonation":{"example":"35","type":"string"},"CredentialHarvester":{"example":"32","type":"string"},"IdentityDeception":{"example":"47","type":"string"},"Link":{"example":"43","type":"string"}},"required":["IdentityDeception","Link","BrandImpersonation","CredentialHarvester"],"type":"object"}},"required":["meta","summary_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a summary of Threat Categories","tags":["Radar Email"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/timeseries/arc":{"get":{"description":"Percentage distribution of emails classified per Arc validation over time.","operationId":"radar_get_EmailSecurityArcTimeseriesGroup","parameters":[{"description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"enum":["15m","1h","1d","1w"],"type":"string"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for dkim.","in":"query","name":"dkim","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dmarc.","in":"query","name":"dmarc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for spf.","in":"query","name":"spf","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"serie_0":{"properties":{"FAIL":{"items":{"example":"2","type":"string"},"type":"array"},"NONE":{"items":{"example":"53","type":"string"},"type":"array"},"PASS":{"items":{"example":"45","type":"string"},"type":"array"}},"required":["NONE","PASS","FAIL"],"type":"object"}},"required":["meta","serie_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a time series of ARC validations","tags":["Radar Email"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/timeseries/dkim":{"get":{"description":"Percentage distribution of emails classified per DKIM validation over time.","operationId":"radar_get_EmailSecurityDkimTimeseriesGroup","parameters":[{"description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"enum":["15m","1h","1d","1w"],"type":"string"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for arc (Authenticated Received Chain).","in":"query","name":"arc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dmarc.","in":"query","name":"dmarc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for spf.","in":"query","name":"spf","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"serie_0":{"properties":{"FAIL":{"items":{"example":"2","type":"string"},"type":"array"},"NONE":{"items":{"example":"53","type":"string"},"type":"array"},"PASS":{"items":{"example":"45","type":"string"},"type":"array"}},"required":["NONE","PASS","FAIL"],"type":"object"}},"required":["meta","serie_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a time series of DKIM validations validations","tags":["Radar Email"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/timeseries/dmarc":{"get":{"description":"Percentage distribution of emails classified per DMARC validation over time.","operationId":"radar_get_EmailSecurityDmarcTimeseriesGroup","parameters":[{"description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"enum":["15m","1h","1d","1w"],"type":"string"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for arc (Authenticated Received Chain).","in":"query","name":"arc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dkim.","in":"query","name":"dkim","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for spf.","in":"query","name":"spf","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"serie_0":{"properties":{"FAIL":{"items":{"example":"2","type":"string"},"type":"array"},"NONE":{"items":{"example":"53","type":"string"},"type":"array"},"PASS":{"items":{"example":"45","type":"string"},"type":"array"}},"required":["NONE","PASS","FAIL"],"type":"object"}},"required":["meta","serie_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a time series of DMARC validations","tags":["Radar Email"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/timeseries/malicious":{"get":{"description":"Percentage distribution of emails classified as MALICIOUS over time.","operationId":"radar_get_EmailSecurityMaliciousTimeseriesGroup","parameters":[{"description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"enum":["15m","1h","1d","1w"],"type":"string"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for arc (Authenticated Received Chain).","in":"query","name":"arc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dkim.","in":"query","name":"dkim","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dmarc.","in":"query","name":"dmarc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for spf.","in":"query","name":"spf","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"serie_0":{"properties":{"MALICIOUS":{"items":{"example":"65","type":"string"},"type":"array"},"NOT_MALICIOUS":{"items":{"example":"35","type":"string"},"type":"array"}},"required":["MALICIOUS","NOT_MALICIOUS"],"type":"object"}},"required":["meta","serie_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a time series of MALICIOUS validations","tags":["Radar Email"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/timeseries/spam":{"get":{"description":"Percentage distribution of emails classified as SPAM over time.","operationId":"radar_get_EmailSecuritySpamTimeseriesGroup","parameters":[{"description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"enum":["15m","1h","1d","1w"],"type":"string"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for arc (Authenticated Received Chain).","in":"query","name":"arc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dkim.","in":"query","name":"dkim","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dmarc.","in":"query","name":"dmarc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for spf.","in":"query","name":"spf","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"serie_0":{"properties":{"NOT_SPAM":{"items":{"example":"35","type":"string"},"type":"array"},"SPAM":{"items":{"example":"65","type":"string"},"type":"array"}},"required":["SPAM","NOT_SPAM"],"type":"object"}},"required":["meta","serie_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a time series of SPAM validations","tags":["Radar Email"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/timeseries/spf":{"get":{"description":"Percentage distribution of emails classified per SPF validation over time.","operationId":"radar_get_EmailSecuritySpfTimeseriesGroup","parameters":[{"description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"enum":["15m","1h","1d","1w"],"type":"string"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for arc (Authenticated Received Chain).","in":"query","name":"arc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dkim.","in":"query","name":"dkim","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dmarc.","in":"query","name":"dmarc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"serie_0":{"properties":{"FAIL":{"items":{"example":"2","type":"string"},"type":"array"},"NONE":{"items":{"example":"53","type":"string"},"type":"array"},"PASS":{"items":{"example":"45","type":"string"},"type":"array"}},"required":["NONE","PASS","FAIL"],"type":"object"}},"required":["meta","serie_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a time series of SPF validations","tags":["Radar Email"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/timeseries/threat_category":{"get":{"description":"Percentage distribution of emails classified in Threat Categories over time.","operationId":"radar_get_EmailSecurityThreatCategoryTimeseriesGroup","parameters":[{"description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"enum":["15m","1h","1d","1w"],"type":"string"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for arc (Authenticated Received Chain).","in":"query","name":"arc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dkim.","in":"query","name":"dkim","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dmarc.","in":"query","name":"dmarc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for spf.","in":"query","name":"spf","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"serie_0":{"properties":{"BrandImpersonation":{"items":{"example":"35","type":"string"},"type":"array"},"CredentialHarvester":{"items":{"example":"32","type":"string"},"type":"array"},"IdentityDeception":{"items":{"example":"47","type":"string"},"type":"array"},"Link":{"items":{"example":"43","type":"string"},"type":"array"}},"required":["IdentityDeception","Link","BrandImpersonation","CredentialHarvester"],"type":"object"}},"required":["meta","serie_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a time series of Threat Categories","tags":["Radar Email"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/top/ases":{"get":{"description":"Get the top autonomous systems (AS) by HTTP traffic. Values are a percentage out of the total traffic.","operationId":"radar_get_EmailSecurityTopASes","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for arc (Authenticated Received Chain).","in":"query","name":"arc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dkim.","in":"query","name":"dkim","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dmarc.","in":"query","name":"dmarc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for spf.","in":"query","name":"spf","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientASN":{"example":3243,"type":"integer"},"clientASName":{"example":"MEO","type":"string"},"value":{"example":"3","type":"string"}},"required":["clientASN","clientASName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top autonomous systems by HTTP requests","tags":["Radar Email"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/top/ases/arc/{arc}":{"get":{"description":"Get the top autonomous systems (AS), by emails classified, of ARC validations.","operationId":"radar_get_EmailSecurityTopASesByArc","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for dkim.","in":"query","name":"dkim","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dmarc.","in":"query","name":"dmarc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for spf.","in":"query","name":"spf","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"ARC.","in":"path","name":"arc","required":true,"schema":{"enum":["PASS","NONE","FAIL"],"type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientASN":{"example":3243,"type":"integer"},"clientASName":{"example":"MEO","type":"string"},"value":{"example":"3","type":"string"}},"required":["clientASN","clientASName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top autonomous systems by ARC validations","tags":["Radar Email"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/top/ases/dkim/{dkim}":{"get":{"description":"Get the top autonomous systems (AS), by emails classified, of DKIM validations.","operationId":"radar_get_EmailSecurityTopASesByDkim","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for arc (Authenticated Received Chain).","in":"query","name":"arc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dmarc.","in":"query","name":"dmarc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for spf.","in":"query","name":"spf","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"DKIM.","in":"path","name":"dkim","required":true,"schema":{"enum":["PASS","NONE","FAIL"],"type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientASN":{"example":3243,"type":"integer"},"clientASName":{"example":"MEO","type":"string"},"value":{"example":"3","type":"string"}},"required":["clientASN","clientASName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top autonomous systems by DKIM validations","tags":["Radar Email"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/top/ases/dmarc/{dmarc}":{"get":{"description":"Get the top autonomous systems (AS), by emails classified, of DMARC validations.","operationId":"radar_get_EmailSecurityTopASesByDmarc","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for arc (Authenticated Received Chain).","in":"query","name":"arc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dkim.","in":"query","name":"dkim","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for spf.","in":"query","name":"spf","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"DMARC.","in":"path","name":"dmarc","required":true,"schema":{"enum":["PASS","NONE","FAIL"],"type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientASN":{"example":3243,"type":"integer"},"clientASName":{"example":"MEO","type":"string"},"value":{"example":"3","type":"string"}},"required":["clientASN","clientASName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top autonomous systems by DMARC validations","tags":["Radar Email"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/top/ases/malicious/{malicious}":{"get":{"description":"Get the top autonomous systems (AS), by emails classified, of Malicious validations.","operationId":"radar_get_EmailSecurityTopASesByMalicious","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for arc (Authenticated Received Chain).","in":"query","name":"arc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dkim.","in":"query","name":"dkim","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dmarc.","in":"query","name":"dmarc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for spf.","in":"query","name":"spf","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Malicious.","in":"path","name":"malicious","required":true,"schema":{"enum":["MALICIOUS","NOT_MALICIOUS"],"type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientASN":{"example":3243,"type":"integer"},"clientASName":{"example":"MEO","type":"string"},"value":{"example":"3","type":"string"}},"required":["clientASN","clientASName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top autonomous systems by Malicious validations","tags":["Radar Email"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/top/ases/spam/{spam}":{"get":{"description":"Get the top autonomous systems (AS), by emails classified, of Spam validations.","operationId":"radar_get_EmailSecurityTopASesBySpam","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for arc (Authenticated Received Chain).","in":"query","name":"arc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dkim.","in":"query","name":"dkim","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dmarc.","in":"query","name":"dmarc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for spf.","in":"query","name":"spf","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Spam.","in":"path","name":"spam","required":true,"schema":{"enum":["SPAM","NOT_SPAM"],"type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientASN":{"example":3243,"type":"integer"},"clientASName":{"example":"MEO","type":"string"},"value":{"example":"3","type":"string"}},"required":["clientASN","clientASName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top autonomous systems by Spam validations","tags":["Radar Email"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/top/ases/spf/{spf}":{"get":{"description":"Get the top autonomous systems (AS), by emails classified, of SPF validations.","operationId":"radar_get_EmailSecurityTopASesBySpf","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for arc (Authenticated Received Chain).","in":"query","name":"arc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dkim.","in":"query","name":"dkim","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dmarc.","in":"query","name":"dmarc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"SPF.","in":"path","name":"spf","required":true,"schema":{"enum":["PASS","NONE","FAIL"],"type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientASN":{"example":3243,"type":"integer"},"clientASName":{"example":"MEO","type":"string"},"value":{"example":"3","type":"string"}},"required":["clientASN","clientASName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top autonomous systems by SPF validations","tags":["Radar Email"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/top/locations":{"get":{"description":"Get the top locations by HTTP traffic. Values are a percentage out of the total traffic.","operationId":"radar_get_EmailSecurityTopLocations","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for arc (Authenticated Received Chain).","in":"query","name":"arc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dkim.","in":"query","name":"dkim","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dmarc.","in":"query","name":"dmarc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for spf.","in":"query","name":"spf","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"US","type":"string"},"clientCountryName":{"example":"United States","type":"string"},"value":{"example":"65","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top autonomous systems by HTTP requests","tags":["Radar Email"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/top/locations/arc/{arc}":{"get":{"description":"Get the locations, by emails classified, of ARC validations.","operationId":"radar_get_EmailSecurityTopLocationsByArc","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for dkim.","in":"query","name":"dkim","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dmarc.","in":"query","name":"dmarc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for spf.","in":"query","name":"spf","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"ARC.","in":"path","name":"arc","required":true,"schema":{"enum":["PASS","NONE","FAIL"],"type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"US","type":"string"},"clientCountryName":{"example":"United States","type":"string"},"value":{"example":"65","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top locations by ARC validations","tags":["Radar Email"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/top/locations/dkim/{dkim}":{"get":{"description":"Get the locations, by emails classified, of DKIM validations.","operationId":"radar_get_EmailSecurityTopLocationsByDkim","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for arc (Authenticated Received Chain).","in":"query","name":"arc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dmarc.","in":"query","name":"dmarc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for spf.","in":"query","name":"spf","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"DKIM.","in":"path","name":"dkim","required":true,"schema":{"enum":["PASS","NONE","FAIL"],"type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"US","type":"string"},"clientCountryName":{"example":"United States","type":"string"},"value":{"example":"65","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top locations by DKIM validations","tags":["Radar Email"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/top/locations/dmarc/{dmarc}":{"get":{"description":"Get the locations, by emails classified, of DMARC validations.","operationId":"radar_get_EmailSecurityTopLocationsByDmarc","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for arc (Authenticated Received Chain).","in":"query","name":"arc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dkim.","in":"query","name":"dkim","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for spf.","in":"query","name":"spf","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"DMARC.","in":"path","name":"dmarc","required":true,"schema":{"enum":["PASS","NONE","FAIL"],"type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"US","type":"string"},"clientCountryName":{"example":"United States","type":"string"},"value":{"example":"65","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top locations by DMARC validations","tags":["Radar Email"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/top/locations/malicious/{malicious}":{"get":{"description":"Get the locations, by emails classified, of Malicious validations.","operationId":"radar_get_EmailSecurityTopLocationsByMalicious","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for arc (Authenticated Received Chain).","in":"query","name":"arc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dkim.","in":"query","name":"dkim","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dmarc.","in":"query","name":"dmarc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for spf.","in":"query","name":"spf","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Malicious.","in":"path","name":"malicious","required":true,"schema":{"enum":["MALICIOUS","NOT_MALICIOUS"],"type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"US","type":"string"},"clientCountryName":{"example":"United States","type":"string"},"value":{"example":"65","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top locations by Malicious validations","tags":["Radar Email"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/top/locations/spam/{spam}":{"get":{"description":"Get the locations, by emails classified, of Spam validations.","operationId":"radar_get_EmailSecurityTopLocationsBySpam","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for arc (Authenticated Received Chain).","in":"query","name":"arc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dkim.","in":"query","name":"dkim","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dmarc.","in":"query","name":"dmarc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for spf.","in":"query","name":"spf","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Spam.","in":"path","name":"spam","required":true,"schema":{"enum":["SPAM","NOT_SPAM"],"type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"US","type":"string"},"clientCountryName":{"example":"United States","type":"string"},"value":{"example":"65","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top locations by Spam validations","tags":["Radar Email"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/email/top/locations/spf/{spf}":{"get":{"description":"Get the locations, by emails classified, of SPF validations.","operationId":"radar_get_EmailSecurityTopLocationsBySpf","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for arc (Authenticated Received Chain).","in":"query","name":"arc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dkim.","in":"query","name":"dkim","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"Filter for dmarc.","in":"query","name":"dmarc","schema":{"items":{"enum":["PASS","NONE","FAIL"],"type":"string"},"type":"array"}},{"description":"SPF.","in":"path","name":"spf","required":true,"schema":{"enum":["PASS","NONE","FAIL"],"type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"US","type":"string"},"clientCountryName":{"example":"United States","type":"string"},"value":{"example":"65","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top locations by SPF validations","tags":["Radar Email"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/entities/asns":{"get":{"description":"Gets a list of autonomous systems (AS).","operationId":"radar_get_ASNsList","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Number of objects to skip before grabbing results.","in":"query","name":"offset","schema":{"default":0,"description":"Number of objects to skip before grabbing results.","example":0,"type":"integer"}},{"description":"Comma separated list of ASNs.","in":"query","name":"asn","schema":{"description":"Comma separated list of ASNs.","example":"174,7922","type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"asns":{"items":{"properties":{"aka":{"type":"string"},"asn":{"example":714,"type":"integer"},"country":{"example":"GB","type":"string"},"countryName":{"example":"United Kingdom","type":"string"},"name":{"example":"Apple Inc.","type":"string"},"nameLong":{"type":"string"},"orgName":{"type":"string"},"website":{"example":"https://www.apple.com/support/systemstatus/","type":"string"}},"required":["name","nameLong","aka","asn","website","country","countryName","orgName"],"type":"object"},"type":"array"}},"required":["asns"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get autonomous systems","tags":["Radar Entities"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/entities/asns/ip":{"get":{"description":"Get the requested autonomous system information based on IP address. Population estimates come from APNIC (refer to https://labs.apnic.net/?p=526).","operationId":"radar_get_ASNIp","parameters":[{"description":"IP address.","in":"query","name":"ip","required":true,"schema":{"description":"IP address.","example":"1.1.1.1","type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"asn":{"properties":{"aka":{"type":"string"},"asn":{"example":714,"type":"integer"},"country":{"example":"GB","type":"string"},"countryName":{"example":"United Kingdom","type":"string"},"estimatedUsers":{"properties":{"estimatedUsers":{"description":"Total estimated users","example":86099,"type":"integer"},"locations":{"items":{"properties":{"estimatedUsers":{"description":"Estimated users per location","example":16710,"type":"integer"},"locationAlpha2":{"example":"US","type":"string"},"locationName":{"example":"United States","type":"string"}},"required":["estimatedUsers","locationName","locationAlpha2"],"type":"object"},"type":"array"}},"required":["locations"],"type":"object"},"name":{"example":"Apple Inc.","type":"string"},"nameLong":{"type":"string"},"orgName":{"type":"string"},"related":{"items":{"properties":{"aka":{"type":"string"},"asn":{"type":"integer"},"estimatedUsers":{"description":"Total estimated users","example":65345,"type":"integer"},"name":{"type":"string"}},"required":["name","aka","asn"],"type":"object"},"type":"array"},"website":{"example":"https://www.apple.com/support/systemstatus/","type":"string"}},"required":["name","nameLong","aka","country","countryName","related","asn","website","orgName","estimatedUsers"],"type":"object"}},"required":["asn"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get autonomous system information by IP address","tags":["Radar Entities"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/entities/asns/{asn}":{"get":{"description":"Get the requested autonomous system information. A confidence level below `5` indicates a low level of confidence in the traffic data - normally this happens because Cloudflare has a small amount of traffic from/to this AS). Population estimates come from APNIC (refer to https://labs.apnic.net/?p=526).","operationId":"radar_get_ASNId","parameters":[{"description":"Autonomous System Number (ASN).","in":"path","name":"asn","required":true,"schema":{"description":"Autonomous System Number (ASN).","example":3,"type":"integer"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"asn":{"properties":{"aka":{"type":"string"},"asn":{"example":714,"type":"integer"},"confidenceLevel":{"example":5,"type":"integer"},"country":{"example":"GB","type":"string"},"countryName":{"example":"United Kingdom","type":"string"},"estimatedUsers":{"properties":{"estimatedUsers":{"description":"Total estimated users","example":86099,"type":"integer"},"locations":{"items":{"properties":{"estimatedUsers":{"description":"Estimated users per location","example":16710,"type":"integer"},"locationAlpha2":{"example":"US","type":"string"},"locationName":{"example":"United States","type":"string"}},"required":["estimatedUsers","locationName","locationAlpha2"],"type":"object"},"type":"array"}},"required":["locations"],"type":"object"},"name":{"example":"Apple Inc.","type":"string"},"nameLong":{"type":"string"},"orgName":{"type":"string"},"related":{"items":{"properties":{"aka":{"example":"","type":"string"},"asn":{"example":174,"type":"integer"},"estimatedUsers":{"description":"Total estimated users","example":65345,"type":"integer"},"name":{"example":"Cogent-174","type":"string"}},"required":["name","aka","asn"],"type":"object"},"type":"array"},"website":{"example":"https://www.apple.com/support/systemstatus/","type":"string"}},"required":["name","nameLong","aka","country","countryName","confidenceLevel","related","asn","website","orgName","estimatedUsers"],"type":"object"}},"required":["asn"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get autonomous system information by AS number","tags":["Radar Entities"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/entities/locations":{"get":{"description":"Get a list of locations.","operationId":"radar_get_LocationsList","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Number of objects to skip before grabbing results.","in":"query","name":"offset","schema":{"default":0,"description":"Number of objects to skip before grabbing results.","example":0,"type":"integer"}},{"description":"Comma separated list of locations.","in":"query","name":"location","schema":{"description":"Comma separated list of locations.","example":"US,CA","type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"locations":{"items":{"properties":{"alpha2":{"example":"AF","type":"string"},"latitude":{"example":33.939116,"type":"string"},"longitude":{"example":67.709953,"type":"string"},"name":{"example":"Afghanistan","type":"string"}},"required":["name","latitude","longitude","alpha2"],"type":"object"},"type":"array"}},"required":["locations"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get locations","tags":["Radar Entities"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/entities/locations/{location}":{"get":{"description":"Get the requested location information. A confidence level below `5` indicates a low level of confidence in the traffic data - normally this happens because Cloudflare has a small amount of traffic from/to this location).","operationId":"radar_get_LocationsOne","parameters":[{"description":"Alpha-2 country code.","in":"path","name":"location","required":true,"schema":{"description":"Alpha-2 country code.","example":"US","type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"location":{"properties":{"alpha2":{"example":"AF","type":"string"},"confidenceLevel":{"example":5,"type":"integer"},"latitude":{"example":33.939116,"type":"string"},"longitude":{"example":67.709953,"type":"string"},"name":{"example":"Afghanistan","type":"string"},"region":{"example":"Middle East","type":"string"},"subregion":{"example":"Southern Asia","type":"string"}},"required":["name","region","subregion","latitude","longitude","alpha2","confidenceLevel"],"type":"object"}},"required":["location"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get location","tags":["Radar Entities"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/summary/bot_class":{"get":{"description":"Percentage distribution of traffic classified as automated or human.","operationId":"radar_get_SummaryBotClass","parameters":[{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for device type.","in":"query","name":"deviceType","schema":{"items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filter for http protocol.","in":"query","name":"httpProtocol","schema":{"items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filter for http version.","in":"query","name":"httpVersion","schema":{"items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filter for ip version.","in":"query","name":"ipVersion","schema":{"items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filter for os name.","in":"query","name":"os","schema":{"items":{"enum":["WINDOWS","MACOSX","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filter for tls version.","in":"query","name":"tlsVersion","schema":{"items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"summary_0":{"properties":{"bot":{"example":"35","type":"string"},"human":{"example":"65","type":"string"}},"required":["human","bot"],"type":"object"}},"required":["meta","summary_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a summary of bot classes","tags":["Radar Http"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/summary/device_type":{"get":{"description":"Percentage distribution of traffic per device type.","operationId":"radar_get_SummaryDeviceType","parameters":[{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filter for http protocol.","in":"query","name":"httpProtocol","schema":{"items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filter for http version.","in":"query","name":"httpVersion","schema":{"items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filter for ip version.","in":"query","name":"ipVersion","schema":{"items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filter for os name.","in":"query","name":"os","schema":{"items":{"enum":["WINDOWS","MACOSX","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filter for tls version.","in":"query","name":"tlsVersion","schema":{"items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"summary_0":{"properties":{"desktop":{"example":"65","type":"string"},"mobile":{"example":"30","type":"string"},"other":{"example":"5","type":"string"}},"required":["desktop","mobile","other"],"type":"object"}},"required":["meta","summary_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a summary of device types","tags":["Radar Http"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/summary/http_protocol":{"get":{"description":"Percentage distribution of traffic per HTTP protocol.","operationId":"radar_get_SummaryHttpProtocol","parameters":[{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filter for device type.","in":"query","name":"deviceType","schema":{"items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filter for http version.","in":"query","name":"httpVersion","schema":{"items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filter for ip version.","in":"query","name":"ipVersion","schema":{"items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filter for os name.","in":"query","name":"os","schema":{"items":{"enum":["WINDOWS","MACOSX","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filter for tls version.","in":"query","name":"tlsVersion","schema":{"items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"summary_0":{"properties":{"http":{"example":"99","type":"string"},"https":{"example":"1","type":"string"}},"required":["http","https"],"type":"object"}},"required":["meta","summary_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a summary of HTTP protocols","tags":["Radar Http"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/summary/http_version":{"get":{"description":"Percentage distribution of traffic per HTTP protocol version.","operationId":"radar_get_SummaryHttpVersion","parameters":[{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filter for device type.","in":"query","name":"deviceType","schema":{"items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filter for http protocol.","in":"query","name":"httpProtocol","schema":{"items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filter for ip version.","in":"query","name":"ipVersion","schema":{"items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filter for os name.","in":"query","name":"os","schema":{"items":{"enum":["WINDOWS","MACOSX","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filter for tls version.","in":"query","name":"tlsVersion","schema":{"items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"summary_0":{"properties":{"HTTP/1.x":{"example":"1","type":"string"},"HTTP/2":{"example":"39","type":"string"},"HTTP/3":{"example":"60","type":"string"}},"required":["HTTP/1.x","HTTP/2","HTTP/3"],"type":"object"}},"required":["meta","summary_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a summary of HTTP versions","tags":["Radar Http"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/summary/ip_version":{"get":{"description":"Percentage distribution of traffic per IP protocol version.","operationId":"radar_get_SummaryIpVersion","parameters":[{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filter for device type.","in":"query","name":"deviceType","schema":{"items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filter for http protocol.","in":"query","name":"httpProtocol","schema":{"items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filter for http version.","in":"query","name":"httpVersion","schema":{"items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filter for os name.","in":"query","name":"os","schema":{"items":{"enum":["WINDOWS","MACOSX","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filter for tls version.","in":"query","name":"tlsVersion","schema":{"items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"summary_0":{"properties":{"IPv4":{"example":"65","type":"string"},"IPv6":{"example":"35","type":"string"}},"required":["IPv4","IPv6"],"type":"object"}},"required":["meta","summary_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a summary of IP versions","tags":["Radar Http"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/summary/os":{"get":{"description":"Percentage distribution of traffic per operating system.","operationId":"radar_get_SummaryOS","parameters":[{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filter for device type.","in":"query","name":"deviceType","schema":{"items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filter for http protocol.","in":"query","name":"httpProtocol","schema":{"items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filter for http version.","in":"query","name":"httpVersion","schema":{"items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filter for ip version.","in":"query","name":"ipVersion","schema":{"items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filter for tls version.","in":"query","name":"tlsVersion","schema":{"items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"summary_0":{"properties":{"ANDROID":{"example":"65","type":"string"},"IOS":{"example":"35","type":"string"}},"required":["ANDROID","IOS"],"type":"object"}},"required":["meta","summary_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a summary of operating systems","tags":["Radar Http"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/summary/tls_version":{"get":{"description":"Percentage distribution of traffic per TLS protocol version.","operationId":"radar_get_SummaryTLSVersion","parameters":[{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filter for device type.","in":"query","name":"deviceType","schema":{"items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filter for http protocol.","in":"query","name":"httpProtocol","schema":{"items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filter for http version.","in":"query","name":"httpVersion","schema":{"items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filter for ip version.","in":"query","name":"ipVersion","schema":{"items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filter for os name.","in":"query","name":"os","schema":{"items":{"enum":["WINDOWS","MACOSX","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"summary_0":{"properties":{"TLS 1.0":{"example":"0.5","type":"string"},"TLS 1.1":{"example":"0.5","type":"string"},"TLS 1.2":{"example":"60","type":"string"},"TLS 1.3":{"example":"10","type":"string"},"TLS QUIC":{"example":"29","type":"string"}},"required":["TLS 1.0","TLS 1.1","TLS 1.2","TLS 1.3","TLS QUIC"],"type":"object"}},"required":["meta","summary_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a summary of TLS versions","tags":["Radar Http"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/timeseries/bot_class":{"get":{"description":"Percentage distribution of traffic classified as automated or human over time.","operationId":"radar_get_TimeseriesBotClass","parameters":[{"description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"enum":["15m","1h","1d","1w"],"type":"string"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for device type.","in":"query","name":"deviceType","schema":{"items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filter for http protocol.","in":"query","name":"httpProtocol","schema":{"items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filter for http version.","in":"query","name":"httpVersion","schema":{"items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filter for ip version.","in":"query","name":"ipVersion","schema":{"items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filter for os name.","in":"query","name":"os","schema":{"items":{"enum":["WINDOWS","MACOSX","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filter for tls version.","in":"query","name":"tlsVersion","schema":{"items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"serie_0":{"properties":{"bot":{"items":{"type":"string"},"type":"array"},"human":{"items":{"type":"string"},"type":"array"},"timestamps":{"items":{"type":"string"},"type":"array"}},"required":["timestamps","human","bot"],"type":"object"}},"required":["meta","serie_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get time series of bot classes","tags":["Radar Http"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/timeseries/browser":{"get":{"description":"Percentage distribution of traffic of the top user agents in the selected time range, over time.","operationId":"radar_get_TimeseriesBrowsers","parameters":[{"description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"enum":["15m","1h","1d","1w"],"type":"string"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for device type.","in":"query","name":"deviceType","schema":{"items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filter for http protocol.","in":"query","name":"httpProtocol","schema":{"items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filter for http version.","in":"query","name":"httpVersion","schema":{"items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filter for ip version.","in":"query","name":"ipVersion","schema":{"items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filter for os name.","in":"query","name":"os","schema":{"items":{"enum":["WINDOWS","MACOSX","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filter for tls version.","in":"query","name":"tlsVersion","schema":{"items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Limit the number of objects (eg browsers) to the top items over the time range.","in":"query","name":"limitPerGroup","schema":{"description":"Limit the number of objects (eg browsers) to the top items over the time range.","example":2,"type":"integer"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"serie_0":{"properties":{"\u003cbrowser name\u003e":{"items":{"type":"string"},"type":"array"},"timestamps":{"items":{"type":"string"},"type":"array"}},"required":["timestamps","\u003cbrowser name\u003e"],"type":"object"}},"required":["meta","serie_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get time series of user agents","tags":["Radar Http"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/timeseries/browser_family":{"get":{"description":"Percentage distribution of traffic of the top user agents aggregated in families in the selected time range, over time.","operationId":"radar_get_TimeseriesBrowserFamilies","parameters":[{"description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"enum":["15m","1h","1d","1w"],"type":"string"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for device type.","in":"query","name":"deviceType","schema":{"items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filter for http protocol.","in":"query","name":"httpProtocol","schema":{"items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filter for http version.","in":"query","name":"httpVersion","schema":{"items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filter for ip version.","in":"query","name":"ipVersion","schema":{"items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filter for os name.","in":"query","name":"os","schema":{"items":{"enum":["WINDOWS","MACOSX","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filter for tls version.","in":"query","name":"tlsVersion","schema":{"items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"serie_0":{"properties":{"\u003cbrowser name\u003e":{"items":{"type":"string"},"type":"array"},"timestamps":{"items":{"type":"string"},"type":"array"}},"required":["timestamps","\u003cbrowser name\u003e"],"type":"object"}},"required":["meta","serie_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get time series of user agents aggregated in families","tags":["Radar Http"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/timeseries/device_type":{"get":{"description":"Percentage distribution of traffic per device type over time.","operationId":"radar_get_TimeseriesDeviceType","parameters":[{"description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"enum":["15m","1h","1d","1w"],"type":"string"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filter for http protocol.","in":"query","name":"httpProtocol","schema":{"items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filter for http version.","in":"query","name":"httpVersion","schema":{"items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filter for ip version.","in":"query","name":"ipVersion","schema":{"items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filter for os name.","in":"query","name":"os","schema":{"items":{"enum":["WINDOWS","MACOSX","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filter for tls version.","in":"query","name":"tlsVersion","schema":{"items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"serie_0":{"properties":{"desktop":{"items":{"type":"string"},"type":"array"},"mobile":{"items":{"type":"string"},"type":"array"},"other":{"items":{"type":"string"},"type":"array"},"timestamps":{"items":{"type":"string"},"type":"array"}},"required":["timestamps","desktop","mobile","other"],"type":"object"}},"required":["meta","serie_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get time series of device types","tags":["Radar Http"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/timeseries/http_protocol":{"get":{"description":"Percentage distribution of traffic per HTTP protocol over time.","operationId":"radar_get_TimeseriesHttpProtocol","parameters":[{"description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"enum":["15m","1h","1d","1w"],"type":"string"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filter for device type.","in":"query","name":"deviceType","schema":{"items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filter for http version.","in":"query","name":"httpVersion","schema":{"items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filter for ip version.","in":"query","name":"ipVersion","schema":{"items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filter for os name.","in":"query","name":"os","schema":{"items":{"enum":["WINDOWS","MACOSX","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filter for tls version.","in":"query","name":"tlsVersion","schema":{"items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"serie_0":{"properties":{"http":{"items":{"type":"string"},"type":"array"},"https":{"items":{"type":"string"},"type":"array"},"timestamps":{"items":{"type":"string"},"type":"array"}},"required":["timestamps","http","https"],"type":"object"}},"required":["meta","serie_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get time series of HTTP protocols","tags":["Radar Http"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/timeseries/http_version":{"get":{"description":"Percentage distribution of traffic per HTTP protocol version over time.","operationId":"radar_get_TimeseriesHttpVersion","parameters":[{"description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"enum":["15m","1h","1d","1w"],"type":"string"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filter for device type.","in":"query","name":"deviceType","schema":{"items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filter for http protocol.","in":"query","name":"httpProtocol","schema":{"items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filter for ip version.","in":"query","name":"ipVersion","schema":{"items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filter for os name.","in":"query","name":"os","schema":{"items":{"enum":["WINDOWS","MACOSX","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filter for tls version.","in":"query","name":"tlsVersion","schema":{"items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"serie_0":{"properties":{"HTTP/1.x":{"items":{"type":"string"},"type":"array"},"HTTP/2":{"items":{"type":"string"},"type":"array"},"HTTP/3":{"items":{"type":"string"},"type":"array"},"timestamps":{"items":{"type":"string"},"type":"array"}},"required":["timestamps","HTTP/1.x","HTTP/2","HTTP/3"],"type":"object"}},"required":["meta","serie_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get time series of HTTP versions","tags":["Radar Http"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/timeseries/ip_version":{"get":{"description":"Percentage distribution of traffic per IP protocol version over time.","operationId":"radar_get_TimeseriesIpVersion","parameters":[{"description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"enum":["15m","1h","1d","1w"],"type":"string"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filter for device type.","in":"query","name":"deviceType","schema":{"items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filter for http protocol.","in":"query","name":"httpProtocol","schema":{"items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filter for http version.","in":"query","name":"httpVersion","schema":{"items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filter for os name.","in":"query","name":"os","schema":{"items":{"enum":["WINDOWS","MACOSX","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filter for tls version.","in":"query","name":"tlsVersion","schema":{"items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"serie_0":{"properties":{"IPv4":{"items":{"type":"string"},"type":"array"},"IPv6":{"items":{"type":"string"},"type":"array"},"timestamps":{"items":{"type":"string"},"type":"array"}},"required":["timestamps","IPv4","IPv6"],"type":"object"}},"required":["meta","serie_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get time series of IP versions","tags":["Radar Http"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/timeseries/os":{"get":{"description":"Percentage distribution of traffic of the top operating systems in the selected time range, over time.","operationId":"radar_get_TimeseriesOS","parameters":[{"description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"enum":["15m","1h","1d","1w"],"type":"string"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filter for device type.","in":"query","name":"deviceType","schema":{"items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filter for http protocol.","in":"query","name":"httpProtocol","schema":{"items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filter for http version.","in":"query","name":"httpVersion","schema":{"items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filter for ip version.","in":"query","name":"ipVersion","schema":{"items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filter for tls version.","in":"query","name":"tlsVersion","schema":{"items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Limit the number of objects (eg browsers) to the top items over the time range.","in":"query","name":"limitPerGroup","schema":{"description":"Limit the number of objects (eg browsers) to the top items over the time range.","example":2,"type":"integer"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"serie_0":{"properties":{"\u003cOS name\u003e":{"items":{"type":"string"},"type":"array"},"timestamps":{"items":{"type":"string"},"type":"array"}},"required":["timestamps","\u003cOS name\u003e"],"type":"object"}},"required":["meta","serie_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get time series of operating systems","tags":["Radar Http"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/timeseries/tls_version":{"get":{"description":"Percentage distribution of traffic per TLS protocol version over time.","operationId":"radar_get_TimeseriesTLSVersion","parameters":[{"description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"enum":["15m","1h","1d","1w"],"type":"string"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filter for device type.","in":"query","name":"deviceType","schema":{"items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filter for http protocol.","in":"query","name":"httpProtocol","schema":{"items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filter for http version.","in":"query","name":"httpVersion","schema":{"items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filter for ip version.","in":"query","name":"ipVersion","schema":{"items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filter for os name.","in":"query","name":"os","schema":{"items":{"enum":["WINDOWS","MACOSX","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"type":"object"},"serie_0":{"properties":{"TLS 1.0":{"items":{"type":"string"},"type":"array"},"TLS 1.1":{"items":{"type":"string"},"type":"array"},"TLS 1.2":{"items":{"type":"string"},"type":"array"},"TLS 1.3":{"items":{"type":"string"},"type":"array"},"TLS QUIC":{"items":{"type":"string"},"type":"array"},"timestamps":{"items":{"type":"string"},"type":"array"}},"required":["timestamps","TLS 1.0","TLS 1.1","TLS 1.2","TLS 1.3","TLS QUIC"],"type":"object"}},"required":["meta","serie_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get time series of TLS versions","tags":["Radar Http"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/ases":{"get":{"description":"Get the top autonomous systems (AS) by HTTP traffic. Values are a percentage out of the total traffic.","operationId":"radar_get_HttpTopASes","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filter for device type.","in":"query","name":"deviceType","schema":{"items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filter for http protocol.","in":"query","name":"httpProtocol","schema":{"items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filter for http version.","in":"query","name":"httpVersion","schema":{"items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filter for ip version.","in":"query","name":"ipVersion","schema":{"items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filter for os name.","in":"query","name":"os","schema":{"items":{"enum":["WINDOWS","MACOSX","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filter for tls version.","in":"query","name":"tlsVersion","schema":{"items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientASN":{"example":3243,"type":"integer"},"clientASName":{"example":"MEO","type":"string"},"value":{"example":"3","type":"string"}},"required":["clientASN","clientASName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top autonomous systems by HTTP requests","tags":["Radar Http"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/ases/bot_class/{bot_class}":{"get":{"description":"Get the top autonomous systems (AS), by HTTP traffic, of the requested bot class. These two categories use Cloudflare's bot score - refer to [Bot Scores](https://developers.cloudflare.com/bots/concepts/bot-score) for more information. Values are a percentage out of the total traffic.","operationId":"radar_get_HttpTopASesByBotClass","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for device type.","in":"query","name":"deviceType","schema":{"items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filter for http protocol.","in":"query","name":"httpProtocol","schema":{"items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filter for http version.","in":"query","name":"httpVersion","schema":{"items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filter for ip version.","in":"query","name":"ipVersion","schema":{"items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filter for os name.","in":"query","name":"os","schema":{"items":{"enum":["WINDOWS","MACOSX","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filter for tls version.","in":"query","name":"tlsVersion","schema":{"items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Bot class.","in":"path","name":"bot_class","required":true,"schema":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientASN":{"example":3243,"type":"integer"},"clientASName":{"example":"MEO","type":"string"},"value":{"example":"3","type":"string"}},"required":["clientASN","clientASName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top autonomous systems by bot class","tags":["Radar Http"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/ases/device_type/{device_type}":{"get":{"description":"Get the top autonomous systems (AS), by HTTP traffic, of the requested device type. Values are a percentage out of the total traffic.","operationId":"radar_get_HttpTopASesByDeviceType","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filter for http protocol.","in":"query","name":"httpProtocol","schema":{"items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filter for http version.","in":"query","name":"httpVersion","schema":{"items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filter for ip version.","in":"query","name":"ipVersion","schema":{"items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filter for os name.","in":"query","name":"os","schema":{"items":{"enum":["WINDOWS","MACOSX","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filter for tls version.","in":"query","name":"tlsVersion","schema":{"items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Device type.","in":"path","name":"device_type","required":true,"schema":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientASN":{"example":3243,"type":"integer"},"clientASName":{"example":"MEO","type":"string"},"value":{"example":"3","type":"string"}},"required":["clientASN","clientASName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top autonomous systems by device type","tags":["Radar Http"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/ases/http_protocol/{http_protocol}":{"get":{"description":"Get the top autonomous systems (AS), by HTTP traffic, of the requested HTTP protocol. Values are a percentage out of the total traffic.","operationId":"radar_get_HttpTopASesByHTTPProtocol","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filter for device type.","in":"query","name":"deviceType","schema":{"items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filter for http protocol.","in":"query","name":"httpProtocol","schema":{"items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filter for ip version.","in":"query","name":"ipVersion","schema":{"items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filter for os name.","in":"query","name":"os","schema":{"items":{"enum":["WINDOWS","MACOSX","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filter for tls version.","in":"query","name":"tlsVersion","schema":{"items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"HTTP Protocol.","in":"path","name":"http_protocol","required":true,"schema":{"enum":["HTTP","HTTPS"],"type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientASN":{"example":3243,"type":"integer"},"clientASName":{"example":"MEO","type":"string"},"value":{"example":"3","type":"string"}},"required":["clientASN","clientASName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top autonomous systems by HTTP protocol","tags":["Radar Http"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/ases/http_version/{http_version}":{"get":{"description":"Get the top autonomous systems (AS), by HTTP traffic, of the requested HTTP protocol version. Values are a percentage out of the total traffic.","operationId":"radar_get_HttpTopASesByHTTPVersion","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filter for device type.","in":"query","name":"deviceType","schema":{"items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filter for http protocol.","in":"query","name":"httpProtocol","schema":{"items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filter for ip version.","in":"query","name":"ipVersion","schema":{"items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filter for os name.","in":"query","name":"os","schema":{"items":{"enum":["WINDOWS","MACOSX","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filter for tls version.","in":"query","name":"tlsVersion","schema":{"items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"HTTP version.","in":"path","name":"http_version","required":true,"schema":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientASN":{"example":3243,"type":"integer"},"clientASName":{"example":"MEO","type":"string"},"value":{"example":"3","type":"string"}},"required":["clientASN","clientASName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top autonomous systems by HTTP version","tags":["Radar Http"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/ases/ip_version/{ip_version}":{"get":{"description":"Get the top autonomous systems, by HTTP traffic, of the requested IP protocol version. Values are a percentage out of the total traffic.","operationId":"radar_get_HttpTopASesByIpVersion","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filter for device type.","in":"query","name":"deviceType","schema":{"items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filter for http protocol.","in":"query","name":"httpProtocol","schema":{"items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filter for http version.","in":"query","name":"httpVersion","schema":{"items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filter for os name.","in":"query","name":"os","schema":{"items":{"enum":["WINDOWS","MACOSX","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filter for tls version.","in":"query","name":"tlsVersion","schema":{"items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"IP version.","in":"path","name":"ip_version","required":true,"schema":{"enum":["IPv4","IPv6"],"type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientASN":{"example":3243,"type":"integer"},"clientASName":{"example":"MEO","type":"string"},"value":{"example":"3","type":"string"}},"required":["clientASN","clientASName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top autonomous systems by IP version","tags":["Radar Http"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/ases/os/{os}":{"get":{"description":"Get the top autonomous systems, by HTTP traffic, of the requested operating systems. Values are a percentage out of the total traffic.","operationId":"radar_get_HttpTopASesByOS","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filter for device type.","in":"query","name":"deviceType","schema":{"items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filter for http protocol.","in":"query","name":"httpProtocol","schema":{"items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filter for http version.","in":"query","name":"httpVersion","schema":{"items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filter for ip version.","in":"query","name":"ipVersion","schema":{"items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filter for tls version.","in":"query","name":"tlsVersion","schema":{"items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"IP version.","in":"path","name":"os","required":true,"schema":{"enum":["WINDOWS","MACOSX","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientASN":{"example":3243,"type":"integer"},"clientASName":{"example":"MEO","type":"string"},"value":{"example":"3","type":"string"}},"required":["clientASN","clientASName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top autonomous systems by operating system","tags":["Radar Http"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/ases/tls_version/{tls_version}":{"get":{"description":"Get the top autonomous systems (AS), by HTTP traffic, of the requested TLS protocol version. Values are a percentage out of the total traffic.","operationId":"radar_get_HttpTopASesByTLSVersion","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filter for device type.","in":"query","name":"deviceType","schema":{"items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filter for http protocol.","in":"query","name":"httpProtocol","schema":{"items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filter for http version.","in":"query","name":"httpVersion","schema":{"items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filter for ip version.","in":"query","name":"ipVersion","schema":{"items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filter for os name.","in":"query","name":"os","schema":{"items":{"enum":["WINDOWS","MACOSX","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"TLS version.","in":"path","name":"tls_version","required":true,"schema":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientASN":{"example":3243,"type":"integer"},"clientASName":{"example":"MEO","type":"string"},"value":{"example":"3","type":"string"}},"required":["clientASN","clientASName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top autonomous systems by TLS version","tags":["Radar Http"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/browser_families":{"get":{"description":"Get the top user agents aggregated in families by HTTP traffic. Values are a percentage out of the total traffic.","operationId":"radar_get_HttpTopBrowserFamilies","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filter for device type.","in":"query","name":"deviceType","schema":{"items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filter for http protocol.","in":"query","name":"httpProtocol","schema":{"items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filter for http version.","in":"query","name":"httpVersion","schema":{"items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filter for ip version.","in":"query","name":"ipVersion","schema":{"items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filter for os name.","in":"query","name":"os","schema":{"items":{"enum":["WINDOWS","MACOSX","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filter for tls version.","in":"query","name":"tlsVersion","schema":{"items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"\u003cbrowser name\u003e":{"type":"string"},"value":{"type":"string"}},"required":["\u003cbrowser name\u003e","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top user agents aggregated in families by HTTP requests","tags":["Radar Http"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/browsers":{"get":{"description":"Get the top user agents by HTTP traffic. Values are a percentage out of the total traffic.","operationId":"radar_get_HttpTopBrowsers","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filter for device type.","in":"query","name":"deviceType","schema":{"items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filter for http protocol.","in":"query","name":"httpProtocol","schema":{"items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filter for http version.","in":"query","name":"httpVersion","schema":{"items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filter for ip version.","in":"query","name":"ipVersion","schema":{"items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filter for os name.","in":"query","name":"os","schema":{"items":{"enum":["WINDOWS","MACOSX","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filter for tls version.","in":"query","name":"tlsVersion","schema":{"items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"\u003cbrowser name\u003e":{"type":"string"},"value":{"type":"string"}},"required":["\u003cbrowser name\u003e","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top user agents by HTTP requests","tags":["Radar Http"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/locations":{"get":{"description":"Get the top locations by HTTP traffic. Values are a percentage out of the total traffic.","operationId":"radar_get_HttpTopLocations","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filter for device type.","in":"query","name":"deviceType","schema":{"items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filter for http protocol.","in":"query","name":"httpProtocol","schema":{"items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filter for http version.","in":"query","name":"httpVersion","schema":{"items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filter for ip version.","in":"query","name":"ipVersion","schema":{"items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filter for os name.","in":"query","name":"os","schema":{"items":{"enum":["WINDOWS","MACOSX","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filter for tls version.","in":"query","name":"tlsVersion","schema":{"items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"US","type":"string"},"clientCountryName":{"example":"United States","type":"string"},"value":{"example":"65","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top autonomous systems by HTTP requests","tags":["Radar Http"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/locations/bot_class/{bot_class}":{"get":{"description":"Get the top locations, by HTTP traffic, of the requested bot class. These two categories use Cloudflare's bot score - refer to [Bot scores])https://developers.cloudflare.com/bots/concepts/bot-score). Values are a percentage out of the total traffic.","operationId":"radar_get_HttpTopLocationsByBotClass","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for device type.","in":"query","name":"deviceType","schema":{"items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filter for http protocol.","in":"query","name":"httpProtocol","schema":{"items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filter for http version.","in":"query","name":"httpVersion","schema":{"items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filter for ip version.","in":"query","name":"ipVersion","schema":{"items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filter for os name.","in":"query","name":"os","schema":{"items":{"enum":["WINDOWS","MACOSX","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filter for tls version.","in":"query","name":"tlsVersion","schema":{"items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Bot class.","in":"path","name":"bot_class","required":true,"schema":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"US","type":"string"},"clientCountryName":{"example":"United States","type":"string"},"value":{"example":"65","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top locations by bot class","tags":["Radar Http"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/locations/device_type/{device_type}":{"get":{"description":"Get the top locations, by HTTP traffic, of the requested device type. Values are a percentage out of the total traffic.","operationId":"radar_get_HttpTopLocationsByDeviceType","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filter for http protocol.","in":"query","name":"httpProtocol","schema":{"items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filter for http version.","in":"query","name":"httpVersion","schema":{"items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filter for ip version.","in":"query","name":"ipVersion","schema":{"items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filter for os name.","in":"query","name":"os","schema":{"items":{"enum":["WINDOWS","MACOSX","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filter for tls version.","in":"query","name":"tlsVersion","schema":{"items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"Device type.","in":"path","name":"device_type","required":true,"schema":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"US","type":"string"},"clientCountryName":{"example":"United States","type":"string"},"value":{"example":"65","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top locations by device type","tags":["Radar Http"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/locations/http_protocol/{http_protocol}":{"get":{"description":"Get the top locations, by HTTP traffic, of the requested HTTP protocol. Values are a percentage out of the total traffic.","operationId":"radar_get_HttpTopLocationsByHTTPProtocol","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filter for device type.","in":"query","name":"deviceType","schema":{"items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filter for http protocol.","in":"query","name":"httpProtocol","schema":{"items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filter for ip version.","in":"query","name":"ipVersion","schema":{"items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filter for os name.","in":"query","name":"os","schema":{"items":{"enum":["WINDOWS","MACOSX","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filter for tls version.","in":"query","name":"tlsVersion","schema":{"items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"HTTP Protocol.","in":"path","name":"http_protocol","required":true,"schema":{"enum":["HTTP","HTTPS"],"type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"US","type":"string"},"clientCountryName":{"example":"United States","type":"string"},"value":{"example":"65","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top locations by HTTP protocol","tags":["Radar Http"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/locations/http_version/{http_version}":{"get":{"description":"Get the top locations, by HTTP traffic, of the requested HTTP protocol. Values are a percentage out of the total traffic.","operationId":"radar_get_HttpTopLocationsByHTTPVersion","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filter for device type.","in":"query","name":"deviceType","schema":{"items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filter for http protocol.","in":"query","name":"httpProtocol","schema":{"items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filter for ip version.","in":"query","name":"ipVersion","schema":{"items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filter for os name.","in":"query","name":"os","schema":{"items":{"enum":["WINDOWS","MACOSX","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filter for tls version.","in":"query","name":"tlsVersion","schema":{"items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"HTTP version.","in":"path","name":"http_version","required":true,"schema":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"US","type":"string"},"clientCountryName":{"example":"United States","type":"string"},"value":{"example":"65","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top locations by HTTP version","tags":["Radar Http"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/locations/ip_version/{ip_version}":{"get":{"description":"Get the top locations, by HTTP traffic, of the requested IP protocol version. Values are a percentage out of the total traffic.","operationId":"radar_get_HttpTopLocationsByIpVersion","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filter for device type.","in":"query","name":"deviceType","schema":{"items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filter for http protocol.","in":"query","name":"httpProtocol","schema":{"items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filter for http version.","in":"query","name":"httpVersion","schema":{"items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filter for os name.","in":"query","name":"os","schema":{"items":{"enum":["WINDOWS","MACOSX","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"Filter for tls version.","in":"query","name":"tlsVersion","schema":{"items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"IP version.","in":"path","name":"ip_version","required":true,"schema":{"enum":["IPv4","IPv6"],"type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"US","type":"string"},"clientCountryName":{"example":"United States","type":"string"},"value":{"example":"65","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top locations by IP version","tags":["Radar Http"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/locations/os/{os}":{"get":{"description":"Get the top locations, by HTTP traffic, of the requested operating systems. Values are a percentage out of the total traffic.","operationId":"radar_get_HttpTopLocationsByOS","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filter for device type.","in":"query","name":"deviceType","schema":{"items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filter for http protocol.","in":"query","name":"httpProtocol","schema":{"items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filter for http version.","in":"query","name":"httpVersion","schema":{"items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filter for ip version.","in":"query","name":"ipVersion","schema":{"items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filter for tls version.","in":"query","name":"tlsVersion","schema":{"items":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"},"type":"array"}},{"description":"IP version.","in":"path","name":"os","required":true,"schema":{"enum":["WINDOWS","MACOSX","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"US","type":"string"},"clientCountryName":{"example":"United States","type":"string"},"value":{"example":"65","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top locations by operating system","tags":["Radar Http"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/http/top/locations/tls_version/{tls_version}":{"get":{"description":"Get the top locations, by HTTP traffic, of the requested TLS protocol version. Values are a percentage out of the total traffic.","operationId":"radar_get_HttpTopLocationsByTLSVersion","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).","in":"query","name":"botClass","schema":{"items":{"enum":["LIKELY_AUTOMATED","LIKELY_HUMAN"],"type":"string"},"type":"array"}},{"description":"Filter for device type.","in":"query","name":"deviceType","schema":{"items":{"enum":["DESKTOP","MOBILE","OTHER"],"type":"string"},"type":"array"}},{"description":"Filter for http protocol.","in":"query","name":"httpProtocol","schema":{"items":{"enum":["HTTP","HTTPS"],"type":"string"},"type":"array"}},{"description":"Filter for http version.","in":"query","name":"httpVersion","schema":{"items":{"enum":["HTTPv1","HTTPv2","HTTPv3"],"type":"string"},"type":"array"}},{"description":"Filter for ip version.","in":"query","name":"ipVersion","schema":{"items":{"enum":["IPv4","IPv6"],"type":"string"},"type":"array"}},{"description":"Filter for os name.","in":"query","name":"os","schema":{"items":{"enum":["WINDOWS","MACOSX","ANDROID","CHROMEOS","LINUX","SMART_TV"],"type":"string"},"type":"array"}},{"description":"TLS version.","in":"path","name":"tls_version","required":true,"schema":{"enum":["TLSv1_0","TLSv1_1","TLSv1_2","TLSv1_3","TLSvQUIC"],"type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"US","type":"string"},"clientCountryName":{"example":"United States","type":"string"},"value":{"example":"65","type":"string"}},"required":["clientCountryAlpha2","clientCountryName","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"},"404":{"content":{"application/json":{"schema":{"properties":{"error":{"example":"Not Found","type":"string"}},"required":["error"],"type":"object"}}},"description":"Not found"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top locations by TLS version","tags":["Radar Http"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/netflows/timeseries":{"get":{"description":"Get network traffic change over time. Values are normalized using min-max by default, with the minimum set to 0. When asking for multiple time series, you can also get the percentage relative change of the first/main series, with respect to the second/control series - for example, to get the relative change of this week from the previous week, the first series would have a date range of `7d`, the second, a date range of `7dControl`, and the normalization would be set to `PERCENTAGE_CHANGE`.","operationId":"radar_get_Timeseries","parameters":[{"description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"enum":["15m","1h","1d","1w"],"type":"string"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of network traffic product types.","in":"query","name":"product","schema":{"items":{"enum":["HTTP","ALL"],"type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).","in":"query","name":"normalization","schema":{"enum":["PERCENTAGE_CHANGE","MIN0_MAX"],"type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"aggInterval":{"example":"1h","type":"string"},"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"example":"ALL","type":"string"},"description":{"example":"Cable cut in Tonga","type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"example":"OUTAGE","type":"string"},"linkedUrl":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime","linkedUrl"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"},"lastUpdated":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["confidenceInfo","dateRange","aggInterval","lastUpdated"],"type":"object"},"serie_0":{"properties":{"timestamps":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"},"values":{"items":{"example":0.56,"type":"string"},"type":"array"}},"required":["timestamps","values"],"type":"object"}},"required":["meta","serie_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get NetFlow time series","tags":["Radar Netflows"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/netflows/top/ases":{"get":{"description":"Get the top autonomous systems (AS) by network traffic. Values are a percentage out of the total network traffic.","operationId":"radar_get_NetflowsTopASes","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"top_0":{"items":{"properties":{"clientASN":{"example":16509,"type":"number"},"clientASName":{"example":"AMAZON-02","type":"string"},"value":{"example":"0.73996","type":"string"}},"required":["clientASN","clientASName","value"],"type":"object"},"type":"array"}},"required":["top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top autonomous systems","tags":["Radar Netflows"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/netflows/top/locations":{"get":{"description":"Get the top locations by network traffic. Values are a percentage out of the total network traffic.","operationId":"radar_get_NetflowsTopLocations","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"top_0":{"items":{"properties":{"clientCountryAlpha2":{"example":"US","type":"string"},"clientCountryName":{"example":"United States","type":"string"},"value":{"example":"0.73996","type":"string"}},"required":["clientCountryName","clientCountryAlpha2","value"],"type":"object"},"type":"array"}},"required":["top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top locations","tags":["Radar Netflows"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/ranking/domain/{domain}":{"get":{"description":"Gets Domains Rank details.","operationId":"radar_get_RankingDetails","parameters":[{"in":"path","name":"domain","required":true,"schema":{"example":"google.com","format":"hostname","pattern":"^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$","type":"string"}},{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"Array of dates to filter the ranking.","in":"query","name":"date","schema":{"items":{"description":"Array of dates to filter the ranking.","example":"2022-09-19","format":"date","type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"details_0":{"properties":{"bucket":{"example":"2000","type":"string"},"categories":{"items":{"example":"Technology","type":"string"},"type":"array"},"rank":{"example":3,"type":"integer"},"top_locations":{"items":{"properties":{"locationCode":{"example":"US","type":"string"},"locationName":{"example":"United States","type":"string"},"rank":{"example":1,"type":"integer"}},"required":["rank","locationName","locationCode"],"type":"object"},"type":"array"}},"required":["bucket","categories","top_locations"],"type":"object"}},"required":["details_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Domains Rank details","tags":["Radar Ranking"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/ranking/timeseries":{"get":{"description":"Gets Domains Rank updates change over time. Raw values are returned.","operationId":"radar_get_RankingTimeseries","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"Array of locations (alpha-2 country codes).","in":"query","name":"location","schema":{"items":{"description":"Array of locations (alpha-2 country codes).","example":"US","type":"string"},"type":"array"}},{"description":"Array of comma separated list of domains names.","in":"query","name":"domains","schema":{"items":{"description":"Array of comma separated list of domains names.","example":"google.com,facebook.com","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"dateRange":{"properties":{"endTime":{"description":"Adjusted end of date range.","example":"2022-09-17T10:22:57.555Z","format":"date-time","type":"string"},"startTime":{"description":"Adjusted start of date range.","example":"2022-09-16T10:22:57.555Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["dateRange"],"type":"object"},"serie_0":{"properties":{"\u003cdomain name\u003e":{"items":{"example":2,"type":"integer"},"type":"array"},"timestamps":{"items":{"example":"2022-09-02","type":"string"},"type":"array"}},"required":["timestamps","\u003cdomain name\u003e"],"type":"object"}},"required":["meta","serie_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Domains Rank time series","tags":["Radar Ranking"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/ranking/top":{"get":{"description":"Gets Top Domains Rank globally or by country.","operationId":"radar_get_RankingTop","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"Array of locations (alpha-2 country codes).","in":"query","name":"location","schema":{"items":{"description":"Array of locations (alpha-2 country codes).","example":"US","type":"string"},"type":"array"}},{"description":"Array of dates to filter the ranking.","in":"query","name":"date","schema":{"items":{"description":"Array of dates to filter the ranking.","example":"2022-09-19","format":"date","type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"top_0":{"properties":{"date":{"example":"2022-09-19","type":"string"}},"required":["date"],"type":"object"}},"required":["top_0"],"type":"object"},"top_0":{"items":{"properties":{"categories":{"items":{"example":"Technology","type":"string"},"type":"array"},"domain":{"example":"google.com","type":"string"},"rank":{"example":1,"type":"integer"}},"required":["rank","domain","categories"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Domains Rank top","tags":["Radar Ranking"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/search/global":{"get":{"description":"Lets you search for locations, autonomous systems (AS) and reports.","operationId":"radar_get_SearchGlobal","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Limit the number of objects per search category.","in":"query","name":"limitPerGroup","schema":{"description":"Limit the number of objects per search category.","type":"number"}},{"description":"Search for locations, AS and reports.","in":"query","name":"query","required":true,"schema":{"description":"Search for locations, AS and reports.","example":"United","type":"string"}},{"description":"Search types to be included in results.","in":"query","name":"include","schema":{"items":{"enum":["SPECIAL_EVENTS","NOTEBOOKS","LOCATIONS","ASNS"],"type":"string"},"type":"array"}},{"description":"Search types to be excluded from results.","in":"query","name":"exclude","schema":{"items":{"enum":["SPECIAL_EVENTS","NOTEBOOKS","LOCATIONS","ASNS"],"type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"search":{"items":{"properties":{"code":{"example":"13335","type":"string"},"name":{"example":"Cloudflare","type":"string"},"type":{"example":"asn","type":"string"}},"required":["code","name","type"],"type":"object"},"type":"array"}},"required":["search"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Search for locations, autonomous systems (AS) and reports.","tags":["Radar Search"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/specialevents":{"get":{"description":"Get a list of Special Events.","operationId":"radar_get_SpecialEventsList","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Number of objects to skip before grabbing results.","in":"query","name":"offset","schema":{"default":0,"description":"Number of objects to skip before grabbing results.","example":0,"type":"integer"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"specialEvents":{"items":{"properties":{"alias":{"example":"euro2020","type":"string"},"categories":{"items":{"properties":{"categoryAlias":{"example":"streaming","type":"string"},"location":{"example":"GLOBAL","type":"string"}},"required":["categoryAlias","location"],"type":"object"},"type":"array"},"description":{"example":"The 2020 UEFA European Football Championship","type":"string"},"id":{"example":1,"type":"integer"},"title":{"example":"Euro2020","type":"string"}},"required":["id","title","alias","categories"],"type":"object"},"type":"array"}},"required":["specialEvents"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Special Events","tags":["Radar Special Events"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/specialevents/{eventAlias}":{"get":{"description":"Get a single Special Event.","operationId":"radar_get_SpecialEventsGet","parameters":[{"description":"Special Event alias","in":"path","name":"eventAlias","required":true,"schema":{"description":"Special Event alias","example":"eurovision-2022","type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"specialEvent":{"properties":{"alias":{"example":"euro2020","type":"string"},"categories":{"items":{"properties":{"categoryAlias":{"example":"streaming","type":"string"},"location":{"example":"GLOBAL","type":"string"}},"required":["categoryAlias","location"],"type":"object"},"type":"array"},"description":{"example":"The 2020 UEFA European Football Championship","type":"string"},"id":{"example":1,"type":"integer"},"title":{"example":"Euro2020","type":"string"}},"required":["id","title","alias","categories"],"type":"object"}},"required":["specialEvent"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a Single Special Events","tags":["Radar Special Events"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/specialevents/{eventAlias}/{categoryAlias}":{"get":{"operationId":"radar_get_TimeseriesSpecialEvents","parameters":[{"description":"Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).","in":"query","name":"aggInterval","schema":{"enum":["15m","1h","1d","1w"],"type":"string"}},{"description":"Name that will be used to name the series in response.","in":"query","name":"name","schema":{"description":"Name that will be used to name the series in response.","example":"main_series","type":"string"}},{"description":"Start of the date range (inclusive).","in":"query","name":"dateStart","schema":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},{"description":"End of the date range (inclusive).","in":"query","name":"dateEnd","schema":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},{"description":"Location Alpha2 code.","in":"query","name":"location","schema":{"description":"Location Alpha2 code.","example":"US","type":"string"}},{"description":"Special Event alias","in":"path","name":"eventAlias","required":true,"schema":{"description":"Special Event alias","example":"eurovision-2022","type":"string"}},{"description":"Special Event Category alias","in":"path","name":"categoryAlias","required":true,"schema":{"description":"Special Event Category alias","example":"videos","type":"string"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"serie_0":{"properties":{"timestamps":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"},"values":{"items":{"example":0.56,"type":"string"},"type":"array"}},"required":["timestamps","values"],"type":"object"}},"required":["serie_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Special Events time series","tags":["Radar Special Events"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/verified_bots/top/bots":{"get":{"description":"Get top verified bots by HTTP requests, with owner and category.","operationId":"radar_get_HttpTopVerifiedBots","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"botCategory":{"example":"Search Engine Crawler","type":"string"},"botName":{"example":"GoogleBot","type":"string"},"botOwner":{"example":"Google","type":"string"},"value":{"example":"29.034407","type":"string"}},"required":["botName","botCategory","botOwner","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top verified bots by HTTP requests","tags":["Radar Verified Bots"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/radar/verified_bots/top/categories":{"get":{"description":"Get top verified bot categories by HTTP requests, along with their corresponding percentage, over the total verified bot HTTP requests.","operationId":"radar_get_HttpTopVerifiedBotCategories","parameters":[{"description":"Limit the number of objects in the response.","in":"query","name":"limit","schema":{"default":5,"description":"Limit the number of objects in the response.","example":5,"type":"integer"}},{"description":"Array of names that will be used to name the series in responses.","in":"query","name":"name","schema":{"items":{"description":"Array of names that will be used to name the series in responses.","example":"main_series","type":"string"},"type":"array"}},{"description":"For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).","in":"query","name":"dateRange","schema":{"items":{"enum":["1d","7d","14d","28d","12w","24w","52w","1dControl","7dControl","14dControl","28dControl","12wControl","24wControl"],"type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the start of a series.","in":"query","name":"dateStart","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of datetimes to filter the end of a series.","in":"query","name":"dateEnd","schema":{"items":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"type":"array"}},{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","in":"query","name":"asn","schema":{"items":{"description":"Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.","example":"15169","type":"string"},"type":"array"}},{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","in":"query","name":"location","schema":{"items":{"description":"Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.","example":"US,CA","type":"string"},"type":"array"}},{"description":"Format results are returned in.","in":"query","name":"format","schema":{"enum":["JSON","CSV"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"meta":{"properties":{"confidenceInfo":{"properties":{"annotations":{"items":{"properties":{"dataSource":{"type":"string"},"description":{"type":"string"},"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"eventType":{"type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["dataSource","eventType","description","startTime","endTime"],"type":"object"},"type":"array"},"level":{"type":"integer"}},"required":["level","annotations"],"type":"object"},"dateRange":{"properties":{"endTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"},"startTime":{"example":"2022-09-15T00:00:00Z","format":"date-time","type":"string"}},"required":["startTime","endTime"],"type":"object"}},"required":["confidenceInfo","dateRange"],"type":"object"},"top_0":{"items":{"properties":{"botCategory":{"example":"Search","type":"string"},"value":{"example":"65","type":"string"}},"required":["botCategory","value"],"type":"object"},"type":"array"}},"required":["meta","top_0"],"type":"object"},"success":{"example":true,"type":"boolean"}},"required":["result","success"],"type":"object"}}},"description":"Successful Response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get top verified bot categories by HTTP requests","tags":["Radar Verified Bots"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/railguns":{"get":{"description":"List, search, sort and filter your Railguns.","operationId":"railgun-list-railguns","parameters":[{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Number of items per page.","maximum":50,"minimum":5,"type":"number"}},{"in":"query","name":"direction","schema":{"description":"Sort Railguns in ascending or descending order.","enum":["asc","desc"],"example":"desc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/railgun_response_collection"}}},"description":"List Railguns response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/railgun_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Railguns response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Railguns","tags":["Railgun"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"post":{"operationId":"railgun-create-railgun","requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"$ref":"#/components/schemas/railgun_components-schemas-name"}},"required":["name"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/railgun_response_single"}}},"description":"Create Railgun response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/railgun_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Railgun response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Railgun","tags":["Railgun"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/railguns/{identifier}":{"delete":{"description":"Disable and delete a Railgun. This will immediately disable that Railgun for any connected zones.","operationId":"railgun-delete-a-railgun","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/railgun_response_single_id"}}},"description":"Delete a Railgun response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/railgun_response_single_id"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete a Railgun response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete a Railgun","tags":["Railgun"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"get":{"operationId":"railgun-railgun-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/railgun_response_single"}}},"description":"Railgun details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/railgun_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Railgun details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Railgun details","tags":["Railgun"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"patch":{"description":"Enable or disable a Railgun for all zones connected to it.","operationId":"railgun-enable-or-disable-a-railgun","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"enabled":{"$ref":"#/components/schemas/railgun_components-schemas-enabled"}},"required":["enabled"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/railgun_response_single"}}},"description":"Enable or disable a Railgun response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/railgun_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Enable or disable a Railgun response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Enable or disable a Railgun","tags":["Railgun"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/railguns/{identifier}/zones":{"get":{"description":"List the zones that are currently using this Railgun.","operationId":"railgun-list-railgun-zones","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/components-schemas-zone"},"type":"array"}}}]}}},"description":"List Railgun zones response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/components-schemas-zone"},"type":"array"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Railgun zones response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Railgun zones","tags":["Railgun"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/user":{"get":{"operationId":"user-user-details","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_user_response"}}},"description":"User Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_user_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"User Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"User Details","tags":["User"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Edit part of your user details.","operationId":"user-edit-user","requestBody":{"content":{"application/json":{"schema":{"properties":{"country":{"$ref":"#/components/schemas/country-DyJUDEcJ"},"first_name":{"$ref":"#/components/schemas/first_name"},"last_name":{"$ref":"#/components/schemas/last_name"},"telephone":{"$ref":"#/components/schemas/telephone"},"zipcode":{"$ref":"#/components/schemas/zipcode"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_user_response"}}},"description":"Edit User response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_user_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Edit User response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Edit User","tags":["User"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.user.update"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/user/audit_logs":{"get":{"description":"Gets a list of audit logs for a user account. The list can be filtered by who made the change, which zone was the change made on, and the timeframe of the change.","operationId":"audit-logs-get-user-audit-logs","parameters":[{"in":"query","name":"id","schema":{"description":"Finds a specific log by its ID.","example":"f174be97-19b1-40d6-954d-70cd5fbd52db","type":"string"}},{"in":"query","name":"export","schema":{"description":"Indicates that this request is an export of logs in CSV format.","example":true,"type":"boolean"}},{"in":"query","name":"action.type","schema":{"description":"Filters by the action type.","example":"add","type":"string"}},{"in":"query","name":"actor.ip","schema":{"description":"Filters by the IP address of the request that made the change by specific IP address or valid CIDR Range.","example":"17.168.228.63","type":"string"}},{"in":"query","name":"actor.email","schema":{"description":"Filters by the email address of the actor that made the change.","example":"alice@example.com","format":"email","type":"string"}},{"in":"query","name":"since","schema":{"description":"Limits the returned results to logs newer than the specified date. This can be a date string `2019-04-30` or an absolute timestamp that conforms to RFC3339.","example":"2019-04-30T01:12:20Z","format":"date-time","type":"string"}},{"in":"query","name":"before","schema":{"description":"Limits the returned results to logs older than the specified date. This can be a date string `2019-04-30` or an absolute timestamp that conforms to RFC3339.","example":"2019-04-30T01:12:20Z","format":"date-time","type":"string"}},{"in":"query","name":"zone.name","schema":{"description":"Filters by the name of the zone associated to the change.","example":"example.com","type":"string"}},{"in":"query","name":"direction","schema":{"default":"desc","description":"Changes the direction of the chronological sorting.","enum":["desc","asc"],"example":"desc","type":"string"}},{"in":"query","name":"per_page","schema":{"default":100,"description":"Sets the number of results to return per page.","example":25,"maximum":1000,"minimum":1,"type":"number"}},{"in":"query","name":"page","schema":{"default":1,"description":"Defines which page of results to return.","example":50,"minimum":1,"type":"number"}},{"in":"query","name":"hide_user_logs","schema":{"default":false,"description":"Indicates whether or not to hide user level audit logs.","type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/audit_logs_response_collection"}}},"description":"Get user audit logs response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/audit_logs_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get user audit logs response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get user audit logs","tags":["Audit Logs"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/user/billing/history":{"get":{"description":"Accesses your billing history object.","operationId":"user-billing-history-billing-history-details","parameters":[{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Number of items per page.","maximum":50,"minimum":5,"type":"number"}},{"in":"query","name":"order","schema":{"description":"Field to order billing history by.","enum":["type","occured_at","action"],"example":"occured_at","type":"string"}},{"in":"query","name":"occured_at","schema":{"$ref":"#/components/schemas/occurred_at"}},{"in":"query","name":"occurred_at","schema":{"$ref":"#/components/schemas/occurred_at"}},{"in":"query","name":"type","schema":{"description":"The billing item type.","example":"charge","maxLength":30,"readOnly":true,"type":"string"}},{"in":"query","name":"action","schema":{"description":"The billing item action.","example":"subscription","maxLength":30,"readOnly":true,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing_history_collection"}}},"description":"Billing History Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/billing_history_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Billing History Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Billing History Details","tags":["User Billing History"],"x-cfPermissionsRequired":{"enum":["#billing:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/user/billing/profile":{"get":{"description":"Accesses your billing profile object.","operationId":"user-billing-profile-billing-profile-details","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/billing_response_single"}}},"description":"Billing Profile Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/billing_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Billing Profile Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Billing Profile Details","tags":["User Billing Profile"],"x-cfPermissionsRequired":{"enum":["#billing:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/user/firewall/access_rules/rules":{"get":{"description":"Fetches IP Access rules of the user. You can filter the results using several optional parameters.","operationId":"ip-access-rules-for-a-user-list-ip-access-rules","parameters":[{"in":"query","name":"filters","schema":{"$ref":"#/components/schemas/schemas-filters"}},{"in":"query","name":"egs-pagination.json","schema":{"$ref":"#/components/schemas/egs-pagination"}},{"in":"query","name":"page","schema":{"description":"Requested page within paginated list of results.","example":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"description":"Maximum number of results requested.","example":20,"type":"number"}},{"in":"query","name":"order","schema":{"description":"The field used to sort returned rules.","enum":["configuration.target","configuration.value","mode"],"example":"mode","type":"string"}},{"in":"query","name":"direction","schema":{"description":"The direction used to sort returned rules.","enum":["asc","desc"],"example":"desc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_collection_response"}}},"description":"List IP Access rules response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rule_collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List IP Access rules response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List IP Access rules","tags":["IP Access rules for a user"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Creates a new IP Access rule for all zones owned by the current user.\n\nNote: To create an IP Access rule that applies to a specific zone, refer to the [IP Access rules for a zone](#ip-access-rules-for-a-zone) endpoints.","operationId":"ip-access-rules-for-a-user-create-an-ip-access-rule","requestBody":{"content":{"application/json":{"schema":{"properties":{"configuration":{"$ref":"#/components/schemas/schemas-configuration"},"mode":{"$ref":"#/components/schemas/schemas-mode"},"notes":{"$ref":"#/components/schemas/notes"}},"required":["mode","configuration"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_single_response"}}},"description":"Create an IP Access rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rule_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create an IP Access rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create an IP Access rule","tags":["IP Access rules for a user"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/user/firewall/access_rules/rules/{identifier}":{"delete":{"description":"Deletes an IP Access rule at the user level.\n\nNote: Deleting a user-level rule will affect all zones owned by the user.","operationId":"ip-access-rules-for-a-user-delete-an-ip-access-rule","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/rule_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_single_id_response"}}},"description":"Delete an IP Access rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rule_single_id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete an IP Access rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete an IP Access rule","tags":["IP Access rules for a user"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Updates an IP Access rule defined at the user level. You can only update the rule action (`mode` parameter) and notes.","operationId":"ip-access-rules-for-a-user-update-an-ip-access-rule","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/rule_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"mode":{"$ref":"#/components/schemas/schemas-mode"},"notes":{"$ref":"#/components/schemas/notes"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_single_response"}}},"description":"Update an IP Access rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rule_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update an IP Access rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update an IP Access rule","tags":["IP Access rules for a user"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/user/invites":{"get":{"description":"Lists all invitations associated with my user.","operationId":"user'-s-invites-list-invitations","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-collection_invite_response"}}},"description":"List Invitations response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-collection_invite_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Invitations response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Invitations","tags":["User's Invites"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/user/invites/{identifier}":{"get":{"description":"Gets the details of an invitation.","operationId":"user'-s-invites-invitation-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/invite_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_invite_response"}}},"description":"Invitation Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_invite_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Invitation Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Invitation Details","tags":["User's Invites"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"patch":{"description":"Responds to an invitation.","operationId":"user'-s-invites-respond-to-invitation","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/invite_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"status":{"description":"Status of your response to the invitation (rejected or accepted).","enum":["accepted","rejected"],"example":"accepted"}},"required":["status"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_invite_response"}}},"description":"Respond to Invitation response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_invite_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Respond to Invitation response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Respond to Invitation","tags":["User's Invites"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/user/load_balancers/monitors":{"get":{"description":"List configured monitors for a user.","operationId":"load-balancer-monitors-list-monitors","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_collection-IG638TJE"}}},"description":"List Monitors response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_collection-IG638TJE"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Monitors response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Monitors","tags":["Load Balancer Monitors"]},"post":{"description":"Create a configured monitor.","operationId":"load-balancer-monitors-create-monitor","requestBody":{"content":{"application/json":{"schema":{"properties":{"allow_insecure":{"$ref":"#/components/schemas/allow_insecure"},"description":{"$ref":"#/components/schemas/description-Jd6AMFjR"},"expected_body":{"$ref":"#/components/schemas/expected_body"},"expected_codes":{"$ref":"#/components/schemas/expected_codes"},"follow_redirects":{"$ref":"#/components/schemas/follow_redirects"},"header":{"$ref":"#/components/schemas/header"},"interval":{"$ref":"#/components/schemas/interval-hA6swy38"},"method":{"$ref":"#/components/schemas/method-guvmKTdR"},"path":{"$ref":"#/components/schemas/path-I0p9X4oI"},"port":{"$ref":"#/components/schemas/port-WXwz9tIV"},"probe_zone":{"$ref":"#/components/schemas/probe_zone"},"retries":{"$ref":"#/components/schemas/retries"},"timeout":{"$ref":"#/components/schemas/timeout"},"type":{"$ref":"#/components/schemas/type-gTI6cLgq"}},"required":["expected_codes"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response-xymoBSIP"}}},"description":"Create Monitor response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response-xymoBSIP"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Monitor response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Monitor","tags":["Load Balancer Monitors"]}},"/user/load_balancers/monitors/{identifier}":{"delete":{"description":"Delete a configured monitor.","operationId":"load-balancer-monitors-delete-monitor","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-FZThz4k7"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/id_response-99rIWUZu"}}},"description":"Delete Monitor response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/id_response-99rIWUZu"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Monitor response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Monitor","tags":["Load Balancer Monitors"]},"get":{"description":"List a single configured monitor for a user.","operationId":"load-balancer-monitors-monitor-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-FZThz4k7"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response-xymoBSIP"}}},"description":"Monitor Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response-xymoBSIP"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Monitor Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Monitor Details","tags":["Load Balancer Monitors"]},"patch":{"description":"Apply changes to an existing monitor, overwriting the supplied properties.","operationId":"load-balancer-monitors-patch-monitor","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-FZThz4k7"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"allow_insecure":{"$ref":"#/components/schemas/allow_insecure"},"description":{"$ref":"#/components/schemas/description-Jd6AMFjR"},"expected_body":{"$ref":"#/components/schemas/expected_body"},"expected_codes":{"$ref":"#/components/schemas/expected_codes"},"follow_redirects":{"$ref":"#/components/schemas/follow_redirects"},"header":{"$ref":"#/components/schemas/header"},"interval":{"$ref":"#/components/schemas/interval-hA6swy38"},"method":{"$ref":"#/components/schemas/method-guvmKTdR"},"path":{"$ref":"#/components/schemas/path-I0p9X4oI"},"port":{"$ref":"#/components/schemas/port-WXwz9tIV"},"probe_zone":{"$ref":"#/components/schemas/probe_zone"},"retries":{"$ref":"#/components/schemas/retries"},"timeout":{"$ref":"#/components/schemas/timeout"},"type":{"$ref":"#/components/schemas/type-gTI6cLgq"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response-xymoBSIP"}}},"description":"Patch Monitor response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response-xymoBSIP"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Patch Monitor response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Patch Monitor","tags":["Load Balancer Monitors"]},"put":{"description":"Modify a configured monitor.","operationId":"load-balancer-monitors-update-monitor","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-FZThz4k7"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"allow_insecure":{"$ref":"#/components/schemas/allow_insecure"},"description":{"$ref":"#/components/schemas/description-Jd6AMFjR"},"expected_body":{"$ref":"#/components/schemas/expected_body"},"expected_codes":{"$ref":"#/components/schemas/expected_codes"},"follow_redirects":{"$ref":"#/components/schemas/follow_redirects"},"header":{"$ref":"#/components/schemas/header"},"interval":{"$ref":"#/components/schemas/interval-hA6swy38"},"method":{"$ref":"#/components/schemas/method-guvmKTdR"},"path":{"$ref":"#/components/schemas/path-I0p9X4oI"},"port":{"$ref":"#/components/schemas/port-WXwz9tIV"},"probe_zone":{"$ref":"#/components/schemas/probe_zone"},"retries":{"$ref":"#/components/schemas/retries"},"timeout":{"$ref":"#/components/schemas/timeout"},"type":{"$ref":"#/components/schemas/type-gTI6cLgq"}},"required":["expected_codes"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response-xymoBSIP"}}},"description":"Update Monitor response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response-xymoBSIP"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Monitor response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Monitor","tags":["Load Balancer Monitors"]}},"/user/load_balancers/monitors/{identifier}/preview":{"post":{"description":"Preview pools using the specified monitor with provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results.","operationId":"load-balancer-monitors-preview-monitor","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-FZThz4k7"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"allow_insecure":{"$ref":"#/components/schemas/allow_insecure"},"expected_body":{"$ref":"#/components/schemas/expected_body"},"expected_codes":{"$ref":"#/components/schemas/expected_codes"},"follow_redirects":{"$ref":"#/components/schemas/follow_redirects"},"header":{"$ref":"#/components/schemas/header"},"method":{"$ref":"#/components/schemas/method-guvmKTdR"},"path":{"$ref":"#/components/schemas/path-I0p9X4oI"},"port":{"$ref":"#/components/schemas/port-WXwz9tIV"},"retries":{"$ref":"#/components/schemas/retries"},"timeout":{"$ref":"#/components/schemas/timeout"},"type":{"$ref":"#/components/schemas/type-gTI6cLgq"}},"required":["expected_codes"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/preview_response-ZWQ9Fl0k"}}},"description":"Preview Monitor response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/preview_response-ZWQ9Fl0k"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Preview Monitor response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Preview Monitor","tags":["Load Balancer Monitors"]}},"/user/load_balancers/monitors/{identifier}/references":{"get":{"description":"Get the list of resources that reference the provided monitor.","operationId":"load-balancer-monitors-list-monitor-references","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-FZThz4k7"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/references_response"}}},"description":"List Monitor References response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/references_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Monitor References response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Monitor References","tags":["Load Balancer Monitors"]}},"/user/load_balancers/pools":{"get":{"description":"List configured pools.","operationId":"load-balancer-pools-list-pools","parameters":[{"in":"query","name":"monitor","schema":{"description":"The ID of the Monitor to use for checking the health of origins within this pool."}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-response_collection-PNoWMjSR"}}},"description":"List Pools response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-response_collection-PNoWMjSR"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Pools response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Pools","tags":["Load Balancer Pools"]},"patch":{"description":"Apply changes to a number of existing pools, overwriting the supplied properties. Pools are ordered by ascending `name`. Returns the list of affected pools. Supports the standard pagination query parameters, either `limit`/`offset` or `per_page`/`page`.","operationId":"load-balancer-pools-patch-pools","requestBody":{"content":{"application/json":{"schema":{"properties":{"notification_email":{"$ref":"#/components/schemas/patch_pools_notification_email"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-response_collection-PNoWMjSR"}}},"description":"Patch Pools response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-response_collection-PNoWMjSR"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Patch Pools response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Patch Pools","tags":["Load Balancer Pools"]},"post":{"description":"Create a new pool.","operationId":"load-balancer-pools-create-pool","requestBody":{"content":{"application/json":{"schema":{"properties":{"check_regions":{"$ref":"#/components/schemas/check_regions-q46IR1gk"},"description":{"$ref":"#/components/schemas/schemas-description-XvtZaN2T"},"enabled":{"$ref":"#/components/schemas/enabled-WoQtkwsn"},"latitude":{"$ref":"#/components/schemas/latitude"},"load_shedding":{"$ref":"#/components/schemas/load_shedding"},"longitude":{"$ref":"#/components/schemas/longitude"},"minimum_origins":{"$ref":"#/components/schemas/minimum_origins"},"monitor":{"$ref":"#/components/schemas/schemas-monitor"},"name":{"$ref":"#/components/schemas/name-Pky1OOiR"},"notification_email":{"$ref":"#/components/schemas/notification_email"},"notification_filter":{"$ref":"#/components/schemas/notification_filter"},"origin_steering":{"$ref":"#/components/schemas/origin_steering"},"origins":{"$ref":"#/components/schemas/origins-BzaDTSuG"}},"required":["origins","name"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-single_response-uzr0CVkk"}}},"description":"Create Pool response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-single_response-uzr0CVkk"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Pool response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Pool","tags":["Load Balancer Pools"]}},"/user/load_balancers/pools/{identifier}":{"delete":{"description":"Delete a configured pool.","operationId":"load-balancer-pools-delete-pool","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier-LDS3pdXe"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-id_response-n8mMAIdf"}}},"description":"Delete Pool response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-id_response-n8mMAIdf"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Pool response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Pool","tags":["Load Balancer Pools"]},"get":{"description":"Fetch a single configured pool.","operationId":"load-balancer-pools-pool-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier-LDS3pdXe"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-single_response-uzr0CVkk"}}},"description":"Pool Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-single_response-uzr0CVkk"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Pool Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Pool Details","tags":["Load Balancer Pools"]},"patch":{"description":"Apply changes to an existing pool, overwriting the supplied properties.","operationId":"load-balancer-pools-patch-pool","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier-LDS3pdXe"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"check_regions":{"$ref":"#/components/schemas/check_regions-q46IR1gk"},"description":{"$ref":"#/components/schemas/schemas-description-XvtZaN2T"},"disabled_at":{"$ref":"#/components/schemas/schemas-disabled_at"},"enabled":{"$ref":"#/components/schemas/enabled-WoQtkwsn"},"latitude":{"$ref":"#/components/schemas/latitude"},"load_shedding":{"$ref":"#/components/schemas/load_shedding"},"longitude":{"$ref":"#/components/schemas/longitude"},"minimum_origins":{"$ref":"#/components/schemas/minimum_origins"},"monitor":{"$ref":"#/components/schemas/schemas-monitor"},"name":{"$ref":"#/components/schemas/name-Pky1OOiR"},"notification_email":{"$ref":"#/components/schemas/notification_email"},"notification_filter":{"$ref":"#/components/schemas/notification_filter"},"origin_steering":{"$ref":"#/components/schemas/origin_steering"},"origins":{"$ref":"#/components/schemas/origins-BzaDTSuG"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-single_response-uzr0CVkk"}}},"description":"Patch Pool response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-single_response-uzr0CVkk"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Patch Pool response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Patch Pool","tags":["Load Balancer Pools"]},"put":{"description":"Modify a configured pool.","operationId":"load-balancer-pools-update-pool","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier-LDS3pdXe"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"check_regions":{"$ref":"#/components/schemas/check_regions-q46IR1gk"},"description":{"$ref":"#/components/schemas/schemas-description-XvtZaN2T"},"disabled_at":{"$ref":"#/components/schemas/schemas-disabled_at"},"enabled":{"$ref":"#/components/schemas/enabled-WoQtkwsn"},"latitude":{"$ref":"#/components/schemas/latitude"},"load_shedding":{"$ref":"#/components/schemas/load_shedding"},"longitude":{"$ref":"#/components/schemas/longitude"},"minimum_origins":{"$ref":"#/components/schemas/minimum_origins"},"monitor":{"$ref":"#/components/schemas/schemas-monitor"},"name":{"$ref":"#/components/schemas/name-Pky1OOiR"},"notification_email":{"$ref":"#/components/schemas/notification_email"},"notification_filter":{"$ref":"#/components/schemas/notification_filter"},"origin_steering":{"$ref":"#/components/schemas/origin_steering"},"origins":{"$ref":"#/components/schemas/origins-BzaDTSuG"}},"required":["origins","name"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-single_response-uzr0CVkk"}}},"description":"Update Pool response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-single_response-uzr0CVkk"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Pool response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Pool","tags":["Load Balancer Pools"]}},"/user/load_balancers/pools/{identifier}/health":{"get":{"description":"Fetch the latest pool health status for a single pool.","operationId":"load-balancer-pools-pool-health-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier-LDS3pdXe"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/health_details"}}},"description":"Pool Health Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/health_details"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Pool Health Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Pool Health Details","tags":["Load Balancer Pools"]}},"/user/load_balancers/pools/{identifier}/preview":{"post":{"description":"Preview pool health using provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results.","operationId":"load-balancer-pools-preview-pool","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier-LDS3pdXe"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"allow_insecure":{"$ref":"#/components/schemas/allow_insecure"},"expected_body":{"$ref":"#/components/schemas/expected_body"},"expected_codes":{"$ref":"#/components/schemas/expected_codes"},"follow_redirects":{"$ref":"#/components/schemas/follow_redirects"},"header":{"$ref":"#/components/schemas/header"},"method":{"$ref":"#/components/schemas/method-guvmKTdR"},"path":{"$ref":"#/components/schemas/path-I0p9X4oI"},"port":{"$ref":"#/components/schemas/port-WXwz9tIV"},"retries":{"$ref":"#/components/schemas/retries"},"timeout":{"$ref":"#/components/schemas/timeout"},"type":{"$ref":"#/components/schemas/type-gTI6cLgq"}},"required":["expected_codes"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/preview_response-ZWQ9Fl0k"}}},"description":"Preview Pool response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/preview_response-ZWQ9Fl0k"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Preview Pool response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Preview Pool","tags":["Load Balancer Pools"]}},"/user/load_balancers/pools/{identifier}/references":{"get":{"description":"Get the list of resources that reference the provided pool.","operationId":"load-balancer-pools-list-pool-references","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier-LDS3pdXe"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-references_response"}}},"description":"List Pool References response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-references_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Pool References response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Pool References","tags":["Load Balancer Pools"]}},"/user/load_balancers/preview/{preview_id}":{"get":{"description":"Get the result of a previous preview operation using the provided preview_id.","operationId":"load-balancer-monitors-preview-result","parameters":[{"in":"path","name":"preview_id","required":true,"schema":{"$ref":"#/components/schemas/preview_id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/preview_result_response-181bkyJU"}}},"description":"Preview Result response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/preview_result_response-181bkyJU"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Preview Result response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Preview Result","tags":["Load Balancer Monitors"]}},"/user/load_balancing_analytics/events":{"get":{"description":"List origin health changes.","operationId":"load-balancer-healthcheck-events-list-healthcheck-events","parameters":[{"in":"query","name":"until","schema":{"$ref":"#/components/schemas/until-XGNiH7hs"}},{"in":"query","name":"pool_name","schema":{"$ref":"#/components/schemas/pool_name"}},{"in":"query","name":"origin_healthy","schema":{"$ref":"#/components/schemas/origin_healthy"}},{"in":"query","name":"identifier","schema":{"$ref":"#/components/schemas/schemas-identifier-LDS3pdXe"}},{"in":"query","name":"since","schema":{"description":"Start date and time of requesting data period in the ISO8601 format.","example":"2016-11-11T12:00:00Z","format":"date-time","type":"string"}},{"in":"query","name":"origin_name","schema":{"description":"The name for the origin to filter.","example":"primary-dc-1","type":"string"}},{"in":"query","name":"pool_healthy","schema":{"default":true,"description":"If true, filter events where the pool status is healthy. If false, filter events where the pool status is unhealthy.","example":true,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-response_collection-Qwy7OnW5"}}},"description":"List Healthcheck Events response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-response_collection-Qwy7OnW5"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Healthcheck Events response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Healthcheck Events","tags":["Load Balancer Healthcheck Events"]}},"/user/organizations":{"get":{"description":"Lists organizations the user is associated with.","operationId":"user'-s-organizations-list-organizations","parameters":[{"in":"query","name":"name","schema":{"$ref":"#/components/schemas/schemas-name-Usb6SCq8"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Number of organizations per page.","maximum":50,"minimum":5,"type":"number"}},{"in":"query","name":"order","schema":{"description":"Field to order organizations by.","enum":["id","name","status"],"example":"status","type":"string"}},{"in":"query","name":"direction","schema":{"description":"Direction to order organizations.","enum":["asc","desc"],"example":"desc","type":"string"}},{"in":"query","name":"match","schema":{"default":"all","description":"Whether to match all search requirements or at least one (any).","enum":["any","all"],"type":"string"}},{"in":"query","name":"status","schema":{"description":"Whether the user is a member of the organization or has an inivitation pending.","enum":["member","invited"],"example":"member","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/collection_organization_response"}}},"description":"List Organizations response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/collection_organization_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Organizations response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Organizations","tags":["User's Organizations"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/user/organizations/{identifier}":{"delete":{"description":"Removes association to an organization.","operationId":"user'-s-organizations-leave-organization","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},"type":"object"}}},"description":"Leave Organization response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"properties":{"id":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},"type":"object"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Leave Organization response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Leave Organization","tags":["User's Organizations"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Gets a specific organization the user is associated with.","operationId":"user'-s-organizations-organization-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_organization_response"}}},"description":"Organization Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_organization_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Organization Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Organization Details","tags":["User's Organizations"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/user/subscriptions":{"get":{"description":"Lists all of a user's subscriptions.","operationId":"user-subscription-get-user-subscriptions","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/user_subscription_response_collection"}}},"description":"Get User Subscriptions response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/user_subscription_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get User Subscriptions response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get User Subscriptions","tags":["User Subscription"],"x-cfPermissionsRequired":{"enum":["#billing:read"]}}},"/user/subscriptions/{identifier}":{"delete":{"description":"Deletes a user's subscription.","operationId":"user-subscription-delete-user-subscription","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/subscription-v2_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"subscription_id":{"$ref":"#/components/schemas/subscription-v2_components-schemas-identifier"}},"type":"object"}}},"description":"Delete User Subscription response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"properties":{"subscription_id":{"$ref":"#/components/schemas/subscription-v2_components-schemas-identifier"}},"type":"object"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete User Subscription response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete User Subscription","tags":["User Subscription"],"x-cfPermissionsRequired":{"enum":["#billing:edit"]}},"put":{"description":"Updates a user's subscriptions.","operationId":"user-subscription-update-user-subscription","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/subscription-v2_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscription-v2"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/user_subscription_response_single"}}},"description":"Update User Subscription response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/user_subscription_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update User Subscription response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update User Subscription","tags":["User Subscription"],"x-cfPermissionsRequired":{"enum":["#billing:read","#billing:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/user/tokens":{"get":{"description":"List all access tokens you created.","operationId":"user-api-tokens-list-tokens","parameters":[{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Maximum number of results per page.","maximum":50,"minimum":5,"type":"number"}},{"in":"query","name":"direction","schema":{"description":"Direction to order results.","enum":["asc","desc"],"example":"desc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_collection-NcnbjEgN"}}},"description":"List Tokens response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_collection-NcnbjEgN"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Tokens response failure"}},"security":[{"api_token":[]}],"summary":"List Tokens","tags":["User API Tokens"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.token.list"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Create a new access token.","operationId":"user-api-tokens-create-token","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_payload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_create"}}},"description":"Create Token response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_create"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Token response failure"}},"security":[{"api_token":[]}],"summary":"Create Token","tags":["User API Tokens"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.token.create"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/user/tokens/permission_groups":{"get":{"description":"Find all available permission groups.","operationId":"permission-groups-list-permission-groups","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-response_collection-gsiDzBvh"}}},"description":"List Permission Groups response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-response_collection-gsiDzBvh"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Permission Groups response failure"}},"security":[{"api_token":[]}],"summary":"List Permission Groups","tags":["Permission Groups"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.token.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/user/tokens/verify":{"get":{"description":"Test whether a token works.","operationId":"user-api-tokens-verify-token","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_single_segment"}}},"description":"Verify Token response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_single_segment"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Verify Token response failure"}},"security":[{"api_token":[]}],"summary":"Verify Token","tags":["User API Tokens"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/user/tokens/{identifier}":{"delete":{"description":"Destroy a token.","operationId":"user-api-tokens-delete-token","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier-3n9sRq0H"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single-id-u7jsvBJu"}}},"description":"Delete Token response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single-id-u7jsvBJu"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Token response failure"}},"security":[{"api_token":[]}],"summary":"Delete Token","tags":["User API Tokens"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.token.delete"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Get information about a specific token.","operationId":"user-api-tokens-token-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier-3n9sRq0H"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_single"}}},"description":"Token Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Token Details response failure"}},"security":[{"api_token":[]}],"summary":"Token Details","tags":["User API Tokens"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.token.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Update an existing token.","operationId":"user-api-tokens-update-token","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier-3n9sRq0H"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-token"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_single"}}},"description":"Update Token response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Token response failure"}},"security":[{"api_token":[]}],"summary":"Update Token","tags":["User API Tokens"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.token.update"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/user/tokens/{identifier}/value":{"put":{"description":"Roll the token secret.","operationId":"user-api-tokens-roll-token","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier-3n9sRq0H"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_single_value"}}},"description":"Roll Token response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_single_value"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Roll Token response failure"}},"security":[{"api_token":[]}],"summary":"Roll Token","tags":["User API Tokens"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.token.update"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones":{"get":{"description":"Lists, searches, sorts, and filters your zones.","operationId":"zones-get","parameters":[{"in":"query","name":"name","schema":{"description":"A domain name.","example":"example.com","format":"hostname","maxLength":253,"type":"string"}},{"in":"query","name":"status","schema":{"type":"string"}},{"in":"query","name":"account.id","schema":{"type":"string"}},{"in":"query","name":"account.name","schema":{"type":"string"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Number of zones per page.","maximum":50,"minimum":5,"type":"number"}},{"in":"query","name":"order","schema":{"description":"Field to order zones by.","enum":["name","status","account.id","account.name"],"example":"status","type":"string"}},{"in":"query","name":"direction","schema":{"description":"Direction to order zones.","enum":["asc","desc"],"example":"desc","type":"string"}},{"in":"query","name":"match","schema":{"default":"all","description":"Whether to match all search requirements or at least one (any).","enum":["any","all"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-common-jkxlh21Y"},{"properties":{"result_info":{"$ref":"#/components/schemas/result_info"}}},{"properties":{"result":{"items":{"$ref":"#/components/schemas/zone"},"type":"array"}}}]}}},"description":"List Zones response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"List Zones response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Zones","tags":["Zone"]},"post":{"operationId":"zones-post","requestBody":{"content":{"application/json":{"schema":{"properties":{"account":{"properties":{"id":{"$ref":"#/components/schemas/identifier-MZFDye9j"}},"type":"object"},"name":{"$ref":"#/components/schemas/name-LiICrXvM"},"type":{"$ref":"#/components/schemas/type-kxPaBgXc"}},"required":["name","account"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-common-jkxlh21Y"},{"properties":{"result":{"$ref":"#/components/schemas/zone"}},"type":"object"}]}}},"description":"Create Zone response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Create Zone response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Zone","tags":["Zone"]}},"/zones/{identifier1}/load_balancers/{identifier}":{"delete":{"description":"Delete a configured load balancer.","operationId":"load-balancers-delete-load-balancer","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/load-balancer_components-schemas-identifier"}},{"in":"path","name":"identifier1","required":true,"schema":{"$ref":"#/components/schemas/load-balancer_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-id_response-Ujz7iPfP"}}},"description":"Delete Load Balancer response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-id_response-Ujz7iPfP"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Load Balancer response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Load Balancer","tags":["Load Balancers"]},"get":{"description":"Fetch a single configured load balancer.","operationId":"load-balancers-load-balancer-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/load-balancer_components-schemas-identifier"}},{"in":"path","name":"identifier1","required":true,"schema":{"$ref":"#/components/schemas/load-balancer_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancer_components-schemas-single_response"}}},"description":"Load Balancer Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancer_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Load Balancer Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Load Balancer Details","tags":["Load Balancers"]},"patch":{"description":"Apply changes to an existing load balancer, overwriting the supplied properties.","operationId":"load-balancers-patch-load-balancer","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/load-balancer_components-schemas-identifier"}},{"in":"path","name":"identifier1","required":true,"schema":{"$ref":"#/components/schemas/load-balancer_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"adaptive_routing":{"$ref":"#/components/schemas/adaptive_routing"},"country_pools":{"$ref":"#/components/schemas/country_pools"},"default_pools":{"$ref":"#/components/schemas/default_pools"},"description":{"$ref":"#/components/schemas/components-schemas-description-UH5FN4sh"},"enabled":{"$ref":"#/components/schemas/components-schemas-enabled-tktxdyPy"},"fallback_pool":{"$ref":"#/components/schemas/fallback_pool"},"location_strategy":{"$ref":"#/components/schemas/location_strategy"},"name":{"$ref":"#/components/schemas/components-schemas-name-h5gI0ndx"},"pop_pools":{"$ref":"#/components/schemas/pop_pools"},"proxied":{"$ref":"#/components/schemas/proxied-ZGed5Tdg"},"random_steering":{"$ref":"#/components/schemas/random_steering"},"region_pools":{"$ref":"#/components/schemas/region_pools"},"rules":{"$ref":"#/components/schemas/rules-8L4eu614"},"session_affinity":{"$ref":"#/components/schemas/session_affinity"},"session_affinity_attributes":{"$ref":"#/components/schemas/session_affinity_attributes"},"session_affinity_ttl":{"$ref":"#/components/schemas/session_affinity_ttl"},"steering_policy":{"$ref":"#/components/schemas/steering_policy"},"ttl":{"$ref":"#/components/schemas/ttl-0jCBhfJ2"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancer_components-schemas-single_response"}}},"description":"Patch Load Balancer response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancer_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Patch Load Balancer response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Patch Load Balancer","tags":["Load Balancers"]},"put":{"description":"Update a configured load balancer.","operationId":"load-balancers-update-load-balancer","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/load-balancer_components-schemas-identifier"}},{"in":"path","name":"identifier1","required":true,"schema":{"$ref":"#/components/schemas/load-balancer_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"adaptive_routing":{"$ref":"#/components/schemas/adaptive_routing"},"country_pools":{"$ref":"#/components/schemas/country_pools"},"default_pools":{"$ref":"#/components/schemas/default_pools"},"description":{"$ref":"#/components/schemas/components-schemas-description-UH5FN4sh"},"enabled":{"$ref":"#/components/schemas/components-schemas-enabled-tktxdyPy"},"fallback_pool":{"$ref":"#/components/schemas/fallback_pool"},"location_strategy":{"$ref":"#/components/schemas/location_strategy"},"name":{"$ref":"#/components/schemas/components-schemas-name-h5gI0ndx"},"pop_pools":{"$ref":"#/components/schemas/pop_pools"},"proxied":{"$ref":"#/components/schemas/proxied-ZGed5Tdg"},"random_steering":{"$ref":"#/components/schemas/random_steering"},"region_pools":{"$ref":"#/components/schemas/region_pools"},"rules":{"$ref":"#/components/schemas/rules-8L4eu614"},"session_affinity":{"$ref":"#/components/schemas/session_affinity"},"session_affinity_attributes":{"$ref":"#/components/schemas/session_affinity_attributes"},"session_affinity_ttl":{"$ref":"#/components/schemas/session_affinity_ttl"},"steering_policy":{"$ref":"#/components/schemas/steering_policy"},"ttl":{"$ref":"#/components/schemas/ttl-0jCBhfJ2"}},"required":["name","default_pools","fallback_pool"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancer_components-schemas-single_response"}}},"description":"Update Load Balancer response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancer_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Load Balancer response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Load Balancer","tags":["Load Balancers"]}},"/zones/{identifier}":{"delete":{"description":"Deletes an existing zone.","operationId":"zones-0-delete","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single-id-TFlitJo2"}}},"description":"Delete Zone response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Delete Zone response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Zone","tags":["Zone"],"x-cfPermissionsRequired":{"enum":["#zone:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"operationId":"zones-0-get","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-common-jkxlh21Y"},{"properties":{"result":{"$ref":"#/components/schemas/zone"}},"type":"object"}]}}},"description":"Zone Details response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Zone Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Zone Details","tags":["Zone"],"x-cfPermissionsRequired":{"enum":["#zone:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Editz a zone. Only one zone property can be changed at a time.","operationId":"zones-0-patch","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"example":{"paused":true},"properties":{"paused":{"$ref":"#/components/schemas/paused"},"plan":{"description":"(Deprecated) Please use the `/zones/{identifier}/subscription` API\nto update a zone's plan. Changing this value will create/cancel\nassociated subscriptions. To view available plans for this zone,\nsee Zone Plans.\n","properties":{"id":{"$ref":"#/components/schemas/identifier-MZFDye9j"}},"type":"object"},"type":{"description":"A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup. This parameter is only available to Enterprise customers or if it has been explicitly enabled on a zone.","enum":["full","partial"],"example":"full","type":"string"},"vanity_name_servers":{"$ref":"#/components/schemas/vanity_name_servers"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-common-jkxlh21Y"},{"properties":{"result":{"$ref":"#/components/schemas/zone"}},"type":"object"}]}}},"description":"Edit Zone response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Edit Zone response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Edit Zone","tags":["Zone"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{identifier}/access/apps":{"get":{"description":"List all Access Applications in a zone.","operationId":"zone-level-access-applications-list-access-applications","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/apps_components-schemas-response_collection-2"}}},"description":"List Access Applications response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/apps_components-schemas-response_collection-2"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Access Applications response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Access Applications","tags":["Zone-Level Access applications"]},"post":{"description":"Adds a new application to Access.","operationId":"zone-level-access-applications-add-a-bookmark-application","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-apps"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/apps_components-schemas-single_response-2"},{"properties":{"result":{"$ref":"#/components/schemas/schemas-apps"}}}]}}},"description":"Add an Access application response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/apps_components-schemas-single_response-2"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/schemas-bookmark_props"}]}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Add an Access application response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Add an Access application","tags":["Zone-Level Access applications"]}},"/zones/{identifier}/access/apps/ca":{"get":{"description":"Lists short-lived certificate CAs and their public keys.","operationId":"zone-level-access-short-lived-certificate-c-as-list-short-lived-certificate-c-as","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ca_components-schemas-response_collection"}}},"description":"List short-lived certificate CAs response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ca_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List short-lived certificate CAs response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List short-lived certificate CAs","tags":["Zone-Level Access short-lived certificate CAs"]}},"/zones/{identifier}/access/apps/{app_id}":{"delete":{"description":"Deletes an application from Access.","operationId":"zone-level-access-applications-delete-an-access-application","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/app_id-akwLjhUv"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-id_response-th0exOPu"}}},"description":"Delete an Access application response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-id_response-th0exOPu"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete an Access application response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete an Access application","tags":["Zone-Level Access applications"]},"get":{"description":"Fetches information about an Access application.","operationId":"zone-level-access-applications-get-an-access-application","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/app_id-akwLjhUv"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/apps_components-schemas-single_response-2"}}},"description":"Get an Access application response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/apps_components-schemas-single_response-2"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get an Access application response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get an Access application","tags":["Zone-Level Access applications"]},"put":{"description":"Updates an Access application.","operationId":"zone-level-access-applications-update-a-bookmark-application","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/app_id-akwLjhUv"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-apps"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/apps_components-schemas-single_response-2"},{"properties":{"result":{"$ref":"#/components/schemas/schemas-apps"}}}]}}},"description":"Update an Access application response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/apps_components-schemas-single_response-2"},{"properties":{"result":{"allOf":[{"$ref":"#/components/schemas/basic_app_response_props"},{"$ref":"#/components/schemas/schemas-bookmark_props"}]}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update an Access application response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update an Access application","tags":["Zone-Level Access applications"]}},"/zones/{identifier}/access/apps/{app_id}/revoke_tokens":{"post":{"description":"Revokes all service tokens used by an application.","operationId":"zone-level-access-applications-revoke-service-tokens","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/app_id-akwLjhUv"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-empty_response"}}},"description":"Revoke service tokens response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-empty_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Revoke service tokens response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Revoke service tokens","tags":["Zone-Level Access applications"]}},"/zones/{identifier}/access/apps/{app_id}/user_policy_checks":{"get":{"description":"Tests if a specific user has permission to access an application.","operationId":"zone-level-access-applications-test-access-policies","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/app_id-akwLjhUv"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/policy_check_response"}}},"description":"Test Access policies response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/policy_check_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Test Access policies response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Test Access policies","tags":["Zone-Level Access applications"]}},"/zones/{identifier}/access/apps/{uuid1}/policies/{uuid}":{"delete":{"description":"Delete an Access policy.","operationId":"zone-level-access-policies-delete-an-access-policy","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-uuid"}},{"in":"path","name":"uuid1","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-uuid"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/policies_components-schemas-id_response"}}},"description":"Delete an Access policy response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/policies_components-schemas-id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete an Access policy response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete an Access policy","tags":["Zone-Level Access policies"]},"get":{"description":"Fetches a single Access policy.","operationId":"zone-level-access-policies-get-an-access-policy","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-uuid"}},{"in":"path","name":"uuid1","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-uuid"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/policies_components-schemas-single_response"}}},"description":"Get an Access policy response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/policies_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get an Access policy response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get an Access policy","tags":["Zone-Level Access policies"]},"put":{"description":"Update a configured Access policy.","operationId":"zone-level-access-policies-update-an-access-policy","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-uuid"}},{"in":"path","name":"uuid1","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-uuid"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"approval_groups":{"$ref":"#/components/schemas/approval_groups"},"approval_required":{"$ref":"#/components/schemas/approval_required"},"decision":{"$ref":"#/components/schemas/decision"},"exclude":{"$ref":"#/components/schemas/schemas-exclude"},"include":{"$ref":"#/components/schemas/include"},"name":{"$ref":"#/components/schemas/policies_components-schemas-name"},"precedence":{"$ref":"#/components/schemas/precedence-GXhj5toi"},"purpose_justification_prompt":{"$ref":"#/components/schemas/purpose_justification_prompt"},"purpose_justification_required":{"$ref":"#/components/schemas/purpose_justification_required"},"require":{"$ref":"#/components/schemas/schemas-require"}},"required":["name","decision","include"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/policies_components-schemas-single_response"}}},"description":"Update an Access policy response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/policies_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update an Access policy response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update an Access policy","tags":["Zone-Level Access policies"]}},"/zones/{identifier}/access/apps/{uuid}/ca":{"delete":{"description":"Deletes a short-lived certificate CA.","operationId":"zone-level-access-short-lived-certificate-c-as-delete-a-short-lived-certificate-ca","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-id_response-77ATe4Eu"}}},"description":"Delete a short-lived certificate CA response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-id_response-77ATe4Eu"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete a short-lived certificate CA response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete a short-lived certificate CA","tags":["Zone-Level Access short-lived certificate CAs"]},"get":{"description":"Fetches a short-lived certificate CA and its public key.","operationId":"zone-level-access-short-lived-certificate-c-as-get-a-short-lived-certificate-ca","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ca_components-schemas-single_response"}}},"description":"Get a short-lived certificate CA response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ca_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get a short-lived certificate CA response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a short-lived certificate CA","tags":["Zone-Level Access short-lived certificate CAs"]},"post":{"description":"Generates a new short-lived certificate CA and public key.","operationId":"zone-level-access-short-lived-certificate-c-as-create-a-short-lived-certificate-ca","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ca_components-schemas-single_response"}}},"description":"Create a short-lived certificate CA response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ca_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create a short-lived certificate CA response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create a short-lived certificate CA","tags":["Zone-Level Access short-lived certificate CAs"]}},"/zones/{identifier}/access/apps/{uuid}/policies":{"get":{"description":"Lists Access policies configured for an application.","operationId":"zone-level-access-policies-list-access-policies","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-uuid"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/policies_components-schemas-response_collection"}}},"description":"List Access policies response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/policies_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Access policies response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Access policies","tags":["Zone-Level Access policies"]},"post":{"description":"Create a new Access policy for an application.","operationId":"zone-level-access-policies-create-an-access-policy","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/components-schemas-uuid"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"approval_groups":{"$ref":"#/components/schemas/approval_groups"},"approval_required":{"$ref":"#/components/schemas/approval_required"},"decision":{"$ref":"#/components/schemas/decision"},"exclude":{"$ref":"#/components/schemas/schemas-exclude"},"include":{"$ref":"#/components/schemas/include"},"name":{"$ref":"#/components/schemas/policies_components-schemas-name"},"precedence":{"$ref":"#/components/schemas/precedence-GXhj5toi"},"purpose_justification_prompt":{"$ref":"#/components/schemas/purpose_justification_prompt"},"purpose_justification_required":{"$ref":"#/components/schemas/purpose_justification_required"},"require":{"$ref":"#/components/schemas/schemas-require"}},"required":["name","decision","include"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/policies_components-schemas-single_response"}}},"description":"Create an Access policy response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/policies_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create an Access policy response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create an Access policy","tags":["Zone-Level Access policies"]}},"/zones/{identifier}/access/certificates":{"get":{"description":"Lists all mTLS certificates.","operationId":"zone-level-access-m-tls-authentication-list-m-tls-certificates","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificates_components-schemas-response_collection"}}},"description":"List mTLS certificates response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificates_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List mTLS certificates response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List mTLS certificates","tags":["Zone-Level Access mTLS authentication"]},"post":{"description":"Adds a new mTLS root certificate to Access.","operationId":"zone-level-access-m-tls-authentication-add-an-m-tls-certificate","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"associated_hostnames":{"$ref":"#/components/schemas/associated_hostnames"},"certificate":{"description":"The certificate content.","example":"-----BEGIN CERTIFICATE-----\nMIIGAjCCA+qgAwIBAgIJAI7kymlF7CWT...N4RI7KKB7nikiuUf8vhULKy5IX10\nDrUtmu/B\n-----END CERTIFICATE-----","type":"string"},"name":{"$ref":"#/components/schemas/certificates_components-schemas-name"}},"required":["name","certificate"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificates_components-schemas-single_response"}}},"description":"Add an mTLS certificate response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificates_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Add an mTLS certificate response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Add an mTLS certificate","tags":["Zone-Level Access mTLS authentication"]}},"/zones/{identifier}/access/certificates/settings":{"get":{"description":"List all mTLS hostname settings for this zone.","operationId":"zone-level-access-m-tls-authentication-list-m-tls-certificates-hostname-settings","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_collection_hostnames"}}},"description":"List mTLS hostname settings response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_collection_hostnames"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List mTLS hostname settings response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List all mTLS hostname settings","tags":["Zone-Level Access mTLS authentication"]}},"/zones/{identifier}/access/certificates/{uuid}":{"delete":{"description":"Deletes an mTLS certificate.","operationId":"zone-level-access-m-tls-authentication-delete-an-m-tls-certificate","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-id_response-th0exOPu"}}},"description":"Delete an mTLS certificate response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-id_response-th0exOPu"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete an mTLS certificate response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete an mTLS certificate","tags":["Zone-Level Access mTLS authentication"]},"get":{"description":"Fetches a single mTLS certificate.","operationId":"zone-level-access-m-tls-authentication-get-an-m-tls-certificate","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificates_components-schemas-single_response"}}},"description":"Get an mTLS certificate response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificates_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get an mTLS certificate response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get an mTLS certificate","tags":["Zone-Level Access mTLS authentication"]},"put":{"description":"Updates a configured mTLS certificate.","operationId":"zone-level-access-m-tls-authentication-update-an-m-tls-certificate","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"associated_hostnames":{"$ref":"#/components/schemas/associated_hostnames"},"name":{"$ref":"#/components/schemas/certificates_components-schemas-name"}},"required":["name","associated_hostnames"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificates_components-schemas-single_response"}}},"description":"Update an mTLS certificate response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificates_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update an mTLS certificate response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update an mTLS certificate","tags":["Zone-Level Access mTLS authentication"]}},"/zones/{identifier}/access/certificates/{uuid}/settings":{"put":{"description":"Updates an mTLS certificates hostname settings.","operationId":"zone-level-access-mtls-authentication-update-an-mtls-certificate-settings","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"settings":{"items":{"$ref":"#/components/schemas/settings-s418OBZp"},"type":"array"}},"required":["settings"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response_hostnames"}}},"description":"Update an mTLS certificates hostname settings response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response_hostnames"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update an mTLS certificates hostname settings failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update an mTLS certificates hostname settings","tags":["Zone-Level Access mTLS authentication"]}},"/zones/{identifier}/access/groups":{"get":{"description":"Lists all Access groups.","operationId":"zone-level-access-groups-list-access-groups","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-response_collection-4HEckTYK"}}},"description":"List Access groups response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-response_collection-4HEckTYK"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Access groups response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Access groups","tags":["Zone-Level Access groups"]},"post":{"description":"Creates a new Access group.","operationId":"zone-level-access-groups-create-an-access-group","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"exclude":{"$ref":"#/components/schemas/exclude"},"include":{"$ref":"#/components/schemas/include"},"name":{"$ref":"#/components/schemas/components-schemas-name-4G3Rlgj8"},"require":{"$ref":"#/components/schemas/require"}},"required":["name","include"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-single_response-gP2O4PI2"}}},"description":"Create an Access group response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-single_response-gP2O4PI2"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create an Access group response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create an Access group","tags":["Zone-Level Access groups"]}},"/zones/{identifier}/access/groups/{uuid}":{"delete":{"description":"Deletes an Access group.","operationId":"zone-level-access-groups-delete-an-access-group","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/schemas-uuid-JmfIpL8C"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/id_response-DDywCCxj"}}},"description":"Delete an Access group response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/id_response-DDywCCxj"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete an Access group response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete an Access group","tags":["Zone-Level Access groups"]},"get":{"description":"Fetches a single Access group.","operationId":"zone-level-access-groups-get-an-access-group","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/schemas-uuid-JmfIpL8C"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-single_response-gP2O4PI2"}}},"description":"Get an Access group response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-single_response-gP2O4PI2"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get an Access group response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get an Access group","tags":["Zone-Level Access groups"]},"put":{"description":"Updates a configured Access group.","operationId":"zone-level-access-groups-update-an-access-group","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/schemas-uuid-JmfIpL8C"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"exclude":{"$ref":"#/components/schemas/exclude"},"include":{"$ref":"#/components/schemas/include"},"name":{"$ref":"#/components/schemas/components-schemas-name-4G3Rlgj8"},"require":{"$ref":"#/components/schemas/require"}},"required":["name","include"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-single_response-gP2O4PI2"}}},"description":"Update an Access group response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-single_response-gP2O4PI2"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update an Access group response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update an Access group","tags":["Zone-Level Access groups"]}},"/zones/{identifier}/access/identity_providers":{"get":{"description":"Lists all configured identity providers.","operationId":"zone-level-access-identity-providers-list-access-identity-providers","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity-providers_components-schemas-response_collection"}}},"description":"List Access identity providers response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/identity-providers_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Access identity providers response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Access identity providers","tags":["Zone-Level Access identity providers"]},"post":{"description":"Adds a new identity provider to Access.","operationId":"zone-level-access-identity-providers-add-an-access-identity-provider","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-identity-providers"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity-providers_components-schemas-single_response"}}},"description":"Add an Access identity provider response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/identity-providers_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Add an Access identity provider response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Add an Access identity provider","tags":["Zone-Level Access identity providers"]}},"/zones/{identifier}/access/identity_providers/{uuid}":{"delete":{"description":"Deletes an identity provider from Access.","operationId":"zone-level-access-identity-providers-delete-an-access-identity-provider","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single-id"}}},"description":"Delete an Access identity provider response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/identity-providers_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete an Access identity provider response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete an Access identity provider","tags":["Zone-Level Access identity providers"]},"get":{"description":"Fetches a configured identity provider.","operationId":"zone-level-access-identity-providers-get-an-access-identity-provider","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity-providers_components-schemas-single_response"}}},"description":"Get an Access identity provider response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/identity-providers_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get an Access identity provider response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get an Access identity provider","tags":["Zone-Level Access identity providers"]},"put":{"description":"Updates a configured identity provider.","operationId":"zone-level-access-identity-providers-update-an-access-identity-provider","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-identity-providers"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identity-providers_components-schemas-single_response"}}},"description":"Update an Access identity provider response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/identity-providers_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update an Access identity provider response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update an Access identity provider","tags":["Zone-Level Access identity providers"]}},"/zones/{identifier}/access/organizations":{"get":{"description":"Returns the configuration for your Zero Trust organization.","operationId":"zone-level-zero-trust-organization-get-your-zero-trust-organization","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response-x2K6CTG8"}}},"description":"Get your Zero Trust organization response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response-x2K6CTG8"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get your Zero Trust organization response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get your Zero Trust organization","tags":["Zone-Level Zero Trust organization"]},"post":{"description":"Sets up a Zero Trust organization for your account.","operationId":"zone-level-zero-trust-organization-create-your-zero-trust-organization","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"auth_domain":{"$ref":"#/components/schemas/auth_domain"},"is_ui_read_only":{"$ref":"#/components/schemas/is_ui_read_only"},"login_design":{"$ref":"#/components/schemas/login_design"},"name":{"$ref":"#/components/schemas/name-xgxcxGi8"},"ui_read_only_toggle_reason":{"$ref":"#/components/schemas/ui_read_only_toggle_reason"},"user_seat_expiration_inactive_time":{"$ref":"#/components/schemas/user_seat_expiration_inactive_time"}},"required":["name","auth_domain"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response-x2K6CTG8"}}},"description":"Create your Zero Trust organization response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response-x2K6CTG8"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create your Zero Trust organization response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create your Zero Trust organization","tags":["Zone-Level Zero Trust organization"]},"put":{"description":"Updates the configuration for your Zero Trust organization.","operationId":"zone-level-zero-trust-organization-update-your-zero-trust-organization","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"auth_domain":{"$ref":"#/components/schemas/auth_domain"},"is_ui_read_only":{"$ref":"#/components/schemas/is_ui_read_only"},"login_design":{"$ref":"#/components/schemas/login_design"},"name":{"$ref":"#/components/schemas/name-xgxcxGi8"},"ui_read_only_toggle_reason":{"$ref":"#/components/schemas/ui_read_only_toggle_reason"},"user_seat_expiration_inactive_time":{"$ref":"#/components/schemas/user_seat_expiration_inactive_time"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response-x2K6CTG8"}}},"description":"Update your Zero Trust organization response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response-x2K6CTG8"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update your Zero Trust organization response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update your Zero Trust organization","tags":["Zone-Level Zero Trust organization"]}},"/zones/{identifier}/access/organizations/revoke_user":{"post":{"description":"Revokes a user's access across all applications.","operationId":"zone-level-zero-trust-organization-revoke-all-access-tokens-for-a-user","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"email":{"description":"The email of the user to revoke.","example":"test@example.com","type":"string"}},"required":["email"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/empty_response-47a5DGxM"}}},"description":"Revoke all Access tokens for a user response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/empty_response-47a5DGxM"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Revoke all Access tokens for a user response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Revoke all Access tokens for a user","tags":["Zone-Level Zero Trust organization"]}},"/zones/{identifier}/access/service_tokens":{"get":{"description":"Lists all service tokens.","operationId":"zone-level-access-service-tokens-list-service-tokens","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-response_collection-Qou49Scv"}}},"description":"List service tokens response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-response_collection-Qou49Scv"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List service tokens response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List service tokens","tags":["Zone-Level Access service tokens"]},"post":{"description":"Generates a new service token. **Note:** This is the only time you can get the Client Secret. If you lose the Client Secret, you will have to create a new service token.","operationId":"zone-level-access-service-tokens-create-a-service-token","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"$ref":"#/components/schemas/service-tokens_components-schemas-name"}},"required":["name"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_response"}}},"description":"Create a service token response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/create_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create a service token response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create a service token","tags":["Zone-Level Access service tokens"]}},"/zones/{identifier}/access/service_tokens/{uuid}":{"delete":{"description":"Deletes a service token.","operationId":"zone-level-access-service-tokens-delete-a-service-token","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/service-tokens_components-schemas-single_response"}}},"description":"Delete a service token response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/service-tokens_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete a service token response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete a service token","tags":["Zone-Level Access service tokens"]},"put":{"description":"Updates a configured service token.","operationId":"zone-level-access-service-tokens-update-a-service-token","parameters":[{"in":"path","name":"uuid","required":true,"schema":{"$ref":"#/components/schemas/uuid-EBZK5Bp1"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"$ref":"#/components/schemas/service-tokens_components-schemas-name"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/service-tokens_components-schemas-single_response"}}},"description":"Update a service token response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/service-tokens_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update a service token response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update a service token","tags":["Zone-Level Access service tokens"]}},"/zones/{identifier}/dns_analytics/report":{"get":{"description":"Retrieves a list of summarised aggregate metrics over a given time period.\n\nSee [Analytics API properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/) for detailed information about the available query parameters.","operationId":"dns-analytics-table","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-98VX040R"}},{"in":"query","name":"metrics","schema":{"$ref":"#/components/schemas/metrics"}},{"in":"query","name":"dimensions","schema":{"$ref":"#/components/schemas/dimensions"}},{"in":"query","name":"since","schema":{"$ref":"#/components/schemas/since"}},{"in":"query","name":"until","schema":{"$ref":"#/components/schemas/until"}},{"in":"query","name":"limit","schema":{"$ref":"#/components/schemas/limit"}},{"in":"query","name":"sort","schema":{"$ref":"#/components/schemas/sort"}},{"in":"query","name":"filters","schema":{"$ref":"#/components/schemas/filters-6K6BiPDe"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/report"}},"type":"object"}]}}},"description":"Table response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/report"}},"type":"object"}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Table response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Table","tags":["DNS Analytics"],"x-cfPermissionsRequired":{"enum":["#analytics:read"]}}},"/zones/{identifier}/dns_analytics/report/bytime":{"get":{"description":"Retrieves a list of aggregate metrics grouped by time interval.\n\nSee [Analytics API properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/) for detailed information about the available query parameters.","operationId":"dns-analytics-by-time","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-98VX040R"}},{"in":"query","name":"metrics","schema":{"$ref":"#/components/schemas/metrics"}},{"in":"query","name":"dimensions","schema":{"$ref":"#/components/schemas/dimensions"}},{"in":"query","name":"since","schema":{"$ref":"#/components/schemas/since"}},{"in":"query","name":"until","schema":{"$ref":"#/components/schemas/until"}},{"in":"query","name":"limit","schema":{"$ref":"#/components/schemas/limit"}},{"in":"query","name":"sort","schema":{"$ref":"#/components/schemas/sort"}},{"in":"query","name":"filters","schema":{"$ref":"#/components/schemas/filters-6K6BiPDe"}},{"in":"query","name":"time_delta","schema":{"$ref":"#/components/schemas/time_delta"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/report_bytime"}},"type":"object"}]}}},"description":"By Time response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/report_bytime"}},"type":"object"}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"By Time response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"By Time","tags":["DNS Analytics"],"x-cfPermissionsRequired":{"enum":["#analytics:read"]}}},"/zones/{identifier}/load_balancers":{"get":{"description":"List configured load balancers.","operationId":"load-balancers-list-load-balancers","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/load-balancer_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancer_components-schemas-response_collection"}}},"description":"List Load Balancers response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancer_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Load Balancers response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Load Balancers","tags":["Load Balancers"]},"post":{"description":"Create a new load balancer.","operationId":"load-balancers-create-load-balancer","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/load-balancer_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"adaptive_routing":{"$ref":"#/components/schemas/adaptive_routing"},"country_pools":{"$ref":"#/components/schemas/country_pools"},"default_pools":{"$ref":"#/components/schemas/default_pools"},"description":{"$ref":"#/components/schemas/components-schemas-description-UH5FN4sh"},"fallback_pool":{"$ref":"#/components/schemas/fallback_pool"},"location_strategy":{"$ref":"#/components/schemas/location_strategy"},"name":{"$ref":"#/components/schemas/components-schemas-name-h5gI0ndx"},"pop_pools":{"$ref":"#/components/schemas/pop_pools"},"proxied":{"$ref":"#/components/schemas/proxied-ZGed5Tdg"},"random_steering":{"$ref":"#/components/schemas/random_steering"},"region_pools":{"$ref":"#/components/schemas/region_pools"},"rules":{"$ref":"#/components/schemas/rules-8L4eu614"},"session_affinity":{"$ref":"#/components/schemas/session_affinity"},"session_affinity_attributes":{"$ref":"#/components/schemas/session_affinity_attributes"},"session_affinity_ttl":{"$ref":"#/components/schemas/session_affinity_ttl"},"steering_policy":{"$ref":"#/components/schemas/steering_policy"},"ttl":{"$ref":"#/components/schemas/ttl-0jCBhfJ2"}},"required":["name","default_pools","fallback_pool"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/load-balancer_components-schemas-single_response"}}},"description":"Create Load Balancer response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/load-balancer_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Load Balancer response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Load Balancer","tags":["Load Balancers"]}},"/zones/{identifier}/purge_cache":{"post":{"description":"### Purge All Cached Content\nRemoves ALL files from Cloudflare's cache. All tiers can purge everything.\n\n### Purge Cached Content by URL\nGranularly removes one or more files from Cloudflare's cache by specifying URLs. All tiers can purge by URL.\n\nTo purge files with custom cache keys, include the headers used to compute the cache key as in the example. If you have a device type or geo in your cache key, you will need to include the CF-Device-Type or CF-IPCountry headers.\n\n**NB:** When including the Origin header, be sure to include the **scheme** and **hostname**. The port number can be omitted if it is the default port (80 for http, 443 for https), but must be included otherwise.\n\n### Purge Cached Content by Tag, Host or Prefix\nGranularly removes one or more files from Cloudflare's cache either by specifying the host, the associated Cache-Tag, or a Prefix. Only Enterprise customers are permitted to purge by Tag, Host or Prefix.\n\n**NB:** Cache-Tag, host, and prefix purging each have a rate limit of 30,000 purge API calls in every 24 hour period. You may purge up to 30 tags, hosts, or prefixes in one API call. This rate limit can be raised for customers who need to purge at higher volume.\n","operationId":"zone-purge","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-BccsQUhC"}}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/Flex"},{"$ref":"#/components/schemas/Everything"},{"$ref":"#/components/schemas/Files"}]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single-id"}}},"description":"Purge Cached Content"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single-id"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Purge Cached Content failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Purge Cached Content","tags":["Zone"],"x-cfPermissionsRequired":{"enum":["#cache_purge:edit"]}}},"/zones/{identifier}/ssl/analyze":{"post":{"description":"Returns the set of hostnames, the signature algorithm, and the expiration date of the certificate.","operationId":"analyze-certificate-analyze-certificate","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"bundle_method":{"$ref":"#/components/schemas/bundle_method"},"certificate":{"$ref":"#/components/schemas/certificate"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificate_analyze_response"}}},"description":"Analyze Certificate response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificate_analyze_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Analyze Certificate response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Analyze Certificate","tags":["Analyze Certificate"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{identifier}/subscription":{"get":{"description":"Lists zone subscription details.","operationId":"zone-subscription-zone-subscription-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/subscription-v2_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zone_subscription_response_single"}}},"description":"Zone Subscription Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_subscription_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Zone Subscription Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Zone Subscription Details","tags":["Zone Subscription"],"x-cfPermissionsRequired":{"enum":["#billing:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Create a zone subscription, either plan or add-ons.","operationId":"zone-subscription-create-zone-subscription","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/subscription-v2_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscription-v2"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zone_subscription_response_single"}}},"description":"Create Zone Subscription response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_subscription_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Zone Subscription response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Zone Subscription","tags":["Zone Subscription"],"x-cfPermissionsRequired":{"enum":["#billing:read","#billing:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Updates zone subscriptions, either plan or add-ons.","operationId":"zone-subscription-update-zone-subscription","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/subscription-v2_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscription-v2"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zone_subscription_response_single"}}},"description":"Update Zone Subscription response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_subscription_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Zone Subscription response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Zone Subscription","tags":["Zone Subscription"],"x-cfPermissionsRequired":{"enum":["#billing:read","#billing:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/acm/total_tls":{"get":{"description":"Get Total TLS Settings for a Zone.","operationId":"total-tls-total-tls-settings-details","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/total_tls_settings_response-uh822r21"}}},"description":"Total TLS Settings Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/total_tls_settings_response-uh822r21"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Total TLS Settings Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Total TLS Settings Details","tags":["Total TLS"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Set Total TLS Settings or disable the feature for a Zone.","operationId":"total-tls-enable-or-disable-total-tls","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"certificate_authority":{"$ref":"#/components/schemas/schemas-certificate_authority-mu8utRU0"},"enabled":{"$ref":"#/components/schemas/components-schemas-enabled"}},"required":["enabled"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/total_tls_settings_response-uh822r21"}}},"description":"Enable or Disable Total TLS response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/total_tls_settings_response-uh822r21"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Enable or Disable Total TLS response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Enable or Disable Total TLS","tags":["Total TLS"],"x-cfPermissionsRequired":{"enum":["#ssl:read","#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/analytics/colos":{"get":{"deprecated":true,"description":"This view provides a breakdown of analytics data by datacenter. Note: This is available to Enterprise customers only.","operationId":"zone-analytics-(-deprecated)-get-analytics-by-co-locations","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"until","schema":{"$ref":"#/components/schemas/until-HpHDrENT"}},{"in":"query","name":"since","schema":{"anyOf":[{"type":"string"},{"type":"integer"}],"default":-10080,"description":"The (inclusive) beginning of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. At this point in time, it cannot exceed a time in the past greater than one year.\n\nRanges that the Cloudflare web application provides will provide the following period length for each point:\n- Last 60 minutes (from -59 to -1): 1 minute resolution\n- Last 7 hours (from -419 to -60): 15 minutes resolution\n- Last 15 hours (from -899 to -420): 30 minutes resolution\n- Last 72 hours (from -4320 to -900): 1 hour resolution\n- Older than 3 days (-525600 to -4320): 1 day resolution.","example":"2015-01-01T12:23:00Z"}},{"in":"query","name":"continuous","schema":{"default":true,"description":"When set to true, the API will move the requested time window backward, until it finds a region with completely aggregated data.\n\nThe API response _may not represent the requested time window_.","type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/colo_response"}}},"description":"Get analytics by Co-locations response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/colo_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get analytics by Co-locations response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get analytics by Co-locations","tags":["Zone Analytics (Deprecated)"],"x-cfDeprecation":{"description":"Please use the new GraphQL Analytics API instead: https://developers.cloudflare.com/analytics/graphql-api/. It provides equivalent data and more features, including the ability to select only the metrics you need. Migration guide: https://developers.cloudflare.com/analytics/migration-guides/zone-analytics/.","display":true,"eol":"2021-03-01","id":"zone_analytics_deprecation"},"x-cfPermissionsRequired":{"enum":["#analytics:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/analytics/dashboard":{"get":{"deprecated":true,"description":"The dashboard view provides both totals and timeseries data for the given zone and time period across the entire Cloudflare network.","operationId":"zone-analytics-(-deprecated)-get-dashboard","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"until","schema":{"$ref":"#/components/schemas/until-HpHDrENT"}},{"in":"query","name":"since","schema":{"anyOf":[{"type":"string"},{"type":"integer"}],"default":-10080,"description":"The (inclusive) beginning of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. At this point in time, it cannot exceed a time in the past greater than one year.\n\nRanges that the Cloudflare web application provides will provide the following period length for each point:\n- Last 60 minutes (from -59 to -1): 1 minute resolution\n- Last 7 hours (from -419 to -60): 15 minutes resolution\n- Last 15 hours (from -899 to -420): 30 minutes resolution\n- Last 72 hours (from -4320 to -900): 1 hour resolution\n- Older than 3 days (-525600 to -4320): 1 day resolution.","example":"2015-01-01T12:23:00Z"}},{"in":"query","name":"continuous","schema":{"default":true,"description":"When set to true, the API will move the requested time window backward, until it finds a region with completely aggregated data.\n\nThe API response _may not represent the requested time window_.","type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dashboard_response"}}},"description":"Get dashboard response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dashboard_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get dashboard response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get dashboard","tags":["Zone Analytics (Deprecated)"],"x-cfDeprecation":{"description":"Please use the new GraphQL Analytics API instead: https://developers.cloudflare.com/analytics/graphql-api/. It provides equivalent data and more features, including the ability to select only the metrics you need. Migration guide: https://developers.cloudflare.com/analytics/migration-guides/zone-analytics/.","display":true,"eol":"2021-03-01","id":"zone_analytics_deprecation"},"x-cfPermissionsRequired":{"enum":["#analytics:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/analytics/latency":{"get":{"operationId":"argo-analytics-for-zone-argo-analytics-for-a-zone","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"bins","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-response_single"}}},"description":"Argo Analytics for a zone response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Argo Analytics for a zone response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Argo Analytics for a zone","tags":["Argo Analytics for Zone"],"x-cfPermissionsRequired":{"enum":["#analytics:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/analytics/latency/colos":{"get":{"operationId":"argo-analytics-for-geolocation-argo-analytics-for-a-zone-at-different-po-ps","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-response_single"}}},"description":"Argo Analytics for a zone at different PoPs response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Argo Analytics for a zone at different PoPs response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Argo Analytics for a zone at different PoPs","tags":["Argo Analytics for Geolocation"],"x-cfPermissionsRequired":{"enum":["#analytics:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/argo/smart_routing":{"get":{"operationId":"argo-smart-routing-get-argo-smart-routing-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-response_single"}}},"description":"Get Argo Smart Routing setting response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Argo Smart Routing setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Argo Smart Routing setting","tags":["Argo Smart Routing"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Updates enablement of Argo Smart Routing.","operationId":"argo-smart-routing-patch-argo-smart-routing-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/patch"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-response_single"}}},"description":"Patch Argo Smart Routing setting response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Patch Argo Smart Routing setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Patch Argo Smart Routing setting","tags":["Argo Smart Routing"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read","#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/argo/tiered_caching":{"get":{"operationId":"tiered-caching-get-tiered-caching-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-response_single"}}},"description":"Get Tiered Caching setting response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Tiered Caching setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Tiered Caching setting","tags":["Tiered Caching"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Updates enablement of Tiered Caching","operationId":"tiered-caching-patch-tiered-caching-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-patch"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-response_single"}}},"description":"Patch Tiered Caching setting response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Patch Tiered Caching setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Patch Tiered Caching setting","tags":["Tiered Caching"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read","#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/available_plans":{"get":{"description":"Lists available plans the zone can subscribe to.","operationId":"zone-rate-plan-list-available-plans","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/available-rate-plan"},"type":"array"}}}]}}},"description":"List Available Plans response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-collection"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/available-rate-plan"},"type":"array"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Available Plans response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Available Plans","tags":["Zone Rate Plan"],"x-cfPermissionsRequired":{"enum":["#billing:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/available_plans/{plan_identifier}":{"get":{"description":"Details of the available plan that the zone can subscribe to.","operationId":"zone-rate-plan-available-plan-details","parameters":[{"in":"path","name":"plan_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/available-rate-plan"}}}]}}},"description":"Available Plan Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"$ref":"#/components/schemas/available-rate-plan"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Available Plan Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Available Plan Details","tags":["Zone Rate Plan"],"x-cfPermissionsRequired":{"enum":["#billing:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/available_rate_plans":{"get":{"description":"Lists all rate plans the zone can subscribe to.","operationId":"zone-rate-plan-list-available-rate-plans","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/plan_response_collection"}}},"description":"List Available Rate Plans response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/plan_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Available Rate Plans response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Available Rate Plans","tags":["Zone Rate Plan"],"x-cfPermissionsRequired":{"enum":["#billing:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/cache/cache_reserve":{"get":{"description":"Increase cache lifetimes by automatically storing all cacheable files into Cloudflare's persistent object storage buckets. Requires Cache Reserve subscription. Note: using Tiered Cache with Cache Reserve is highly recommended to reduce Reserve operations costs. See the [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve) for more information.","operationId":"zone-cache-settings-get-cache-reserve-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_cache_settings_response_single"},{"$ref":"#/components/schemas/cache_reserve_response_value"}]}}},"description":"Get Cache Reserve setting response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_cache_settings_response_single"},{"$ref":"#/components/schemas/cache_reserve_response_value"}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Cache Reserve setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Cache Reserve setting","tags":["Zone Cache Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Increase cache lifetimes by automatically storing all cacheable files into Cloudflare's persistent object storage buckets. Requires Cache Reserve subscription. Note: using Tiered Cache with Cache Reserve is highly recommended to reduce Reserve operations costs. See the [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve) for more information.","operationId":"zone-cache-settings-change-cache-reserve-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/cache_reserve_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_cache_settings_response_single"},{"$ref":"#/components/schemas/cache_reserve_response_value"}]}}},"description":"Change Cache Reserve setting response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_cache_settings_response_single"},{"$ref":"#/components/schemas/cache_reserve_response_value"}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Change Cache Reserve setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Cache Reserve setting","tags":["Zone Cache Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/cache/tiered_cache_smart_topology_enable":{"delete":{"description":"Remvoves enablement of Smart Tiered Cache","operationId":"smart-tiered-cache-delete-smart-tiered-cache-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-response_single"}}},"description":"Delete Smart Tiered Cache setting response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Smart Tiered Cache setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Smart Tiered Cache setting","tags":["Smart Tiered Cache"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"operationId":"smart-tiered-cache-get-smart-tiered-cache-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-response_single"}}},"description":"Get Smart Tiered Cache setting response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Smart Tiered Cache setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Smart Tiered Cache setting","tags":["Smart Tiered Cache"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Updates enablement of Tiered Cache","operationId":"smart-tiered-cache-patch-smart-tiered-cache-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-patch"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-response_single"}}},"description":"Patch Smart Tiered Cache setting response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Patch Smart Tiered Cache setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Patch Smart Tiered Cache setting","tags":["Smart Tiered Cache"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read","#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/cache/variants":{"delete":{"description":"Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.","operationId":"zone-cache-settings-delete-variants-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_cache_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/variants"}}}]}}},"description":"Delete variants setting response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_cache_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/variants"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete variants setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete variants setting","tags":["Zone Cache Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"get":{"description":"Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.","operationId":"zone-cache-settings-get-variants-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_cache_settings_response_single"},{"$ref":"#/components/schemas/variants_response_value"}]}}},"description":"Get variants setting response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_cache_settings_response_single"},{"$ref":"#/components/schemas/variants_response_value"}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get variants setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get variants setting","tags":["Zone Cache Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"patch":{"description":"Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.","operationId":"zone-cache-settings-change-variants-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/variants_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_cache_settings_response_single"},{"$ref":"#/components/schemas/variants_response_value"}]}}},"description":"Change variants setting response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_cache_settings_response_single"},{"$ref":"#/components/schemas/variants_response_value"}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Change variants setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change variants setting","tags":["Zone Cache Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_identifier}/certificate_authorities/hostname_associations":{"get":{"description":"List Hostname Associations","operationId":"client-certificate-for-a-zone-list-hostname-associations","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-tZwYoMuc"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hostname_associations_response"}}},"description":"List Hostname Associations Response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Hostname Associations Response Failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Hostname Associations","tags":["API Shield Client Certificates for a Zone"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Replace Hostname Associations","operationId":"client-certificate-for-a-zone-put-hostname-associations","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-tZwYoMuc"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hostname_association"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hostname_associations_response"}}},"description":"Replace Hostname Associations Response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"Replace Hostname Associations Response Failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Replace Hostname Associations","tags":["API Shield Client Certificates for a Zone"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/client_certificates":{"get":{"description":"List all of your Zone's API Shield mTLS Client Certificates by Status and/or using Pagination","operationId":"client-certificate-for-a-zone-list-client-certificates","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-tZwYoMuc"}},{"in":"query","name":"status","schema":{"description":"Client Certitifcate Status to filter results by.","enum":["all","active","pending_reactivation","pending_revocation","revoked"],"example":"all"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Number of records per page.","maximum":50,"minimum":5,"type":"number"}},{"in":"query","name":"limit","schema":{"description":"Limit to the number of records returned.","example":10,"type":"integer"}},{"in":"query","name":"offset","schema":{"description":"Offset the results","example":10,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_certificate_response_collection"}}},"description":"List Client Certificates Response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Client Certificates Response Failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Client Certificates","tags":["API Shield Client Certificates for a Zone"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Create a new API Shield mTLS Client Certificate","operationId":"client-certificate-for-a-zone-create-client-certificate","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-tZwYoMuc"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"csr":{"$ref":"#/components/schemas/schemas-csr"},"validity_days":{"$ref":"#/components/schemas/components-schemas-validity_days"}},"required":["csr","validity_days"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_certificate_response_single"}}},"description":"Create Client Certificate Response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/client_certificate_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Client Certificate Response Failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Client Certificate","tags":["API Shield Client Certificates for a Zone"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/client_certificates/{client_certificate_identifier}":{"delete":{"description":"Set a API Shield mTLS Client Certificate to pending_revocation status for processing to revoked status.","operationId":"client-certificate-for-a-zone-delete-client-certificate","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-tZwYoMuc"}},{"in":"path","name":"client_certificate_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-tZwYoMuc"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_certificate_response_single"}}},"description":"Revoke Client Certificate Response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"Revoke Client Certificate Response Failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Revoke Client Certificate","tags":["API Shield Client Certificates for a Zone"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Get Details for a single mTLS API Shield Client Certificate","operationId":"client-certificate-for-a-zone-client-certificate-details","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-tZwYoMuc"}},{"in":"path","name":"client_certificate_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-tZwYoMuc"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_certificate_response_single"}}},"description":"Client Certificate Details Response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"Client Certificate Details Response Failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Client Certificate Details","tags":["API Shield Client Certificates for a Zone"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"If a API Shield mTLS Client Certificate is in a pending_revocation state, you may reactivate it with this endpoint.","operationId":"client-certificate-for-a-zone-edit-client-certificate","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-tZwYoMuc"}},{"in":"path","name":"client_certificate_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-tZwYoMuc"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/client_certificate_response_single"}}},"description":"Reactivate Client Certificate Response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure"}}},"description":"Reactivate Client Certificate Response Failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Reactivate Client Certificate","tags":["API Shield Client Certificates for a Zone"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/custom_certificates":{"get":{"description":"List, search, and filter all of your custom SSL certificates. The higher priority will break ties across overlapping 'legacy_custom' certificates, but 'legacy_custom' certificates will always supercede 'sni_custom' certificates.","operationId":"custom-ssl-for-a-zone-list-ssl-configurations","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Number of zones per page.","maximum":50,"minimum":5,"type":"number"}},{"in":"query","name":"match","schema":{"default":"all","description":"Whether to match all search requirements or at least one (any).","enum":["any","all"],"type":"string"}},{"in":"query","name":"status","schema":{"description":"Status of the zone's custom SSL.","enum":["active","expired","deleted","pending","initializing"],"example":"active","readOnly":true}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificate_response_collection"}}},"description":"List SSL Configurations response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificate_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List SSL Configurations response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List SSL Configurations","tags":["Custom SSL for a Zone"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Upload a new SSL certificate for a zone.","operationId":"custom-ssl-for-a-zone-create-ssl-configuration","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"bundle_method":{"$ref":"#/components/schemas/bundle_method"},"certificate":{"$ref":"#/components/schemas/certificate"},"geo_restrictions":{"$ref":"#/components/schemas/geo_restrictions"},"policy":{"$ref":"#/components/schemas/policy"},"private_key":{"$ref":"#/components/schemas/private_key"},"type":{"$ref":"#/components/schemas/components-schemas-type"}},"required":["certificate","private_key"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificate_response_single"}}},"description":"Create SSL Configuration response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificate_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create SSL Configuration response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create SSL Configuration","tags":["Custom SSL for a Zone"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/custom_certificates/prioritize":{"put":{"description":"If a zone has multiple SSL certificates, you can set the order in which they should be used during a request. The higher priority will break ties across overlapping 'legacy_custom' certificates.","operationId":"custom-ssl-for-a-zone-re-prioritize-ssl-certificates","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"certificates":{"description":"Array of ordered certificates.","example":[{"id":"5a7805061c76ada191ed06f989cc3dac","priority":2},{"id":"9a7806061c88ada191ed06f989cc3dac","priority":1}],"items":{"properties":{"id":{"$ref":"#/components/schemas/custom-certificate_components-schemas-identifier"},"priority":{"$ref":"#/components/schemas/priority-eLZLlpCp"}},"type":"object"},"type":"array"}},"required":["certificates"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificate_response_collection"}}},"description":"Re-prioritize SSL Certificates response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificate_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Re-prioritize SSL Certificates response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Re-prioritize SSL Certificates","tags":["Custom SSL for a Zone"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/custom_certificates/{identifier}":{"delete":{"description":"Remove a SSL certificate from a zone.","operationId":"custom-ssl-for-a-zone-delete-ssl-configuration","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/custom-certificate_components-schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificate_response_id_only-e7wXd3xw"}}},"description":"Delete SSL Configuration response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificate_response_id_only-e7wXd3xw"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete SSL Configuration response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete SSL Configuration","tags":["Custom SSL for a Zone"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"get":{"operationId":"custom-ssl-for-a-zone-ssl-configuration-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/custom-certificate_components-schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificate_response_single"}}},"description":"SSL Configuration Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificate_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"SSL Configuration Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"SSL Configuration Details","tags":["Custom SSL for a Zone"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"patch":{"description":"Upload a new private key and/or PEM/CRT for the SSL certificate. Note: PATCHing a configuration for sni_custom certificates will result in a new resource id being returned, and the previous one being deleted.","operationId":"custom-ssl-for-a-zone-edit-ssl-configuration","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/custom-certificate_components-schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"bundle_method":{"$ref":"#/components/schemas/bundle_method"},"certificate":{"$ref":"#/components/schemas/certificate"},"geo_restrictions":{"$ref":"#/components/schemas/geo_restrictions"},"policy":{"$ref":"#/components/schemas/policy"},"private_key":{"$ref":"#/components/schemas/private_key"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificate_response_single"}}},"description":"Edit SSL Configuration response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificate_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Edit SSL Configuration response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Edit SSL Configuration","tags":["Custom SSL for a Zone"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/custom_hostnames":{"get":{"description":"List, search, sort, and filter all of your custom hostnames.","operationId":"custom-hostname-for-a-zone-list-custom-hostnames","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"hostname","schema":{"description":"Fully qualified domain name to match against. This parameter cannot be used with the 'id' parameter.","example":"app.example.com","maxLength":255,"type":"string"}},{"in":"query","name":"id","schema":{"description":"Hostname ID to match against. This ID was generated and returned during the initial custom_hostname creation. This parameter cannot be used with the 'hostname' parameter.","example":"0d89c70d-ad9f-4843-b99f-6cc0252067e9","maxLength":36,"minLength":36,"type":"string"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Number of hostnames per page.","maximum":50,"minimum":5,"type":"number"}},{"in":"query","name":"order","schema":{"default":"ssl","description":"Field to order hostnames by.","enum":["ssl","ssl_status"],"example":"ssl"}},{"in":"query","name":"direction","schema":{"description":"Direction to order hostnames.","enum":["asc","desc"],"example":"desc"}},{"in":"query","name":"ssl","schema":{"default":"0","description":"Whether to filter hostnames based on if they have SSL enabled.","enum":[0,1]}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_hostname_response_collection"}}},"description":"List Custom Hostnames response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom_hostname_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Custom Hostnames response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Custom Hostnames","tags":["Custom Hostname for a Zone"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Add a new custom hostname and request that an SSL certificate be issued for it. One of three validation methods—http, txt, email—should be used, with 'http' recommended if the CNAME is already in place (or will be soon). Specifying 'email' will send an email to the WHOIS contacts on file for the base domain plus hostmaster, postmaster, webmaster, admin, administrator. If http is used and the domain is not already pointing to the Managed CNAME host, the PATCH method must be used once it is (to complete validation).","operationId":"custom-hostname-for-a-zone-create-custom-hostname","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"custom_metadata":{"$ref":"#/components/schemas/custom_metadata"},"hostname":{"$ref":"#/components/schemas/hostname"},"ssl":{"$ref":"#/components/schemas/sslpost-TcVapXSa"}},"required":["hostname","ssl"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_hostname_response_single-sVpYaC2x"}}},"description":"Create Custom Hostname response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom_hostname_response_single-sVpYaC2x"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Custom Hostname response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Custom Hostname","tags":["Custom Hostname for a Zone"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/custom_hostnames/fallback_origin":{"delete":{"operationId":"custom-hostname-fallback-origin-for-a-zone-delete-fallback-origin-for-custom-hostnames","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/fallback_origin_response"}}},"description":"Delete Fallback Origin for Custom Hostnames response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/fallback_origin_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Fallback Origin for Custom Hostnames response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Fallback Origin for Custom Hostnames","tags":["Custom Hostname Fallback Origin for a Zone"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"operationId":"custom-hostname-fallback-origin-for-a-zone-get-fallback-origin-for-custom-hostnames","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/fallback_origin_response"}}},"description":"Get Fallback Origin for Custom Hostnames response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/fallback_origin_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Fallback Origin for Custom Hostnames response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Fallback Origin for Custom Hostnames","tags":["Custom Hostname Fallback Origin for a Zone"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"operationId":"custom-hostname-fallback-origin-for-a-zone-update-fallback-origin-for-custom-hostnames","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"origin":{"$ref":"#/components/schemas/origin"}},"required":["origin"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/fallback_origin_response"}}},"description":"Update Fallback Origin for Custom Hostnames response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/fallback_origin_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Fallback Origin for Custom Hostnames response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Fallback Origin for Custom Hostnames","tags":["Custom Hostname Fallback Origin for a Zone"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/custom_hostnames/{identifier}":{"delete":{"operationId":"custom-hostname-for-a-zone-delete-custom-hostname-(-and-any-issued-ssl-certificates)","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/custom-hostname_components-schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"$ref":"#/components/schemas/custom-hostname_components-schemas-identifier"}},"type":"object"}}},"description":"Delete Custom Hostname (and any issued SSL certificates) response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"properties":{"id":{"$ref":"#/components/schemas/custom-hostname_components-schemas-identifier"}},"type":"object"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Custom Hostname (and any issued SSL certificates) response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Custom Hostname (and any issued SSL certificates)","tags":["Custom Hostname for a Zone"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"operationId":"custom-hostname-for-a-zone-custom-hostname-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/custom-hostname_components-schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_hostname_response_single-sVpYaC2x"}}},"description":"Custom Hostname Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom_hostname_response_single-sVpYaC2x"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Custom Hostname Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Custom Hostname Details","tags":["Custom Hostname for a Zone"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Modify SSL configuration for a custom hostname. When sent with SSL config that matches existing config, used to indicate that hostname should pass domain control validation (DCV). Can also be used to change validation type, e.g., from 'http' to 'email'.","operationId":"custom-hostname-for-a-zone-edit-custom-hostname","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/custom-hostname_components-schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"custom_metadata":{"$ref":"#/components/schemas/custom_metadata"},"custom_origin_server":{"$ref":"#/components/schemas/custom_origin_server"},"custom_origin_sni":{"$ref":"#/components/schemas/custom_origin_sni"},"ssl":{"$ref":"#/components/schemas/sslpost-TcVapXSa"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_hostname_response_single-sVpYaC2x"}}},"description":"Edit Custom Hostname response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom_hostname_response_single-sVpYaC2x"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Edit Custom Hostname response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Edit Custom Hostname","tags":["Custom Hostname for a Zone"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/custom_ns":{"get":{"description":"Get metadata for account-level custom nameservers on a zone.\n","operationId":"account-level-custom-nameservers-usage-for-a-zone-get-account-custom-nameserver-related-zone-metadata","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_response"}}},"description":"Get Account Custom Nameserver Related Zone Metadata response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/get_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Account Custom Nameserver Related Zone Metadata response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Account Custom Nameserver Related Zone Metadata","tags":["Account-Level Custom Nameservers Usage for a Zone"],"x-cfPermissionsRequired":{"enum":["#zone:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Set metadata for account-level custom nameservers on a zone.\n\nIf you would like new zones in the account to use account custom nameservers by default, use PUT /accounts/:identifier to set the account setting use_account_custom_ns_by_default to true.\n","operationId":"account-level-custom-nameservers-usage-for-a-zone-set-account-custom-nameserver-related-zone-metadata","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zone_metadata"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/empty_response-V46LqGZw"}}},"description":"Set Account Custom Nameserver Related Zone Metadata response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/empty_response-V46LqGZw"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Set Account Custom Nameserver Related Zone Metadata response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Set Account Custom Nameserver Related Zone Metadata","tags":["Account-Level Custom Nameservers Usage for a Zone"],"x-cfPermissionsRequired":{"enum":["#zone:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/custom_pages":{"get":{"description":"Fetches all the custom pages at the zone level.","operationId":"custom-pages-for-a-zone-list-custom-pages","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_pages_response_collection"}}},"description":"List custom pages response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom_pages_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List custom pages response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List custom pages","tags":["Custom pages for a zone"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_identifier}/custom_pages/{identifier}":{"get":{"description":"Fetches the details of a custom page.","operationId":"custom-pages-for-a-zone-get-a-custom-page","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/custom-pages_components-schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_pages_response_single"}}},"description":"Get a custom page response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom_pages_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get a custom page response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a custom page","tags":["Custom pages for a zone"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"put":{"description":"Updates the configuration of an existing custom page.","operationId":"custom-pages-for-a-zone-update-a-custom-page","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/custom-pages_components-schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"state":{"$ref":"#/components/schemas/schemas-state"},"url":{"$ref":"#/components/schemas/url"}},"required":["url","state"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_pages_response_single"}}},"description":"Update a custom page response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom_pages_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update a custom page response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update a custom page","tags":["Custom pages for a zone"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_identifier}/dns_records":{"get":{"description":"List, search, sort, and filter a zones' DNS records.","operationId":"dns-records-for-a-zone-list-dns-records","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-zpETYDGh"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns_response_collection"}}},"description":"List DNS Records response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List DNS Records response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List DNS Records","tags":["DNS Records for a Zone"],"x-cfPermissionsRequired":{"enum":["#dns_records:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Create a new DNS record for a zone. See the record object definitions for required attributes for each record type.","operationId":"dns-records-for-a-zone-create-dns-record","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-zpETYDGh"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-record"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns_response_single"}}},"description":"Create DNS Record response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create DNS Record response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create DNS Record","tags":["DNS Records for a Zone"],"x-cfPermissionsRequired":{"enum":["#dns_records:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/dns_records/export":{"get":{"description":"You can export your [BIND config](https://en.wikipedia.org/wiki/Zone_file \"Zone file\") through this endpoint.\n\nSee [the documentation](https://developers.cloudflare.com/dns/manage-dns-records/how-to/import-and-export/ \"Import and export records\") for more information.","operationId":"dns-records-for-a-zone-export-dns-records","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-zpETYDGh"}}],"responses":{"200":{"content":{"application/json":{"schema":{}}},"description":"Export DNS Records response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Export DNS Records response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Export DNS Records","tags":["DNS Records for a Zone"],"x-cfPermissionsRequired":{"enum":["#dns_records:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/dns_records/import":{"post":{"description":"You can upload your [BIND config](https://en.wikipedia.org/wiki/Zone_file \"Zone file\") through this endpoint. It assumes that cURL is called from a location with bind_config.txt (valid BIND config) present.\n\nSee [the documentation](https://developers.cloudflare.com/dns/manage-dns-records/how-to/import-and-export/ \"Import and export records\") for more information.","operationId":"dns-records-for-a-zone-import-dns-records","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-zpETYDGh"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file":{"description":"BIND config to upload.","example":"@bind_config.txt","type":"string"},"proxied":{"description":"Whether or not proxiable records should receive the performance and security benefits of Cloudflare.","example":false,"type":"boolean"}},"required":["file"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns_response_import_scan"}}},"description":"Import DNS Records response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns_response_import_scan"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Import DNS Records response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Import DNS Records","tags":["DNS Records for a Zone"],"x-cfPermissionsRequired":{"enum":["#dns_records:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/dns_records/scan":{"post":{"description":"Scan for common DNS records on your domain and automatically add them to your zone. Useful if you haven't updated your nameservers yet.","operationId":"dns-records-for-a-zone-scan-dns-records","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-zpETYDGh"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns_response_import_scan"}}},"description":"Scan DNS Records response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns_response_import_scan"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Scan DNS Records response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Scan DNS Records","tags":["DNS Records for a Zone"],"x-cfPermissionsRequired":{"enum":["#dns_records:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/dns_records/{identifier}":{"delete":{"operationId":"dns-records-for-a-zone-delete-dns-record","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-zpETYDGh"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-zpETYDGh"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/identifier-zpETYDGh"}}}},"type":"object"}}},"description":"Delete DNS Record response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/identifier-zpETYDGh"}}}},"type":"object"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete DNS Record response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete DNS Record","tags":["DNS Records for a Zone"],"x-cfPermissionsRequired":{"enum":["#dns_records:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"operationId":"dns-records-for-a-zone-dns-record-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-zpETYDGh"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-zpETYDGh"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns_response_single"}}},"description":"DNS Record Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"DNS Record Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"DNS Record Details","tags":["DNS Records for a Zone"],"x-cfPermissionsRequired":{"enum":["#dns_records:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"operationId":"dns-records-for-a-zone-patch-dns-record","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-zpETYDGh"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-zpETYDGh"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-record"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns_response_single"}}},"description":"Patch DNS Record response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Patch DNS Record response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Patch DNS Record","tags":["DNS Records for a Zone"],"x-cfPermissionsRequired":{"enum":["#dns_records:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"operationId":"dns-records-for-a-zone-update-dns-record","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-zpETYDGh"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-zpETYDGh"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-record"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns_response_single"}}},"description":"Update DNS Record response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dns_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update DNS Record response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update DNS Record","tags":["DNS Records for a Zone"],"x-cfPermissionsRequired":{"enum":["#dns_records:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/dnssec":{"delete":{"description":"Delete DNSSEC.","operationId":"dnssec-delete-dnssec-records","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-smPsQb9r"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/delete_dnssec_response_single"}}},"description":"Delete DNSSEC records response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/delete_dnssec_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete DNSSEC records response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete DNSSEC records","tags":["DNSSEC"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Details about DNSSEC status and configuration.","operationId":"dnssec-dnssec-details","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-smPsQb9r"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dnssec_response_single"}}},"description":"DNSSEC Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dnssec_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"DNSSEC Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"DNSSEC Details","tags":["DNSSEC"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Enable or disable DNSSEC.","operationId":"dnssec-edit-dnssec-status","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-smPsQb9r"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"status":{"description":"Status of DNSSEC, based on user-desired state and presence of necessary records.","enum":["active","disabled"],"example":"active"}},"required":["status"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dnssec_response_single"}}},"description":"Edit DNSSEC Status response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/dnssec_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Edit DNSSEC Status response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Edit DNSSEC Status","tags":["DNSSEC"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/email/routing":{"get":{"description":"Get information about the settings for your Email Routing zone.","operationId":"email-routing-settings-get-email-routing-settings","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-YhmC5GTP"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email-settings_response_single"}}},"description":"Get Email Routing settings response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Email Routing settings","tags":["Email Routing settings"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.zone.email.routing.config.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/email/routing/disable":{"post":{"description":"Disable your Email Routing zone. Also removes additional MX records previously required for Email Routing to work.","operationId":"email-routing-settings-disable-email-routing","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-YhmC5GTP"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email-settings_response_single"}}},"description":"Disable Email Routing response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Disable Email Routing","tags":["Email Routing settings"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.zone.email.routing.config.update"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/email/routing/dns":{"get":{"description":"Show the DNS records needed to configure your Email Routing zone.","operationId":"email-routing-settings-email-routing-dns-settings","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-YhmC5GTP"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-settings_response_collection"}}},"description":"Email Routing - DNS settings response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Email Routing - DNS settings","tags":["Email Routing settings"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.zone.email.routing.config.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/email/routing/enable":{"post":{"description":"Enable you Email Routing zone. Add and lock the necessary MX and SPF records.","operationId":"email-routing-settings-enable-email-routing","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-YhmC5GTP"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/email-settings_response_single"}}},"description":"Enable Email Routing response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Enable Email Routing","tags":["Email Routing settings"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.zone.email.routing.config.update"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/email/routing/rules":{"get":{"description":"Lists existing routing rules.","operationId":"email-routing-routing-rules-list-routing-rules","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-YhmC5GTP"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Maximum number of results per page.","maximum":50,"minimum":5,"type":"number"}},{"in":"query","name":"enabled","schema":{"description":"Filter by enabled routing rules.","enum":[true,false],"example":true,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rules_response_collection-Fgtzw0xK"}}},"description":"List routing rules response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List routing rules","tags":["Email Routing routing rules"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.zone.email.routing.rule.list"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Rules consist of a set of criteria for matching emails (such as an email being sent to a specific custom email address) plus a set of actions to take on the email (like forwarding it to a specific destination address).","operationId":"email-routing-routing-rules-create-routing-rule","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-YhmC5GTP"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_rule_properties"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_response_single-rvlRijjw"}}},"description":"Create routing rule response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create routing rule","tags":["Email Routing routing rules"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.zone.email.routing.rule.create"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/email/routing/rules/catch_all":{"get":{"description":"Get information on the default catch-all routing rule.","operationId":"email-routing-routing-rules-get-catch-all-rule","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-YhmC5GTP"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/catch_all_rule_response_single"}}},"description":"Get catch-all rule response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get catch-all rule","tags":["Email Routing routing rules"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.zone.email.routing.rule.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Enable or disable catch-all routing rule, or change action to forward to specific destination address.","operationId":"email-routing-routing-rules-update-catch-all-rule","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-YhmC5GTP"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_catch_all_rule_properties"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/catch_all_rule_response_single"}}},"description":"Update catch-all rule response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update catch-all rule","tags":["Email Routing routing rules"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.zone.email.routing.rule.update"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/email/routing/rules/{rule_identifier}":{"delete":{"description":"Delete a specific routing rule.","operationId":"email-routing-routing-rules-delete-routing-rule","parameters":[{"in":"path","name":"rule_identifier","required":true,"schema":{"$ref":"#/components/schemas/rule_identifier-wpFBeqHF"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-YhmC5GTP"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_response_single-rvlRijjw"}}},"description":"Delete routing rule response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete routing rule","tags":["Email Routing routing rules"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.zone.email.routing.rule.delete"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Get information for a specific routing rule already created.","operationId":"email-routing-routing-rules-get-routing-rule","parameters":[{"in":"path","name":"rule_identifier","required":true,"schema":{"$ref":"#/components/schemas/rule_identifier-wpFBeqHF"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-YhmC5GTP"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_response_single-rvlRijjw"}}},"description":"Get routing rule response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get routing rule","tags":["Email Routing routing rules"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.zone.email.routing.rule.read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Update actions and matches, or enable/disable specific routing rules.","operationId":"email-routing-routing-rules-update-routing-rule","parameters":[{"in":"path","name":"rule_identifier","required":true,"schema":{"$ref":"#/components/schemas/rule_identifier-wpFBeqHF"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-YhmC5GTP"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_rule_properties"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_response_single-rvlRijjw"}}},"description":"Update routing rule response"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update routing rule","tags":["Email Routing routing rules"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.zone.email.routing.rule.update"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/filters":{"delete":{"description":"Deletes one or more existing filters.","operationId":"filters-delete-filters","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"id":{"$ref":"#/components/schemas/filters_components-schemas-id"}},"required":["id"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filter-delete-response-collection"}}},"description":"Delete filters response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/filter-delete-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete filters response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete filters","tags":["Filters"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Fetches filters in a zone. You can filter the results using several optional parameters.","operationId":"filters-list-filters","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"paused","schema":{"$ref":"#/components/schemas/filters_components-schemas-paused"}},{"in":"query","name":"expression","schema":{"description":"A case-insensitive string to find in the expression.","example":"php","type":"string"}},{"in":"query","name":"description","schema":{"description":"A case-insensitive string to find in the description.","example":"browsers","type":"string"}},{"in":"query","name":"ref","schema":{"description":"The filter ref (a short reference tag) to search for. Must be an exact match.","example":"FIL-100","type":"string"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":25,"description":"Number of filters per page.","maximum":100,"minimum":5,"type":"number"}},{"in":"query","name":"id","schema":{"description":"The unique identifier of the filter.","example":"372e67954025e0ba6aaa6d586b9e0b61","maxLength":32,"minLength":32,"readOnly":true,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-filter-response-collection"}}},"description":"List filters response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-filter-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List filters response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List filters","tags":["Filters"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Creates one or more filters.","operationId":"filters-create-filters","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["expression"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-filter-response-collection"}}},"description":"Create filters response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-filter-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create filters response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create filters","tags":["Filters"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Updates one or more existing filters.","operationId":"filters-update-filters","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["id"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-filter-response-collection"}}},"description":"Update filters response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-filter-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update filters response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update filters","tags":["Filters"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/filters/{id}":{"delete":{"description":"Deletes an existing filter.","operationId":"filters-delete-a-filter","parameters":[{"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/filters_components-schemas-id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filter-delete-response-single"}}},"description":"Delete a filter response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/filter-delete-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete a filter response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete a filter","tags":["Filters"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Fetches the details of a filter.","operationId":"filters-get-a-filter","parameters":[{"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/filters_components-schemas-id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-filter-response-single"}}},"description":"Get a filter response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-filter-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get a filter response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a filter","tags":["Filters"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Updates an existing filter.","operationId":"filters-update-a-filter","parameters":[{"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/filters_components-schemas-id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["id"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-filter-response-single"}}},"description":"Update a filter response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-filter-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update a filter response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update a filter","tags":["Filters"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/firewall/lockdowns":{"get":{"description":"Fetches Zone Lockdown rules. You can filter the results using several optional parameters.","operationId":"zone-lockdown-list-zone-lockdown-rules","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"description","schema":{"$ref":"#/components/schemas/schemas-description_search"}},{"in":"query","name":"modified_on","schema":{"$ref":"#/components/schemas/components-schemas-modified_on"}},{"in":"query","name":"ip","schema":{"$ref":"#/components/schemas/ip_search"}},{"in":"query","name":"priority","schema":{"$ref":"#/components/schemas/lockdowns_components-schemas-priority"}},{"in":"query","name":"uri_search","schema":{"$ref":"#/components/schemas/uri_search"}},{"in":"query","name":"ip_range_search","schema":{"$ref":"#/components/schemas/ip_range_search"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"The maximum number of results per page. You can only set the value to `1` or to a multiple of 5 such as `5`, `10`, `15`, or `20`.","maximum":1000,"minimum":1,"type":"number"}},{"in":"query","name":"created_on","schema":{"description":"The timestamp of when the rule was created.","example":"2014-01-01T05:20:00.12345Z","format":"date-time","readOnly":true,"type":"string"}},{"in":"query","name":"description_search","schema":{"description":"A string to search for in the description of existing rules.","example":"endpoints","type":"string"}},{"in":"query","name":"ip_search","schema":{"description":"A single IP address to search for in existing rules.","example":"1.2.3.4","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zonelockdown_response_collection"}}},"description":"List Zone Lockdown rules response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zonelockdown_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Zone Lockdown rules response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Zone Lockdown rules","tags":["Zone Lockdown"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"post":{"description":"Creates a new Zone Lockdown rule.","operationId":"zone-lockdown-create-a-zone-lockdown-rule","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["urls","configurations"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zonelockdown_response_single"}}},"description":"Create a Zone Lockdown rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zonelockdown_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create a Zone Lockdown rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create a Zone Lockdown rule","tags":["Zone Lockdown"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_identifier}/firewall/lockdowns/{id}":{"delete":{"description":"Deletes an existing Zone Lockdown rule.","operationId":"zone-lockdown-delete-a-zone-lockdown-rule","parameters":[{"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/lockdowns_components-schemas-id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/lockdowns_components-schemas-id"}}}},"type":"object"}}},"description":"Delete a Zone Lockdown rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/lockdowns_components-schemas-id"}}}},"type":"object"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete a Zone Lockdown rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete a Zone Lockdown rule","tags":["Zone Lockdown"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"get":{"description":"Fetches the details of a Zone Lockdown rule.","operationId":"zone-lockdown-get-a-zone-lockdown-rule","parameters":[{"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/lockdowns_components-schemas-id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zonelockdown_response_single"}}},"description":"Get a Zone Lockdown rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zonelockdown_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get a Zone Lockdown rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a Zone Lockdown rule","tags":["Zone Lockdown"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"put":{"description":"Updates an existing Zone Lockdown rule.","operationId":"zone-lockdown-update-a-zone-lockdown-rule","parameters":[{"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/lockdowns_components-schemas-id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["urls","configurations"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zonelockdown_response_single"}}},"description":"Update a Zone Lockdown rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zonelockdown_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update a Zone Lockdown rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update a Zone Lockdown rule","tags":["Zone Lockdown"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_identifier}/firewall/rules":{"delete":{"description":"Deletes existing firewall rules.","operationId":"firewall-rules-delete-firewall-rules","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"id":{"$ref":"#/components/schemas/firewall-rules_components-schemas-id"}},"required":["id"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filter-rules-response-collection-delete"}}},"description":"Delete firewall rules response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/filter-rules-response-collection-delete"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete firewall rules response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete firewall rules","tags":["Firewall rules"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Fetches firewall rules in a zone. You can filter the results using several optional parameters.","operationId":"firewall-rules-list-firewall-rules","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"description","schema":{"description":"A case-insensitive string to find in the description.","example":"mir","type":"string"}},{"in":"query","name":"action","schema":{"description":"The action to search for. Must be an exact match.","example":"block","type":"string"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":25,"description":"Number of firewall rules per page.","maximum":100,"minimum":5,"type":"number"}},{"in":"query","name":"id","schema":{"description":"The unique identifier of the firewall rule.","example":"372e67954025e0ba6aaa6d586b9e0b60","maxLength":32,"readOnly":true,"type":"string"}},{"in":"query","name":"paused","schema":{"description":"When true, indicates that the firewall rule is currently paused.","example":false,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filter-rules-response-collection"}}},"description":"List firewall rules response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/filter-rules-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List firewall rules response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List firewall rules","tags":["Firewall rules"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Updates the priority of existing firewall rules.","operationId":"firewall-rules-update-priority-of-firewall-rules","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["id"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filter-rules-response-collection"}}},"description":"Update priority of firewall rules response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/filter-rules-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update priority of firewall rules response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update priority of firewall rules","tags":["Firewall rules"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Create one or more firewall rules.","operationId":"firewall-rules-create-firewall-rules","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["filter","action"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filter-rules-response-collection"}}},"description":"Create firewall rules response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/filter-rules-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create firewall rules response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create firewall rules","tags":["Firewall rules"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Updates one or more existing firewall rules.","operationId":"firewall-rules-update-firewall-rules","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["id"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filter-rules-response-collection"}}},"description":"Update firewall rules response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/filter-rules-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update firewall rules response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update firewall rules","tags":["Firewall rules"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/firewall/rules/{id}":{"delete":{"description":"Deletes an existing firewall rule.","operationId":"firewall-rules-delete-a-firewall-rule","parameters":[{"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/firewall-rules_components-schemas-id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"delete_filter_if_unused":{"$ref":"#/components/schemas/delete_filter_if_unused"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filter-rules-single-response-delete"}}},"description":"Delete a firewall rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/filter-rules-single-response-delete"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete a firewall rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete a firewall rule","tags":["Firewall rules"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Fetches the details of a firewall rule.","operationId":"firewall-rules-get-a-firewall-rule","parameters":[{"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/firewall-rules_components-schemas-id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"id","schema":{"$ref":"#/components/schemas/firewall-rules_components-schemas-id"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filter-rules-single-response"}}},"description":"Get a firewall rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/filter-rules-single-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get a firewall rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a firewall rule","tags":["Firewall rules"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Updates the priority of an existing firewall rule.","operationId":"firewall-rules-update-priority-of-a-firewall-rule","parameters":[{"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/firewall-rules_components-schemas-id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["id"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filter-rules-response-collection"}}},"description":"Update priority of a firewall rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/filter-rules-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update priority of a firewall rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update priority of a firewall rule","tags":["Firewall rules"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Updates an existing firewall rule.","operationId":"firewall-rules-update-a-firewall-rule","parameters":[{"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/firewall-rules_components-schemas-id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["id","filter","action"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filter-rules-single-response"}}},"description":"Update a firewall rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/filter-rules-single-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update a firewall rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update a firewall rule","tags":["Firewall rules"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/firewall/ua_rules":{"get":{"description":"Fetches User Agent Blocking rules in a zone. You can filter the results using several optional parameters.","operationId":"user-agent-blocking-rules-list-user-agent-blocking-rules","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"description","schema":{"$ref":"#/components/schemas/description_search"}},{"in":"query","name":"description_search","schema":{"$ref":"#/components/schemas/description_search"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"The maximum number of results per page. You can only set the value to `1` or to a multiple of 5 such as `5`, `10`, `15`, or `20`.","maximum":1000,"minimum":1,"type":"number"}},{"in":"query","name":"ua_search","schema":{"description":"A string to search for in the user agent values of existing rules.","example":"Safari","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewalluablock_response_collection"}}},"description":"List User Agent Blocking rules response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewalluablock_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List User Agent Blocking rules response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List User Agent Blocking rules","tags":["User Agent Blocking rules"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Creates a new User Agent Blocking rule in a zone.","operationId":"user-agent-blocking-rules-create-a-user-agent-blocking-rule","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["mode","configuration"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewalluablock_response_single"}}},"description":"Create a User Agent Blocking rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewalluablock_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create a User Agent Blocking rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create a User Agent Blocking rule","tags":["User Agent Blocking rules"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/firewall/ua_rules/{id}":{"delete":{"description":"Deletes an existing User Agent Blocking rule.","operationId":"user-agent-blocking-rules-delete-a-user-agent-blocking-rule","parameters":[{"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/ua-rules_components-schemas-id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewalluablock_response_single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/ua-rules_components-schemas-id"}}}},"type":"object"}]}}},"description":"Delete a User Agent Blocking rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/firewalluablock_response_single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/ua-rules_components-schemas-id"}}}},"type":"object"}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete a User Agent Blocking rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete a User Agent Blocking rule","tags":["User Agent Blocking rules"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Fetches the details of a User Agent Blocking rule.","operationId":"user-agent-blocking-rules-get-a-user-agent-blocking-rule","parameters":[{"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/ua-rules_components-schemas-id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewalluablock_response_single"}}},"description":"Get a User Agent Blocking rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewalluablock_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get a User Agent Blocking rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a User Agent Blocking rule","tags":["User Agent Blocking rules"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Updates an existing User Agent Blocking rule.","operationId":"user-agent-blocking-rules-update-a-user-agent-blocking-rule","parameters":[{"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/ua-rules_components-schemas-id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["id","mode","configuration"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/firewalluablock_response_single"}}},"description":"Update a User Agent Blocking rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/firewalluablock_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update a User Agent Blocking rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update a User Agent Blocking rule","tags":["User Agent Blocking rules"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/firewall/waf/overrides":{"get":{"description":"Fetches the URI-based WAF overrides in a zone.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).","operationId":"waf-overrides-list-waf-overrides","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"page","schema":{"default":1,"description":"The page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":50,"description":"The number of WAF overrides per page.","maximum":100,"minimum":5,"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/override_response_collection"}}},"description":"List WAF overrides response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/override_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List WAF overrides response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List WAF overrides","tags":["WAF overrides"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Creates a URI-based WAF override for a zone.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).","operationId":"waf-overrides-create-a-waf-override","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["urls"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/override_response_single"}}},"description":"Create a WAF override response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/override_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create a WAF override response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create a WAF override","tags":["WAF overrides"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/firewall/waf/overrides/{id}":{"delete":{"description":"Deletes an existing URI-based WAF override.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).","operationId":"waf-overrides-delete-a-waf-override","parameters":[{"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/overrides_components-schemas-id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/overrides_components-schemas-id"}}}},"type":"object"}}},"description":"Delete a WAF override response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/overrides_components-schemas-id"}}}},"type":"object"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete a WAF override response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete a WAF override","tags":["WAF overrides"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Fetches the details of a URI-based WAF override.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).","operationId":"waf-overrides-get-a-waf-override","parameters":[{"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/overrides_components-schemas-id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/override_response_single"}}},"description":"Get a WAF override response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/override_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get a WAF override response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a WAF override","tags":["WAF overrides"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Updates an existing URI-based WAF override.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).","operationId":"waf-overrides-update-waf-override","parameters":[{"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/overrides_components-schemas-id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["id","urls","rules","rewrite_action"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/override_response_single"}}},"description":"Update WAF override response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/override_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update WAF override response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update WAF override","tags":["WAF overrides"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/firewall/waf/packages":{"get":{"description":"Fetches WAF packages for a zone.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).","operationId":"waf-packages-list-waf-packages","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"page","schema":{"default":1,"description":"The page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":50,"description":"The number of packages per page.","maximum":100,"minimum":5,"type":"number"}},{"in":"query","name":"order","schema":{"description":"The field used to sort returned packages.","enum":["name"],"example":"status","type":"string"}},{"in":"query","name":"direction","schema":{"description":"The direction used to sort returned packages.","enum":["asc","desc"],"example":"desc","type":"string"}},{"in":"query","name":"match","schema":{"default":"all","description":"When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match.","enum":["any","all"],"type":"string"}},{"in":"query","name":"name","schema":{"description":"The name of the WAF package.","example":"USER","readOnly":true,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/package_response_collection"}}},"description":"List WAF packages response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/package_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List WAF packages response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List WAF packages","tags":["WAF packages"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_identifier}/firewall/waf/packages/{identifier}":{"get":{"description":"Fetches the details of a WAF package.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).","operationId":"waf-packages-get-a-waf-package","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/package_components-schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/package_response_single"}}},"description":"Get a WAF package response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/package_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get a WAF package response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a WAF package","tags":["WAF packages"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"patch":{"description":"Updates a WAF package. You can update the sensitivity and the action of an anomaly detection WAF package.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).","operationId":"waf-packages-update-a-waf-package","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/package_components-schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"action_mode":{"$ref":"#/components/schemas/action_mode"},"sensitivity":{"$ref":"#/components/schemas/sensitivity"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/package_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/anomaly_package"}}}]}}},"description":"Update a WAF package response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/package_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/anomaly_package"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update a WAF package response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update a WAF package","tags":["WAF packages"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_identifier}/firewall/waf/packages/{package_identifier}/groups":{"get":{"description":"Fetches the WAF rule groups in a WAF package.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).","operationId":"waf-rule-groups-list-waf-rule-groups","parameters":[{"in":"path","name":"package_identifier","required":true,"schema":{"$ref":"#/components/schemas/package_components-schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"mode","schema":{"$ref":"#/components/schemas/components-schemas-mode"}},{"in":"query","name":"page","schema":{"default":1,"description":"The page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":50,"description":"The number of rule groups per page.","maximum":100,"minimum":5,"type":"number"}},{"in":"query","name":"order","schema":{"description":"The field used to sort returned rule groups.","enum":["mode","rules_count"],"example":"mode"}},{"in":"query","name":"direction","schema":{"description":"The direction used to sort returned rule groups.","enum":["asc","desc"],"example":"desc"}},{"in":"query","name":"match","schema":{"default":"all","description":"When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match.","enum":["any","all"]}},{"in":"query","name":"name","schema":{"description":"The name of the rule group.","example":"Project Honey Pot","readOnly":true,"type":"string"}},{"in":"query","name":"rules_count","schema":{"default":0,"description":"The number of rules in the current rule group.","example":10,"readOnly":true,"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_group_response_collection"}}},"description":"List WAF rule groups response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rule_group_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List WAF rule groups response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List WAF rule groups","tags":["WAF rule groups"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_identifier}/firewall/waf/packages/{package_identifier}/groups/{identifier}":{"get":{"description":"Fetches the details of a WAF rule group.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).","operationId":"waf-rule-groups-get-a-waf-rule-group","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/group_components-schemas-identifier"}},{"in":"path","name":"package_identifier","required":true,"schema":{"$ref":"#/components/schemas/package_components-schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_group_response_single"}}},"description":"Get a WAF rule group response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rule_group_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get a WAF rule group response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a WAF rule group","tags":["WAF rule groups"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"patch":{"description":"Updates a WAF rule group. You can update the state (`mode` parameter) of a rule group.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).","operationId":"waf-rule-groups-update-a-waf-rule-group","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/group_components-schemas-identifier"}},{"in":"path","name":"package_identifier","required":true,"schema":{"$ref":"#/components/schemas/package_components-schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"mode":{"$ref":"#/components/schemas/components-schemas-mode"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_group_response_single"}}},"description":"Update a WAF rule group response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rule_group_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update a WAF rule group response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update a WAF rule group","tags":["WAF rule groups"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_identifier}/healthchecks":{"get":{"description":"List configured health checks.","operationId":"health-checks-list-health-checks","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Kg4WBtjI"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_collection-MecJdTin"}}},"description":"List Health Checks response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_collection-MecJdTin"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Health Checks response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Health Checks","tags":["Health Checks"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"post":{"description":"Create a new health check.","operationId":"health-checks-create-health-check","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Kg4WBtjI"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/query_healthcheck"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response-JiiItTpX"}}},"description":"Create Health Check response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response-JiiItTpX"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Health Check response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Health Check","tags":["Health Checks"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_identifier}/healthchecks/preview":{"post":{"description":"Create a new preview health check.","operationId":"health-checks-create-preview-health-check","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Kg4WBtjI"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/query_healthcheck"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response-JiiItTpX"}}},"description":"Create Preview Health Check response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response-JiiItTpX"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Preview Health Check response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Preview Health Check","tags":["Health Checks"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_identifier}/healthchecks/preview/{identifier}":{"delete":{"description":"Delete a health check.","operationId":"health-checks-delete-preview-health-check","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Kg4WBtjI"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Kg4WBtjI"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/id_response"}}},"description":"Delete Preview Health Check response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Preview Health Check response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Preview Health Check","tags":["Health Checks"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"get":{"description":"Fetch a single configured health check preview.","operationId":"health-checks-health-check-preview-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Kg4WBtjI"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Kg4WBtjI"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response-JiiItTpX"}}},"description":"Health Check Preview Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response-JiiItTpX"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Health Check Preview Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Health Check Preview Details","tags":["Health Checks"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_identifier}/healthchecks/{identifier}":{"delete":{"description":"Delete a health check.","operationId":"health-checks-delete-health-check","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Kg4WBtjI"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Kg4WBtjI"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/id_response"}}},"description":"Delete Health Check response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Health Check response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Health Check","tags":["Health Checks"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"get":{"description":"Fetch a single configured health check.","operationId":"health-checks-health-check-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Kg4WBtjI"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Kg4WBtjI"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response-JiiItTpX"}}},"description":"Health Check Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response-JiiItTpX"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Health Check Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Health Check Details","tags":["Health Checks"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"patch":{"description":"Patch a configured health check.","operationId":"health-checks-patch-health-check","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Kg4WBtjI"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Kg4WBtjI"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/query_healthcheck"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response-JiiItTpX"}}},"description":"Patch Health Check response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response-JiiItTpX"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Patch Health Check response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Patch Health Check","tags":["Health Checks"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"put":{"description":"Update a configured health check.","operationId":"health-checks-update-health-check","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Kg4WBtjI"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Kg4WBtjI"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/query_healthcheck"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response-JiiItTpX"}}},"description":"Update Health Check response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response-JiiItTpX"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Health Check response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Health Check","tags":["Health Checks"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_identifier}/keyless_certificates":{"get":{"description":"List all Keyless SSL configurations for a given zone.","operationId":"keyless-ssl-for-a-zone-list-keyless-ssl-configurations","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/keyless_response_collection"}}},"description":"List Keyless SSL Configurations response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/keyless_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Keyless SSL Configurations response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Keyless SSL Configurations","tags":["Keyless SSL for a Zone"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"operationId":"keyless-ssl-for-a-zone-create-keyless-ssl-configuration","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"bundle_method":{"$ref":"#/components/schemas/bundle_method"},"certificate":{"$ref":"#/components/schemas/schemas-certificate"},"host":{"$ref":"#/components/schemas/schemas-host"},"name":{"$ref":"#/components/schemas/keyless-certificate_components-schemas-name"},"port":{"$ref":"#/components/schemas/port-0Rcq4sy6"}},"required":["host","port","certificate"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/keyless_response_single-D6V6oKzw"}}},"description":"Create Keyless SSL Configuration response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/keyless_response_single-D6V6oKzw"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Keyless SSL Configuration response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Keyless SSL Configuration","tags":["Keyless SSL for a Zone"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/keyless_certificates/{identifier}":{"delete":{"operationId":"keyless-ssl-for-a-zone-delete-keyless-ssl-configuration","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/keyless-certificate_components-schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/keyless_response_single_id-oOZ29VcY"}}},"description":"Delete Keyless SSL Configuration response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/keyless_response_single_id-oOZ29VcY"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Keyless SSL Configuration response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Keyless SSL Configuration","tags":["Keyless SSL for a Zone"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Get details for one Keyless SSL configuration.","operationId":"keyless-ssl-for-a-zone-get-keyless-ssl-configuration","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/keyless-certificate_components-schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/keyless_response_single-D6V6oKzw"}}},"description":"Get Keyless SSL Configuration response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/keyless_response_single-D6V6oKzw"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Keyless SSL Configuration response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Keyless SSL Configuration","tags":["Keyless SSL for a Zone"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"patch":{"description":"This will update attributes of a Keyless SSL. Consists of one or more of the following: host,name,port,certificate,enabled.","operationId":"keyless-ssl-for-a-zone-edit-keyless-ssl-configuration","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/keyless-certificate_components-schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"enabled":{"$ref":"#/components/schemas/enabled-mOUbjYfQ"},"host":{"$ref":"#/components/schemas/schemas-host"},"name":{"$ref":"#/components/schemas/keyless-certificate_components-schemas-name"},"port":{"$ref":"#/components/schemas/port-0Rcq4sy6"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/keyless_response_single-D6V6oKzw"}}},"description":"Edit Keyless SSL Configuration response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/keyless_response_single-D6V6oKzw"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Edit Keyless SSL Configuration response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Edit Keyless SSL Configuration","tags":["Keyless SSL for a Zone"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/logpush/datasets/{dataset}/fields":{"get":{"description":"Lists all fields available for a dataset. The response result is an object with key-value pairs, where keys are field names, and values are descriptions.","operationId":"get-zones-zone_identifier-logpush-datasets-dataset-fields","parameters":[{"in":"path","name":"dataset","required":true,"schema":{"$ref":"#/components/schemas/dataset"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Gw95Cj70"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logpush_field_response_collection"}}},"description":"List fields response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_field_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List fields response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List fields","tags":["Logpush jobs for a zone"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/logpush/datasets/{dataset}/jobs":{"get":{"description":"Lists Logpush jobs for a zone for a dataset.","operationId":"get-zones-zone_identifier-logpush-datasets-dataset-jobs","parameters":[{"in":"path","name":"dataset","required":true,"schema":{"$ref":"#/components/schemas/dataset"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Gw95Cj70"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logpush_job_response_collection"}}},"description":"List Logpush jobs for a dataset response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_job_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Logpush jobs for a dataset response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Logpush jobs for a dataset","tags":["Logpush jobs for a zone"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/logpush/edge":{"get":{"description":"Lists Instant Logs jobs for a zone.","operationId":"get-zones-zone_identifier-logpush-edge-jobs","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Gw95Cj70"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/instant_logs_job_response_collection"}}},"description":"List Instant Logs jobs response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/instant_logs_job_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Instant Logs jobs response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Instant Logs jobs","tags":["Instant Logs jobs for a zone"],"x-cfPermissionsRequired":{"enum":["#logs:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Creates a new Instant Logs job for a zone.","operationId":"post-zones-zone_identifier-logpush-edge-jobs","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Gw95Cj70"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"fields":{"$ref":"#/components/schemas/fields"},"filter":{"$ref":"#/components/schemas/filter"},"sample":{"$ref":"#/components/schemas/sample"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/instant_logs_job_response_single"}}},"description":"Create Instant Logs job response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/instant_logs_job_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Instant Logs job response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Instant Logs job","tags":["Instant Logs jobs for a zone"],"x-cfPermissionsRequired":{"enum":["#logs:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/logpush/jobs":{"get":{"description":"Lists Logpush jobs for a zone.","operationId":"get-zones-zone_identifier-logpush-jobs","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Gw95Cj70"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logpush_job_response_collection"}}},"description":"List Logpush jobs response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_job_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Logpush jobs response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Logpush jobs","tags":["Logpush jobs for a zone"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Creates a new Logpush job for a zone.","operationId":"post-zones-zone_identifier-logpush-jobs","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Gw95Cj70"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"dataset":{"$ref":"#/components/schemas/dataset"},"destination_conf":{"$ref":"#/components/schemas/destination_conf"},"enabled":{"$ref":"#/components/schemas/enabled-A6pti18n"},"frequency":{"$ref":"#/components/schemas/frequency"},"logpull_options":{"$ref":"#/components/schemas/logpull_options"},"name":{"$ref":"#/components/schemas/name-rRqaJzmt"},"ownership_challenge":{"$ref":"#/components/schemas/ownership_challenge"}},"required":["destination_conf"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logpush_job_response_single"}}},"description":"Create Logpush job response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_job_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Logpush job response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Logpush job","tags":["Logpush jobs for a zone"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/logpush/jobs/{job_identifier}":{"delete":{"description":"Deletes a Logpush job.","operationId":"delete-zones-zone_identifier-logpush-jobs-job_identifier","parameters":[{"in":"path","name":"job_identifier","required":true,"schema":{"$ref":"#/components/schemas/id-Un5diNDY"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Gw95Cj70"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"example":{},"nullable":true,"type":"object"}}}]}}},"description":"Delete Logpush job response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"example":{},"nullable":true,"type":"object"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Logpush job response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Logpush job","tags":["Logpush jobs for a zone"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Gets the details of a Logpush job.","operationId":"get-zones-zone_identifier-logpush-jobs-job_identifier","parameters":[{"in":"path","name":"job_identifier","required":true,"schema":{"$ref":"#/components/schemas/id-Un5diNDY"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Gw95Cj70"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logpush_job_response_single"}}},"description":"Get Logpush job details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_job_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Logpush job details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Logpush job details","tags":["Logpush jobs for a zone"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Updates a Logpush job.","operationId":"put-zones-zone_identifier-logpush-jobs-job_identifier","parameters":[{"in":"path","name":"job_identifier","required":true,"schema":{"$ref":"#/components/schemas/id-Un5diNDY"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Gw95Cj70"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"destination_conf":{"$ref":"#/components/schemas/destination_conf"},"enabled":{"$ref":"#/components/schemas/enabled-A6pti18n"},"frequency":{"$ref":"#/components/schemas/frequency"},"logpull_options":{"$ref":"#/components/schemas/logpull_options"},"ownership_challenge":{"$ref":"#/components/schemas/ownership_challenge"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logpush_job_response_single"}}},"description":"Update Logpush job response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logpush_job_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Logpush job response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Logpush job","tags":["Logpush jobs for a zone"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/logpush/ownership":{"post":{"description":"Gets a new ownership challenge sent to your destination.","operationId":"post-zones-zone_identifier-logpush-ownership","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Gw95Cj70"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"destination_conf":{"$ref":"#/components/schemas/destination_conf"}},"required":["destination_conf"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get_ownership_response"}}},"description":"Get ownership challenge response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/get_ownership_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get ownership challenge response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get ownership challenge","tags":["Logpush jobs for a zone"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/logpush/ownership/validate":{"post":{"description":"Validates ownership challenge of the destination.","operationId":"post-zones-zone_identifier-logpush-ownership-validate","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Gw95Cj70"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"destination_conf":{"$ref":"#/components/schemas/destination_conf"},"ownership_challenge":{"$ref":"#/components/schemas/ownership_challenge"}},"required":["destination_conf","ownership_challenge"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/validate_ownership_response"}}},"description":"Validate ownership challenge response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/validate_ownership_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Validate ownership challenge response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Validate ownership challenge","tags":["Logpush jobs for a zone"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/logpush/validate/destination/exists":{"post":{"description":"Checks if there is an existing job with a destination.","operationId":"post-zones-zone_identifier-logpush-validate-destination-exists","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Gw95Cj70"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"destination_conf":{"$ref":"#/components/schemas/destination_conf"}},"required":["destination_conf"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/destination_exists_response"}}},"description":"Check destination exists response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/destination_exists_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Check destination exists response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Check destination exists","tags":["Logpush jobs for a zone"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/logpush/validate/origin":{"post":{"description":"Validates logpull origin with logpull_options.","operationId":"post-zones-zone_identifier-logpush-validate-origin","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-Gw95Cj70"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"logpull_options":{"$ref":"#/components/schemas/logpull_options"}},"required":["logpull_options"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/validate_response-PaQpkUV3"}}},"description":"Validate origin response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/validate_response-PaQpkUV3"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Validate origin response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Validate origin","tags":["Logpush jobs for a zone"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/logs/control/retention/flag":{"get":{"description":"Gets log retention flag for Logpull API.","operationId":"logs-received-get-log-retention-flag","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/flag_response"}}},"description":"Get log retention flag response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/flag_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get log retention flag response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get log retention flag","tags":["Logs Received"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Updates log retention flag for Logpull API.","operationId":"logs-received-update-log-retention-flag","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"flag":{"$ref":"#/components/schemas/flag"}},"required":["flag"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/flag_response"}}},"description":"Update log retention flag response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/flag_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update log retention flag response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update log retention flag","tags":["Logs Received"],"x-cfPermissionsRequired":{"enum":["#logs:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/logs/rayids/{ray_identifier}":{"get":{"description":"The `/rayids` api route allows lookups by specific rayid. The rayids route will return zero, one, or more records (ray ids are not unique).","operationId":"logs-received-get-logs-ray-i-ds","parameters":[{"in":"path","name":"ray_identifier","required":true,"schema":{"$ref":"#/components/schemas/ray_identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"timestamps","schema":{"$ref":"#/components/schemas/timestamps"}},{"in":"query","name":"fields","schema":{"description":"The `/received` route by default returns a limited set of fields, and allows customers to override the default field set by specifying individual fields. The reasons for this are: 1. Most customers require only a small subset of fields, but that subset varies from customer to customer; 2. Flat schema is much easier to work with downstream (importing into BigTable etc); 3. Performance (time to process, file size). If `?fields=` is not specified, default field set is returned. This default field set may change at any time. When `?fields=` is provided, each record is returned with the specified fields. `fields` must be specified as a comma separated list without any whitespaces, and all fields must exist. The order in which fields are specified does not matter, and the order of fields in the response is not specified.","example":"ClientIP,RayID,EdgeStartTimestamp","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logs"}}},"description":"Get logs RayIDs response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logs"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get logs RayIDs response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get logs RayIDs","tags":["Logs Received"],"x-cfPermissionsRequired":{"enum":["#logs:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/logs/received":{"get":{"description":"The `/received` api route allows customers to retrieve their edge HTTP logs. The basic access pattern is \"give me all the logs for zone Z for minute M\", where the minute M refers to the time records were received at Cloudflare's central data center. `start` is inclusive, and `end` is exclusive. Because of that, to get all data, at minutely cadence, starting at 10AM, the proper values are: `start=2018-05-20T10:00:00Z\u0026end=2018-05-20T10:01:00Z`, then `start=2018-05-20T10:01:00Z\u0026end=2018-05-20T10:02:00Z` and so on; the overlap will be handled properly.","operationId":"logs-received-get-logs-received","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"end","required":true,"schema":{"$ref":"#/components/schemas/end"}},{"in":"query","name":"sample","schema":{"$ref":"#/components/schemas/sample-qlwBkrnD"}},{"in":"query","name":"timestamps","schema":{"$ref":"#/components/schemas/timestamps"}},{"in":"query","name":"count","schema":{"description":"When `?count=` is provided, the response will contain up to `count` results. Since results are not sorted, you are likely to get different data for repeated requests. `count` must be an integer \u003e 0.","minimum":1,"type":"integer"}},{"in":"query","name":"fields","schema":{"description":"The `/received` route by default returns a limited set of fields, and allows customers to override the default field set by specifying individual fields. The reasons for this are: 1. Most customers require only a small subset of fields, but that subset varies from customer to customer; 2. Flat schema is much easier to work with downstream (importing into BigTable etc); 3. Performance (time to process, file size). If `?fields=` is not specified, default field set is returned. This default field set may change at any time. When `?fields=` is provided, each record is returned with the specified fields. `fields` must be specified as a comma separated list without any whitespaces, and all fields must exist. The order in which fields are specified does not matter, and the order of fields in the response is not specified.","example":"ClientIP,RayID,EdgeStartTimestamp","type":"string"}},{"in":"query","name":"start","schema":{"anyOf":[{"type":"string"},{"type":"integer"}],"description":"Sets the (inclusive) beginning of the requested time frame. This can be a unix timestamp (in seconds or nanoseconds), or an absolute timestamp that conforms to RFC 3339. At this point in time, it cannot exceed a time in the past greater than seven days.","example":"2018-05-20T10:00:00Z"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logs"}}},"description":"Get logs received response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/logs"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get logs received response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get logs received","tags":["Logs Received"],"x-cfPermissionsRequired":{"enum":["#logs:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/logs/received/fields":{"get":{"description":"Lists all fields available. The response is json object with key-value pairs, where keys are field names, and values are descriptions.","operationId":"logs-received-list-fields","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/fields_response"}}},"description":"List fields response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/fields_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List fields response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List fields","tags":["Logs Received"],"x-cfPermissionsRequired":{"enum":["#logs:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/origin_tls_client_auth":{"get":{"operationId":"zone-level-authenticated-origin-pulls-list-certificates","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-certificate_response_collection"}}},"description":"List Certificates response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-certificate_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Certificates response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Certificates","tags":["Zone-Level Authenticated Origin Pulls"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Upload your own certificate you want Cloudflare to use for edge-to-origin communication to override the shared certificate. Please note that it is important to keep only one certificate active. Also, make sure to enable zone-level authenticated origin pulls by making a PUT call to settings endpoint to see the uploaded certificate in use.","operationId":"zone-level-authenticated-origin-pulls-upload-certificate","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"certificate":{"$ref":"#/components/schemas/zone-authenticated-origin-pull_components-schemas-certificate"},"private_key":{"$ref":"#/components/schemas/private_key"}},"required":["certificate","private_key"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificate_response_single"}}},"description":"Upload Certificate response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificate_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Upload Certificate response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Upload Certificate","tags":["Zone-Level Authenticated Origin Pulls"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/origin_tls_client_auth/hostnames":{"put":{"description":"Associate a hostname to a certificate and enable, disable or invalidate the association. If disabled, client certificate will not be sent to the hostname even if activated at the zone level. 100 maximum associations on a single certificate are allowed. Note: Use a null value for parameter *enabled* to invalidate the association.","operationId":"per-hostname-authenticated-origin-pull-enable-or-disable-a-hostname-for-client-authentication","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"config":{"$ref":"#/components/schemas/config"}},"required":["config"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hostname_aop_response_collection"}}},"description":"Enable or Disable a Hostname for Client Authentication response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/hostname_aop_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Enable or Disable a Hostname for Client Authentication response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Enable or Disable a Hostname for Client Authentication","tags":["Per-hostname Authenticated Origin Pull"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/origin_tls_client_auth/hostnames/certificates":{"get":{"operationId":"per-hostname-authenticated-origin-pull-list-certificates","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate_response_collection"}}},"description":"List Certificates response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Certificates response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Certificates","tags":["Per-hostname Authenticated Origin Pull"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Upload a certificate to be used for client authentication on a hostname. 10 hostname certificates per zone are allowed.","operationId":"per-hostname-authenticated-origin-pull-upload-a-hostname-client-certificate","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"certificate":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate"},"private_key":{"$ref":"#/components/schemas/schemas-private_key"}},"required":["certificate","private_key"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-certificate_response_single"}}},"description":"Upload a Hostname Client Certificate response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-certificate_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Upload a Hostname Client Certificate response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Upload a Hostname Client Certificate","tags":["Per-hostname Authenticated Origin Pull"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/origin_tls_client_auth/hostnames/certificates/{identifier}":{"delete":{"operationId":"per-hostname-authenticated-origin-pull-delete-hostname-client-certificate","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-certificate_response_single"}}},"description":"Delete Hostname Client Certificate response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-certificate_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Hostname Client Certificate response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Hostname Client Certificate","tags":["Per-hostname Authenticated Origin Pull"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Get the certificate by ID to be used for client authentication on a hostname.","operationId":"per-hostname-authenticated-origin-pull-get-the-hostname-client-certificate","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-certificate_response_single"}}},"description":"Get the Hostname Client Certificate response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-certificate_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get the Hostname Client Certificate response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get the Hostname Client Certificate","tags":["Per-hostname Authenticated Origin Pull"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/origin_tls_client_auth/hostnames/{hostname}":{"get":{"operationId":"per-hostname-authenticated-origin-pull-get-the-hostname-status-for-client-authentication","parameters":[{"in":"path","name":"hostname","required":true,"schema":{"$ref":"#/components/schemas/schemas-hostname"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hostname_aop_single_response"}}},"description":"Get the Hostname Status for Client Authentication response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/hostname_aop_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get the Hostname Status for Client Authentication response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get the Hostname Status for Client Authentication","tags":["Per-hostname Authenticated Origin Pull"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/origin_tls_client_auth/settings":{"get":{"description":"Get whether zone-level authenticated origin pulls is enabled or not. It is false by default.","operationId":"zone-level-authenticated-origin-pulls-get-enablement-setting-for-zone","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/enabled_response"}}},"description":"Get Enablement Setting for Zone response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/enabled_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Enablement Setting for Zone response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Enablement Setting for Zone","tags":["Zone-Level Authenticated Origin Pulls"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Enable or disable zone-level authenticated origin pulls. 'enabled' should be set true either before/after the certificate is uploaded to see the certificate in use.","operationId":"zone-level-authenticated-origin-pulls-set-enablement-for-zone","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"enabled":{"$ref":"#/components/schemas/zone-authenticated-origin-pull_components-schemas-enabled"}},"required":["enabled"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/enabled_response"}}},"description":"Set Enablement for Zone response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/enabled_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Set Enablement for Zone response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Set Enablement for Zone","tags":["Zone-Level Authenticated Origin Pulls"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/origin_tls_client_auth/{identifier}":{"delete":{"operationId":"zone-level-authenticated-origin-pulls-delete-certificate","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/zone-authenticated-origin-pull_components-schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificate_response_single"}}},"description":"Delete Certificate response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificate_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Certificate response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Certificate","tags":["Zone-Level Authenticated Origin Pulls"],"x-cfPermissionsRequired":{"enum":["#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"operationId":"zone-level-authenticated-origin-pulls-get-certificate-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/zone-authenticated-origin-pull_components-schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificate_response_single"}}},"description":"Get Certificate Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificate_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Certificate Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Certificate Details","tags":["Zone-Level Authenticated Origin Pulls"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/pagerules":{"get":{"description":"Fetches Page Rules in a zone.","operationId":"page-rules-list-page-rules","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}},{"in":"query","name":"order","schema":{"default":"priority","description":"The field used to sort returned Page Rules.","enum":["status","priority"],"example":"status","type":"string"}},{"in":"query","name":"direction","schema":{"default":"desc","description":"The direction used to sort returned Page Rules.","enum":["asc","desc"],"example":"desc","type":"string"}},{"in":"query","name":"match","schema":{"default":"all","description":"When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match.","enum":["any","all"],"type":"string"}},{"in":"query","name":"status","schema":{"default":"disabled","description":"The status of the Page Rule.","enum":["active","disabled"],"example":"active","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pagerule_response_collection"}}},"description":"List Page Rules response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pagerule_response_collection"},{"$ref":"#/components/schemas/schemas-api-response-common-failure"}]}}},"description":"List Page Rules response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Page Rules","tags":["Page Rules"],"x-cfPermissionsRequired":{"enum":["#zone:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Creates a new Page Rule.","operationId":"page-rules-create-a-page-rule","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"actions":{"$ref":"#/components/schemas/actions"},"priority":{"$ref":"#/components/schemas/priority-21tFu5p5"},"status":{"$ref":"#/components/schemas/status-cnKVAn0b"},"targets":{"$ref":"#/components/schemas/targets"}},"required":["targets","actions"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pagerule_response_single"}}},"description":"Create a Page Rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pagerule_response_single"},{"$ref":"#/components/schemas/schemas-api-response-common-failure"}]}}},"description":"Create a Page Rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create a Page Rule","tags":["Page Rules"],"x-cfPermissionsRequired":{"enum":["#zone:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/pagerules/settings":{"get":{"description":"Returns a list of settings (and their details) that Page Rules can apply to matching requests.","operationId":"available-page-rules-settings-list-available-page-rules-settings","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pagerule_settings_response_collection"}}},"description":"List available Page Rules settings response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pagerule_settings_response_collection"},{"$ref":"#/components/schemas/schemas-api-response-common-failure"}]}}},"description":"List available Page Rules settings response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List available Page Rules settings","tags":["Available Page Rules settings"],"x-cfPermissionsRequired":{"enum":["#zone:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/pagerules/{identifier}":{"delete":{"description":"Deletes an existing Page Rule.","operationId":"page-rules-delete-a-page-rule","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-api-response-single-id"}}},"description":"Delete a Page Rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-api-response-single-id"},{"$ref":"#/components/schemas/schemas-api-response-common-failure"}]}}},"description":"Delete a Page Rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete a Page Rule","tags":["Page Rules"],"x-cfPermissionsRequired":{"enum":["#zone:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Fetches the details of a Page Rule.","operationId":"page-rules-get-a-page-rule","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pagerule_response_single"}}},"description":"Get a Page Rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pagerule_response_single"},{"$ref":"#/components/schemas/schemas-api-response-common-failure"}]}}},"description":"Get a Page Rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a Page Rule","tags":["Page Rules"],"x-cfPermissionsRequired":{"enum":["#zone:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Updates one or more fields of an existing Page Rule.","operationId":"page-rules-edit-a-page-rule","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"actions":{"$ref":"#/components/schemas/actions"},"priority":{"$ref":"#/components/schemas/priority-21tFu5p5"},"status":{"$ref":"#/components/schemas/status-cnKVAn0b"},"targets":{"$ref":"#/components/schemas/targets"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pagerule_response_single"}}},"description":"Edit a Page Rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pagerule_response_single"},{"$ref":"#/components/schemas/schemas-api-response-common-failure"}]}}},"description":"Edit a Page Rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Edit a Page Rule","tags":["Page Rules"],"x-cfPermissionsRequired":{"enum":["#zone:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Replaces the configuration of an existing Page Rule. The configuration of the updated Page Rule will exactly match the data passed in the API request.","operationId":"page-rules-update-a-page-rule","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"actions":{"$ref":"#/components/schemas/actions"},"priority":{"$ref":"#/components/schemas/priority-21tFu5p5"},"status":{"$ref":"#/components/schemas/status-cnKVAn0b"},"targets":{"$ref":"#/components/schemas/targets"}},"required":["targets","actions"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pagerule_response_single"}}},"description":"Update a Page Rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/pagerule_response_single"},{"$ref":"#/components/schemas/schemas-api-response-common-failure"}]}}},"description":"Update a Page Rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update a Page Rule","tags":["Page Rules"],"x-cfPermissionsRequired":{"enum":["#zone:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/railguns":{"get":{"description":"A list of available Railguns the zone can use.","operationId":"railgun-connections-for-a-zone-list-available-railguns","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-railgun_response_collection"}}},"description":"List available Railguns response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-railgun_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List available Railguns response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List available Railguns","tags":["Railgun Connections for a Zone"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/railguns/{identifier}":{"get":{"description":"Lists details about a specific Railgun.","operationId":"railgun-connections-for-a-zone-railgun-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier-2"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/railgun_response_single"}}},"description":"Railgun details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/railgun_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Railgun details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Railgun details","tags":["Railgun Connections for a Zone"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"patch":{"description":"Connect or disconnect a Railgun.","operationId":"railgun-connections-for-a-zone-connect-or-disconnect-a-railgun","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier-2"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"connected":{"$ref":"#/components/schemas/connected"}},"required":["connected"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/railgun_response_single"}}},"description":"Connect or disconnect a Railgun response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/railgun_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Connect or disconnect a Railgun response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Connect or disconnect a Railgun","tags":["Railgun Connections for a Zone"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/railguns/{identifier}/diagnose":{"get":{"description":"Tests the Railgun connection to the zone.","operationId":"railgun-connections-for-a-zone-test-railgun-connection","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/railgun_components-schemas-identifier-2"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/test_connection_response"}}},"description":"Test Railgun connection response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/test_connection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Test Railgun connection response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Test Railgun connection","tags":["Railgun Connections for a Zone"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/rate_limits":{"get":{"description":"Fetches the rate limits for a zone.","operationId":"rate-limits-for-a-zone-list-rate-limits","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"page","schema":{"default":1,"description":"The page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"The maximum number of results per page. You can only set the value to `1` or to a multiple of 5 such as `5`, `10`, `15`, or `20`.","maximum":1000,"minimum":1,"type":"number"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ratelimit_response_collection"}}},"description":"List rate limits response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ratelimit_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List rate limits response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List rate limits","tags":["Rate limits for a zone"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Creates a new rate limit for a zone. Refer to the object definition for a list of required attributes.","operationId":"rate-limits-for-a-zone-create-a-rate-limit","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["match","threshold","period","action"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ratelimit_response_single"}}},"description":"Create a rate limit response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ratelimit_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create a rate limit response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create a rate limit","tags":["Rate limits for a zone"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/rate_limits/{id}":{"delete":{"description":"Deletes an existing rate limit.","operationId":"rate-limits-for-a-zone-delete-a-rate-limit","parameters":[{"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/rate-limits_components-schemas-id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ratelimit_response_single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/rate-limits_components-schemas-id"}}}},"type":"object"}]}}},"description":"Delete a rate limit response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/ratelimit_response_single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/rate-limits_components-schemas-id"}}}},"type":"object"}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete a rate limit response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete a rate limit","tags":["Rate limits for a zone"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Fetches the details of a rate limit.","operationId":"rate-limits-for-a-zone-get-a-rate-limit","parameters":[{"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/rate-limits_components-schemas-id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ratelimit_response_single"}}},"description":"Get a rate limit response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ratelimit_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get a rate limit response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a rate limit","tags":["Rate limits for a zone"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Updates an existing rate limit.","operationId":"rate-limits-for-a-zone-update-a-rate-limit","parameters":[{"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/rate-limits_components-schemas-id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["id","match","threshold","period","action"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ratelimit_response_single"}}},"description":"Update a rate limit response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ratelimit_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update a rate limit response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update a rate limit","tags":["Rate limits for a zone"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/secondary_dns/force_axfr":{"post":{"description":"Sends AXFR zone transfer request to primary nameserver(s).","operationId":"secondary-dns-(-secondary-zone)-force-axfr","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-ahBjrSIO"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/force_response"}}},"description":"Force AXFR response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/force_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Force AXFR response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Force AXFR","tags":["Secondary DNS (Secondary Zone)"],"x-cfPermissionsRequired":{"enum":["#dns_records:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/secondary_dns/incoming":{"delete":{"description":"Delete secondary zone configuration for incoming zone transfers.","operationId":"secondary-dns-(-secondary-zone)-delete-secondary-zone-configuration","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-ahBjrSIO"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/id_response-lg4lL9us"}}},"description":"Delete Secondary Zone Configuration response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/id_response-lg4lL9us"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Secondary Zone Configuration response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Secondary Zone Configuration","tags":["Secondary DNS (Secondary Zone)"],"x-cfPermissionsRequired":{"enum":["#dns_records:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Get secondary zone configuration for incoming zone transfers.","operationId":"secondary-dns-(-secondary-zone)-secondary-zone-configuration-details","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-ahBjrSIO"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response_incoming"}}},"description":"Secondary Zone Configuration Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response_incoming"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Secondary Zone Configuration Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Secondary Zone Configuration Details","tags":["Secondary DNS (Secondary Zone)"],"x-cfPermissionsRequired":{"enum":["#dns_records:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Create secondary zone configuration for incoming zone transfers.","operationId":"secondary-dns-(-secondary-zone)-create-secondary-zone-configuration","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-ahBjrSIO"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-secondary-secondary-zone"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response_incoming"}}},"description":"Create Secondary Zone Configuration response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response_incoming"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Secondary Zone Configuration response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Secondary Zone Configuration","tags":["Secondary DNS (Secondary Zone)"],"x-cfPermissionsRequired":{"enum":["#dns_records:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Update secondary zone configuration for incoming zone transfers.","operationId":"secondary-dns-(-secondary-zone)-update-secondary-zone-configuration","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-ahBjrSIO"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dns-secondary-secondary-zone"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response_incoming"}}},"description":"Update Secondary Zone Configuration response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response_incoming"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Secondary Zone Configuration response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Secondary Zone Configuration","tags":["Secondary DNS (Secondary Zone)"],"x-cfPermissionsRequired":{"enum":["#dns_records:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/secondary_dns/outgoing":{"delete":{"description":"Delete primary zone configuration for outgoing zone transfers.","operationId":"secondary-dns-(-primary-zone)-delete-primary-zone-configuration","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-ahBjrSIO"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/id_response-lg4lL9us"}}},"description":"Delete Primary Zone Configuration response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/id_response-lg4lL9us"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Primary Zone Configuration response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Primary Zone Configuration","tags":["Secondary DNS (Primary Zone)"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Get primary zone configuration for outgoing zone transfers.","operationId":"secondary-dns-(-primary-zone)-primary-zone-configuration-details","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-ahBjrSIO"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response_outgoing"}}},"description":"Primary Zone Configuration Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response_outgoing"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Primary Zone Configuration Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Primary Zone Configuration Details","tags":["Secondary DNS (Primary Zone)"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Create primary zone configuration for outgoing zone transfers.","operationId":"secondary-dns-(-primary-zone)-create-primary-zone-configuration","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-ahBjrSIO"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_request_outgoing"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response_outgoing"}}},"description":"Create Primary Zone Configuration response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response_outgoing"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Primary Zone Configuration response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Primary Zone Configuration","tags":["Secondary DNS (Primary Zone)"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Update primary zone configuration for outgoing zone transfers.","operationId":"secondary-dns-(-primary-zone)-update-primary-zone-configuration","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-ahBjrSIO"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_request_outgoing"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response_outgoing"}}},"description":"Update Primary Zone Configuration response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response_outgoing"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Primary Zone Configuration response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Primary Zone Configuration","tags":["Secondary DNS (Primary Zone)"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/secondary_dns/outgoing/disable":{"post":{"description":"Disable outgoing zone transfers for primary zone and clears IXFR backlog of primary zone.","operationId":"secondary-dns-(-primary-zone)-disable-outgoing-zone-transfers","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-ahBjrSIO"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/disable_transfer_response"}}},"description":"Disable Outgoing Zone Transfers response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/disable_transfer_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Disable Outgoing Zone Transfers response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Disable Outgoing Zone Transfers","tags":["Secondary DNS (Primary Zone)"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/secondary_dns/outgoing/enable":{"post":{"description":"Enable outgoing zone transfers for primary zone.","operationId":"secondary-dns-(-primary-zone)-enable-outgoing-zone-transfers","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-ahBjrSIO"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/enable_transfer_response"}}},"description":"Enable Outgoing Zone Transfers response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/enable_transfer_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Enable Outgoing Zone Transfers response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Enable Outgoing Zone Transfers","tags":["Secondary DNS (Primary Zone)"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/secondary_dns/outgoing/force_notify":{"post":{"description":"Notifies the secondary nameserver(s) and clears IXFR backlog of primary zone.","operationId":"secondary-dns-(-primary-zone)-force-dns-notify","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-ahBjrSIO"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-force_response"}}},"description":"Force DNS NOTIFY response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-force_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Force DNS NOTIFY response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Force DNS NOTIFY","tags":["Secondary DNS (Primary Zone)"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/secondary_dns/outgoing/status":{"get":{"description":"Get primary zone transfer status.","operationId":"secondary-dns-(-primary-zone)-get-outgoing-zone-transfer-status","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-ahBjrSIO"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/enable_transfer_response"}}},"description":"Get Outgoing Zone Transfer Status response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/enable_transfer_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Outgoing Zone Transfer Status response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Outgoing Zone Transfer Status","tags":["Secondary DNS (Primary Zone)"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/settings":{"get":{"description":"Available settings for your user in relation to a zone.","operationId":"zone-settings-get-all-zone-settings","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zone_settings_response_collection"}}},"description":"Get all Zone settings response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get all Zone settings response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get all Zone settings","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Edit settings for a zone.","operationId":"zone-settings-edit-zone-settings-info","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"items":{"description":"One or more zone setting objects. Must contain an ID and a value.","example":[{"id":"always_online","value":"on"},{"id":"browser_cache_ttl","value":18000},{"id":"ip_geolocation","value":"off"}],"items":{"$ref":"#/components/schemas/setting"},"minItems":1,"type":"array"}},"required":["items"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/zone_settings_response_collection"}}},"description":"Edit zone settings info response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Edit zone settings info response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Edit zone settings info","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/0rtt":{"get":{"description":"Gets 0-RTT session resumption setting.","operationId":"zone-settings-get-0-rtt-session-resumption-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/0rtt"}}}]}}},"description":"Get 0-RTT session resumption setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get 0-RTT session resumption setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get 0-RTT session resumption setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Changes the 0-RTT session resumption setting.","operationId":"zone-settings-change-0-rtt-session-resumption-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/0rtt_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/0rtt"}}}]}}},"description":"Change 0-RTT session resumption setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change 0-RTT session resumption setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change 0-RTT session resumption setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_identifier}/settings/advanced_ddos":{"get":{"description":"Advanced protection from Distributed Denial of Service (DDoS) attacks on your website. This is an uneditable value that is 'on' in the case of Business and Enterprise zones.","operationId":"zone-settings-get-advanced-ddos-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/advanced_ddos"}}}]}}},"description":"Get Advanced DDOS setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Advanced DDOS setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Advanced DDOS setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/settings/always_online":{"get":{"description":"When enabled, Cloudflare serves limited copies of web pages available from the [Internet Archive's Wayback Machine](https://archive.org/web/) if your server is offline. Refer to [Always Online](https://developers.cloudflare.com/cache/about/always-online) for more information.","operationId":"zone-settings-get-always-online-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/always_online"}}}]}}},"description":"Get Always Online setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Always Online setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Always Online setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"When enabled, Cloudflare serves limited copies of web pages available from the [Internet Archive's Wayback Machine](https://archive.org/web/) if your server is offline. Refer to [Always Online](https://developers.cloudflare.com/cache/about/always-online) for more information.","operationId":"zone-settings-change-always-online-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/always_online_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/always_online"}}}]}}},"description":"Change Always Online setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Always Online setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Always Online setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/always_use_https":{"get":{"description":"Reply to all requests for URLs that use \"http\" with a 301 redirect to the equivalent \"https\" URL. If you only want to redirect for a subset of requests, consider creating an \"Always use HTTPS\" page rule.","operationId":"zone-settings-get-always-use-https-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/always_use_https"}}}]}}},"description":"Get Always Use HTTPS setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Always Use HTTPS setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Always Use HTTPS setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Reply to all requests for URLs that use \"http\" with a 301 redirect to the equivalent \"https\" URL. If you only want to redirect for a subset of requests, consider creating an \"Always use HTTPS\" page rule.","operationId":"zone-settings-change-always-use-https-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/always_use_https_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/always_use_https"}}}]}}},"description":"Change Always Use HTTPS setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Always Use HTTPS setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Always Use HTTPS setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/automatic_https_rewrites":{"get":{"description":"Enable the Automatic HTTPS Rewrites feature for this zone.","operationId":"zone-settings-get-automatic-https-rewrites-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/automatic_https_rewrites"}}}]}}},"description":"Get Automatic HTTPS Rewrites setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Automatic HTTPS Rewrites setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Automatic HTTPS Rewrites setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Enable the Automatic HTTPS Rewrites feature for this zone.","operationId":"zone-settings-change-automatic-https-rewrites-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/automatic_https_rewrites_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/automatic_https_rewrites"}}}]}}},"description":"Change Automatic HTTPS Rewrites setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Automatic HTTPS Rewrites setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Automatic HTTPS Rewrites setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/automatic_platform_optimization":{"get":{"description":"[Automatic Platform Optimization for WordPress](https://developers.cloudflare.com/automatic-platform-optimization/)\nserves your WordPress site from Cloudflare's edge network and caches\nthird-party fonts.\n","operationId":"zone-settings-get-automatic_platform_optimization-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/automatic_platform_optimization"}}}]}}},"description":"Get Automatic Platform Optimization for WordPress setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Automatic Platform Optimization for WordPress setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Automatic Platform Optimization for WordPress setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"[Automatic Platform Optimization for WordPress](https://developers.cloudflare.com/automatic-platform-optimization/)\nserves your WordPress site from Cloudflare's edge network and caches\nthird-party fonts.\n","operationId":"zone-settings-change-automatic_platform_optimization-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/automatic_platform_optimization"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/automatic_platform_optimization"}}}]}}},"description":"Change Automatic Platform Optimization for WordPress setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Automatic Platform Optimization for WordPress setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Automatic Platform Optimization for WordPress setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/brotli":{"get":{"description":"When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset.","operationId":"zone-settings-get-brotli-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/brotli"}}}]}}},"description":"Get Brotli setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Brotli setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Brotli setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset.","operationId":"zone-settings-change-brotli-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/brotli_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/brotli"}}}]}}},"description":"Change Brotli setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Brotli setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Brotli setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/browser_cache_ttl":{"get":{"description":"Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources will remain on your visitors' computers. Cloudflare will honor any larger times specified by your server. (https://support.cloudflare.com/hc/en-us/articles/200168276).","operationId":"zone-settings-get-browser-cache-ttl-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/browser_cache_ttl"}}}]}}},"description":"Get Browser Cache TTL setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Browser Cache TTL setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Browser Cache TTL setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources will remain on your visitors' computers. Cloudflare will honor any larger times specified by your server. (https://support.cloudflare.com/hc/en-us/articles/200168276).","operationId":"zone-settings-change-browser-cache-ttl-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/browser_cache_ttl_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/browser_cache_ttl"}}}]}}},"description":"Change Browser Cache TTL setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Browser Cache TTL setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Browser Cache TTL setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/browser_check":{"get":{"description":"Browser Integrity Check is similar to Bad Behavior and looks for common HTTP headers abused most commonly by spammers and denies access to your page. It will also challenge visitors that do not have a user agent or a non standard user agent (also commonly used by abuse bots, crawlers or visitors). (https://support.cloudflare.com/hc/en-us/articles/200170086).","operationId":"zone-settings-get-browser-check-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/browser_check"}}}]}}},"description":"Get Browser Check setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Browser Check setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Browser Check setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Browser Integrity Check is similar to Bad Behavior and looks for common HTTP headers abused most commonly by spammers and denies access to your page. It will also challenge visitors that do not have a user agent or a non standard user agent (also commonly used by abuse bots, crawlers or visitors). (https://support.cloudflare.com/hc/en-us/articles/200170086).","operationId":"zone-settings-change-browser-check-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/browser_check_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/browser_check"}}}]}}},"description":"Change Browser Check setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Browser Check setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Browser Check setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/cache_level":{"get":{"description":"Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). The simplified setting will ignore the query string when delivering a cached resource. The aggressive setting will cache all static resources, including ones with a query string. (https://support.cloudflare.com/hc/en-us/articles/200168256).","operationId":"zone-settings-get-cache-level-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/cache_level"}}}]}}},"description":"Get Cache Level setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Cache Level setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Cache Level setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). The simplified setting will ignore the query string when delivering a cached resource. The aggressive setting will cache all static resources, including ones with a query string. (https://support.cloudflare.com/hc/en-us/articles/200168256).","operationId":"zone-settings-change-cache-level-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/cache_level_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/cache_level"}}}]}}},"description":"Change Cache Level setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Cache Level setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Cache Level setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/challenge_ttl":{"get":{"description":"Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136).","operationId":"zone-settings-get-challenge-ttl-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/challenge_ttl"}}}]}}},"description":"Get Challenge TTL setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Challenge TTL setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Challenge TTL setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136).","operationId":"zone-settings-change-challenge-ttl-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/challenge_ttl_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/challenge_ttl"}}}]}}},"description":"Change Challenge TTL setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Challenge TTL setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Challenge TTL setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/ciphers":{"get":{"description":"Gets ciphers setting.","operationId":"zone-settings-get-ciphers-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/ciphers"}}}]}}},"description":"Get ciphers setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get ciphers setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get ciphers setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Changes ciphers setting.","operationId":"zone-settings-change-ciphers-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/ciphers_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/ciphers"}}}]}}},"description":"Change ciphers setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change ciphers setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change ciphers setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/development_mode":{"get":{"description":"Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare's accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off.","operationId":"zone-settings-get-development-mode-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/development_mode"}}}]}}},"description":"Get Development Mode setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Development Mode setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Development Mode setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare's accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off.","operationId":"zone-settings-change-development-mode-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/development_mode_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/development_mode"}}}]}}},"description":"Change Development Mode setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Development Mode setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Development Mode setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/early_hints":{"get":{"description":"When enabled, Cloudflare will attempt to speed up overall page loads by serving `103` responses with `Link` headers from the final response. Refer to [Early Hints](https://developers.cloudflare.com/cache/about/early-hints) for more information.","operationId":"zone-settings-get-early-hints-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/early_hints"}}}]}}},"description":"Get Early Hints setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Early Hints setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Early Hints setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"When enabled, Cloudflare will attempt to speed up overall page loads by serving `103` responses with `Link` headers from the final response. Refer to [Early Hints](https://developers.cloudflare.com/cache/about/early-hints) for more information.","operationId":"zone-settings-change-early-hints-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/early_hints_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/early_hints"}}}]}}},"description":"Change Early Hints setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Early Hints setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Early Hints setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/email_obfuscation":{"get":{"description":"Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016).","operationId":"zone-settings-get-email-obfuscation-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/email_obfuscation"}}}]}}},"description":"Get Email Obfuscation setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Email Obfuscation setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Email Obfuscation setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016).","operationId":"zone-settings-change-email-obfuscation-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/email_obfuscation_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/email_obfuscation"}}}]}}},"description":"Change Email Obfuscation setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Email Obfuscation setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Email Obfuscation setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/h2_prioritization":{"get":{"description":"Gets HTTP/2 Edge Prioritization setting.\n","operationId":"zone-settings-get-h2_prioritization-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/h2_prioritization"}}}]}}},"description":"Get HTTP/2 Edge Prioritization setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get HTTP/2 Edge Prioritization setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get HTTP/2 Edge Prioritization setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Gets HTTP/2 Edge Prioritization setting.\n","operationId":"zone-settings-change-h2_prioritization-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/h2_prioritization"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/h2_prioritization"}}}]}}},"description":"Change HTTP/2 Edge Prioritization setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change HTTP/2 Edge Prioritization setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change HTTP/2 Edge Prioritization setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/hotlink_protection":{"get":{"description":"When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it's not another site requesting them. People will still be able to download and view images from your page, but other sites won't be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026).","operationId":"zone-settings-get-hotlink-protection-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/hotlink_protection"}}}]}}},"description":"Get Hotlink Protection setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Hotlink Protection setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Hotlink Protection setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it's not another site requesting them. People will still be able to download and view images from your page, but other sites won't be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026).","operationId":"zone-settings-change-hotlink-protection-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/hotlink_protection_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/hotlink_protection"}}}]}}},"description":"Change Hotlink Protection setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Hotlink Protection setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Hotlink Protection setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/http2":{"get":{"description":"Value of the HTTP2 setting.","operationId":"zone-settings-get-h-t-t-p-2-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/http2"}}}]}}},"description":"Get HTTP2 setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get HTTP2 setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get HTTP2 setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Value of the HTTP2 setting.","operationId":"zone-settings-change-h-t-t-p-2-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/http2_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/http2"}}}]}}},"description":"Change HTTP2 setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change HTTP2 setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change HTTP2 setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_identifier}/settings/http3":{"get":{"description":"Value of the HTTP3 setting.","operationId":"zone-settings-get-h-t-t-p-3-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/http3"}}}]}}},"description":"Get HTTP3 setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get HTTP3 setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get HTTP3 setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Value of the HTTP3 setting.","operationId":"zone-settings-change-h-t-t-p-3-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/http3_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/http3"}}}]}}},"description":"Change HTTP3 setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change HTTP3 setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change HTTP3 setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_identifier}/settings/image_resizing":{"get":{"description":"Image Resizing provides on-demand resizing, conversion and optimisation\nfor images served through Cloudflare's network. Refer to the\n[Image Resizing documentation](https://developers.cloudflare.com/images/)\nfor more information.\n","operationId":"zone-settings-get-image_resizing-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/image_resizing"}}}]}}},"description":"Get Image Resizing setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Image Resizing setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Image Resizing setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Image Resizing provides on-demand resizing, conversion and optimisation\nfor images served through Cloudflare's network. Refer to the\n[Image Resizing documentation](https://developers.cloudflare.com/images/)\nfor more information.\n","operationId":"zone-settings-change-image_resizing-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/image_resizing"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/image_resizing"}}}]}}},"description":"Change Image Resizing setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Image Resizing setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Image Resizing setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/ip_geolocation":{"get":{"description":"Enable IP Geolocation to have Cloudflare geolocate visitors to your website and pass the country code to you. (https://support.cloudflare.com/hc/en-us/articles/200168236).","operationId":"zone-settings-get-ip-geolocation-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/ip_geolocation"}}}]}}},"description":"Get IP Geolocation setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get IP Geolocation setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get IP Geolocation setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Enable IP Geolocation to have Cloudflare geolocate visitors to your website and pass the country code to you. (https://support.cloudflare.com/hc/en-us/articles/200168236).","operationId":"zone-settings-change-ip-geolocation-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/ip_geolocation_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/ip_geolocation"}}}]}}},"description":"Change IP Geolocation setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change IP Geolocation setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change IP Geolocation setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/ipv6":{"get":{"description":"Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586).","operationId":"zone-settings-get-i-pv6-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/ipv6"}}}]}}},"description":"Get IPv6 setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get IPv6 setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get IPv6 setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586).","operationId":"zone-settings-change-i-pv6-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/ipv6_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/ipv6"}}}]}}},"description":"Change IPv6 setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change IPv6 setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change IPv6 setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_identifier}/settings/min_tls_version":{"get":{"description":"Gets Minimum TLS Version setting.","operationId":"zone-settings-get-minimum-tls-version-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/min_tls_version"}}}]}}},"description":"Get Minimum TLS Version setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Minimum TLS Version setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Minimum TLS Version setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Changes Minimum TLS Version setting.","operationId":"zone-settings-change-minimum-tls-version-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/min_tls_version_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/min_tls_version"}}}]}}},"description":"Change Minimum TLS Version setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Minimum TLS Version setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Minimum TLS Version setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/minify":{"get":{"description":"Automatically minify certain assets for your website. Refer to [Using Cloudflare Auto Minify](https://support.cloudflare.com/hc/en-us/articles/200168196) for more information.","operationId":"zone-settings-get-minify-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/minify"}}}]}}},"description":"Get Minify setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Minify setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Minify setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Automatically minify certain assets for your website. Refer to [Using Cloudflare Auto Minify](https://support.cloudflare.com/hc/en-us/articles/200168196) for more information.","operationId":"zone-settings-change-minify-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/minify_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/minify"}}}]}}},"description":"Change Minify setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Minify setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Minify setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/mirage":{"get":{"description":"Automatically optimize image loading for website visitors on mobile\ndevices. Refer to our [blog post](http://blog.cloudflare.com/mirage2-solving-mobile-speed)\nfor more information.\n","operationId":"zone-settings-get-mirage-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/mirage"}}}]}}},"description":"Get Mirage setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Mirage setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Mirage setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Automatically optimize image loading for website visitors on mobile devices. Refer to our [blog post](http://blog.cloudflare.com/mirage2-solving-mobile-speed) for more information.","operationId":"zone-settings-change-web-mirage-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/mirage_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/mirage"}}}]}}},"description":"Change Mirage setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Mirage setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Mirage setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/mobile_redirect":{"get":{"description":"Automatically redirect visitors on mobile devices to a mobile-optimized subdomain. Refer to [Understanding Cloudflare Mobile Redirect](https://support.cloudflare.com/hc/articles/200168336) for more information.","operationId":"zone-settings-get-mobile-redirect-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/mobile_redirect"}}}]}}},"description":"Get Mobile Redirect setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Mobile Redirect setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Mobile Redirect setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Automatically redirect visitors on mobile devices to a mobile-optimized subdomain. Refer to [Understanding Cloudflare Mobile Redirect](https://support.cloudflare.com/hc/articles/200168336) for more information.","operationId":"zone-settings-change-mobile-redirect-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/mobile_redirect_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/mobile_redirect"}}}]}}},"description":"Change Mobile Redirect setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Mobile Redirect setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Mobile Redirect setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/nel":{"get":{"description":"Enable Network Error Logging reporting on your zone. (Beta)\n","operationId":"zone-settings-get-nel-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/nel"}}}]}}},"description":"Get Network Error Logging setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Network Error Logging setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Network Error Logging setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Automatically optimize image loading for website visitors on mobile devices. Refer to our [blog post](http://blog.cloudflare.com/nel-solving-mobile-speed) for more information.","operationId":"zone-settings-change-nel-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/nel"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/nel"}}}]}}},"description":"Change Network Error Logging setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Network Error Logging setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Network Error Logging setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/opportunistic_encryption":{"get":{"description":"Gets Opportunistic Encryption setting.","operationId":"zone-settings-get-opportunistic-encryption-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/opportunistic_encryption"}}}]}}},"description":"Get Opportunistic Encryption setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Opportunistic Encryption setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Opportunistic Encryption setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Changes Opportunistic Encryption setting.","operationId":"zone-settings-change-opportunistic-encryption-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/opportunistic_encryption_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/opportunistic_encryption"}}}]}}},"description":"Change Opportunistic Encryption setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Opportunistic Encryption setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Opportunistic Encryption setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/opportunistic_onion":{"get":{"description":"Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes.","operationId":"zone-settings-get-opportunistic-onion-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/opportunistic_onion"}}}]}}},"description":"Get Opportunistic Onion setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Opportunistic Onion setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Opportunistic Onion setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes.","operationId":"zone-settings-change-opportunistic-onion-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/opportunistic_onion_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/opportunistic_onion"}}}]}}},"description":"Change Opportunistic Onion setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Opportunistic Onion setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Opportunistic Onion setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/orange_to_orange":{"get":{"description":"Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other\nzones also on Cloudflare.\n","operationId":"zone-settings-get-orange_to_orange-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/orange_to_orange"}}}]}}},"description":"Get Orange to Orange (O2O) setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Orange to Orange (O2O) setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Orange to Orange (O2O) setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other\nzones also on Cloudflare.\n","operationId":"zone-settings-change-orange_to_orange-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/orange_to_orange"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/orange_to_orange"}}}]}}},"description":"Change Orange to Orange (O2O) setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Orange to Orange (O2O) setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Orange to Orange (O2O) setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/origin_error_page_pass_thru":{"get":{"description":"Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones.","operationId":"zone-settings-get-enable-error-pages-on-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/origin_error_page_pass_thru"}}}]}}},"description":"Get Enable Error Pages On setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Enable Error Pages On setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Enable Error Pages On setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"patch":{"description":"Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones.","operationId":"zone-settings-change-enable-error-pages-on-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/origin_error_page_pass_thru_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/origin_error_page_pass_thru"}}}]}}},"description":"Change Enable Error Pages On setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Enable Error Pages On setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Enable Error Pages On setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/settings/origin_max_http_version":{"get":{"description":"The highest HTTP version Cloudflare will attempt to use with your\norigin. This setting allows Cloudflare to make HTTP/2 requests to your\norigin. (Refer to \n[Enable HTTP/2 to Origin](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/),\nfor more information.).\n","operationId":"zone-settings-get-origin_max_http_version-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/origin_max_http_version"}}}]}}},"description":"Get Origin Max HTTP Version setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Origin Max HTTP Version setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Origin Max HTTP Version setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"The highest HTTP version Cloudflare will attempt to use with your\norigin. This setting allows Cloudflare to make HTTP/2 requests to your\norigin. (Refer to \n[Enable HTTP/2 to Origin](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/),\nfor more information.).\n","operationId":"zone-settings-change-origin_max_http_version-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/origin_max_http_version"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/origin_max_http_version"}}}]}}},"description":"Change Origin Max HTTP Version setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Origin Max HTTP Version setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Origin Max HTTP Version setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/polish":{"get":{"description":"Automatically optimize image loading for website visitors on mobile\ndevices. Refer to our [blog post](http://blog.cloudflare.com/polish-solving-mobile-speed)\nfor more information.\n","operationId":"zone-settings-get-polish-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/polish"}}}]}}},"description":"Get Polish setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Polish setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Polish setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Automatically optimize image loading for website visitors on mobile devices. Refer to our [blog post](http://blog.cloudflare.com/polish-solving-mobile-speed) for more information.","operationId":"zone-settings-change-polish-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/polish"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/polish"}}}]}}},"description":"Change Polish setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Polish setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Polish setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/prefetch_preload":{"get":{"description":"Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones.","operationId":"zone-settings-get-prefetch-preload-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/prefetch_preload"}}}]}}},"description":"Get prefetch preload setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get prefetch preload setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get prefetch preload setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"patch":{"description":"Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones.","operationId":"zone-settings-change-prefetch-preload-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/prefetch_preload_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/prefetch_preload"}}}]}}},"description":"Change prefetch preload setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change prefetch preload setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change prefetch preload setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/settings/privacy_pass":{"get":{"description":"Privacy Pass is a browser extension developed by the Privacy Pass Team to improve the browsing experience for your visitors. Enabling Privacy Pass will reduce the number of CAPTCHAs shown to your visitors. (https://support.cloudflare.com/hc/en-us/articles/115001992652-Privacy-Pass).","operationId":"zone-settings-get-privacy-pass-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/privacy_pass"}}}]}}},"description":"Get Privacy Pass setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Privacy Pass setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Privacy Pass setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Privacy Pass is a browser extension developed by the Privacy Pass Team to improve the browsing experience for your visitors. Enabling Privacy Pass will reduce the number of CAPTCHAs shown to your visitors. (https://support.cloudflare.com/hc/en-us/articles/115001992652-Privacy-Pass).","operationId":"zone-settings-change-privacy-pass-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/privacy_pass_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/privacy_pass"}}}]}}},"description":"Change Privacy Pass setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Privacy Pass setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Privacy Pass setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/proxy_read_timeout":{"get":{"description":"Maximum time between two read operations from origin.\n","operationId":"zone-settings-get-proxy_read_timeout-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/proxy_read_timeout"}}}]}}},"description":"Get Proxy Read Timeout setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Proxy Read Timeout setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Proxy Read Timeout setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Maximum time between two read operations from origin.\n","operationId":"zone-settings-change-proxy_read_timeout-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/proxy_read_timeout"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/proxy_read_timeout"}}}]}}},"description":"Change Proxy Read Timeout setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Proxy Read Timeout setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Proxy Read Timeout setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/pseudo_ipv4":{"get":{"description":"Value of the Pseudo IPv4 setting.","operationId":"zone-settings-get-pseudo-i-pv4-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/pseudo_ipv4"}}}]}}},"description":"Get Pseudo IPv4 setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Pseudo IPv4 setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Pseudo IPv4 setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Value of the Pseudo IPv4 setting.","operationId":"zone-settings-change-pseudo-i-pv4-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/pseudo_ipv4_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/pseudo_ipv4"}}}]}}},"description":"Change Pseudo IPv4 setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Pseudo IPv4 setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Pseudo IPv4 setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_identifier}/settings/response_buffering":{"get":{"description":"Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones.","operationId":"zone-settings-get-response-buffering-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/response_buffering"}}}]}}},"description":"Get Response Buffering setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Response Buffering setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Response Buffering setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"patch":{"description":"Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones.","operationId":"zone-settings-change-response-buffering-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/response_buffering_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/response_buffering"}}}]}}},"description":"Change Response Buffering setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Response Buffering setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Response Buffering setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/settings/rocket_loader":{"get":{"description":"Rocket Loader is a general-purpose asynchronous JavaScript optimisation\nthat prioritises rendering your content while loading your site's\nJavascript asynchronously. Turning on Rocket Loader will immediately\nimprove a web page's rendering time sometimes measured as Time to First\nPaint (TTFP), and also the `window.onload` time (assuming there is\nJavaScript on the page). This can have a positive impact on your Google\nsearch ranking. When turned on, Rocket Loader will automatically defer\nthe loading of all Javascript referenced in your HTML, with no\nconfiguration required. Refer to \n[Understanding Rocket Loader](https://support.cloudflare.com/hc/articles/200168056)\nfor more information.\n","operationId":"zone-settings-get-rocket_loader-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/rocket_loader"}}}]}}},"description":"Get Rocket Loader setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Rocket Loader setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Rocket Loader setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Rocket Loader is a general-purpose asynchronous JavaScript optimisation\nthat prioritises rendering your content while loading your site's\nJavascript asynchronously. Turning on Rocket Loader will immediately\nimprove a web page's rendering time sometimes measured as Time to First\nPaint (TTFP), and also the `window.onload` time (assuming there is\nJavaScript on the page). This can have a positive impact on your Google\nsearch ranking. When turned on, Rocket Loader will automatically defer\nthe loading of all Javascript referenced in your HTML, with no\nconfiguration required. Refer to \n[Understanding Rocket Loader](https://support.cloudflare.com/hc/articles/200168056)\nfor more information.\n","operationId":"zone-settings-change-rocket_loader-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/rocket_loader"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/rocket_loader"}}}]}}},"description":"Change Rocket Loader setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Rocket Loader setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Rocket Loader setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/security_header":{"get":{"description":"Cloudflare security header for a zone.","operationId":"zone-settings-get-security-header-(-hsts)-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/security_header"}}}]}}},"description":"Get Security Header (HSTS) setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Security Header (HSTS) setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Security Header (HSTS) setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Cloudflare security header for a zone.","operationId":"zone-settings-change-security-header-(-hsts)-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/security_header_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/security_header"}}}]}}},"description":"Change Security Header (HSTS) setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Security Header (HSTS) setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Security Header (HSTS) setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/security_level":{"get":{"description":"Choose the appropriate security profile for your website, which will automatically adjust each of the security settings. If you choose to customize an individual security setting, the profile will become Custom. (https://support.cloudflare.com/hc/en-us/articles/200170056).","operationId":"zone-settings-get-security-level-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/security_level"}}}]}}},"description":"Get Security Level setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Security Level setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Security Level setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Choose the appropriate security profile for your website, which will automatically adjust each of the security settings. If you choose to customize an individual security setting, the profile will become Custom. (https://support.cloudflare.com/hc/en-us/articles/200170056).","operationId":"zone-settings-change-security-level-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/security_level_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/security_level"}}}]}}},"description":"Change Security Level setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Security Level setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Security Level setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/server_side_exclude":{"get":{"description":"If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: \u003c!--sse--\u003e\u003c!--/sse--\u003e. For example: \u003c!--sse--\u003e Bad visitors won't see my phone number, 555-555-5555 \u003c!--/sse--\u003e. Note: SSE only will work with HTML. If you have HTML minification enabled, you won't see the SSE tags in your HTML source when it's served through Cloudflare. SSE will still function in this case, as Cloudflare's HTML minification and SSE functionality occur on-the-fly as the resource moves through our network to the visitor's computer. (https://support.cloudflare.com/hc/en-us/articles/200170036).","operationId":"zone-settings-get-server-side-exclude-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/server_side_exclude"}}}]}}},"description":"Get Server Side Exclude setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Server Side Exclude setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Server Side Exclude setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: \u003c!--sse--\u003e\u003c!--/sse--\u003e. For example: \u003c!--sse--\u003e Bad visitors won't see my phone number, 555-555-5555 \u003c!--/sse--\u003e. Note: SSE only will work with HTML. If you have HTML minification enabled, you won't see the SSE tags in your HTML source when it's served through Cloudflare. SSE will still function in this case, as Cloudflare's HTML minification and SSE functionality occur on-the-fly as the resource moves through our network to the visitor's computer. (https://support.cloudflare.com/hc/en-us/articles/200170036).","operationId":"zone-settings-change-server-side-exclude-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/server_side_exclude_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/server_side_exclude"}}}]}}},"description":"Change Server Side Exclude setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Server Side Exclude setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Server Side Exclude setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/sort_query_string_for_cache":{"get":{"description":"Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones.","operationId":"zone-settings-get-enable-query-string-sort-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/sort_query_string_for_cache"}}}]}}},"description":"Get Enable Query String Sort setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Enable Query String Sort setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Enable Query String Sort setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"patch":{"description":"Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones.","operationId":"zone-settings-change-enable-query-string-sort-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/sort_query_string_for_cache_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/sort_query_string_for_cache"}}}]}}},"description":"Change Enable Query String Sort setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Enable Query String Sort setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Enable Query String Sort setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/settings/ssl":{"get":{"description":"SSL encrypts your visitor's connection and safeguards credit card numbers and other personal data to and from your website. SSL can take up to 5 minutes to fully activate. Requires Cloudflare active on your root domain or www domain. Off: no SSL between the visitor and Cloudflare, and no SSL between Cloudflare and your web server (all HTTP traffic). Flexible: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, but no SSL between Cloudflare and your web server. You don't need to have an SSL cert on your web server, but your vistors will still see the site as being HTTPS enabled. Full: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have your own SSL cert or self-signed cert at the very least. Full (Strict): SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have a valid SSL certificate installed on your web server. This certificate must be signed by a certificate authority, have an expiration date in the future, and respond for the request domain name (hostname). (https://support.cloudflare.com/hc/en-us/articles/200170416).","operationId":"zone-settings-get-ssl-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/ssl"}}}]}}},"description":"Get SSL setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get SSL setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get SSL setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"SSL encrypts your visitor's connection and safeguards credit card numbers and other personal data to and from your website. SSL can take up to 5 minutes to fully activate. Requires Cloudflare active on your root domain or www domain. Off: no SSL between the visitor and Cloudflare, and no SSL between Cloudflare and your web server (all HTTP traffic). Flexible: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, but no SSL between Cloudflare and your web server. You don't need to have an SSL cert on your web server, but your vistors will still see the site as being HTTPS enabled. Full: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have your own SSL cert or self-signed cert at the very least. Full (Strict): SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have a valid SSL certificate installed on your web server. This certificate must be signed by a certificate authority, have an expiration date in the future, and respond for the request domain name (hostname). (https://support.cloudflare.com/hc/en-us/articles/200170416).","operationId":"zone-settings-change-ssl-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/ssl_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/ssl"}}}]}}},"description":"Change SSL setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change SSL setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change SSL setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/ssl_recommender":{"get":{"description":"Enrollment in the SSL/TLS Recommender service which tries to detect and\nrecommend (by sending periodic emails) the most secure SSL/TLS setting\nyour origin servers support.\n","operationId":"zone-settings-get-ssl_recommender-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/ssl_recommender"}}}]}}},"description":"Get SSL/TLS Recommender enrollment setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get SSL/TLS Recommender enrollment setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get SSL/TLS Recommender enrollment setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Enrollment in the SSL/TLS Recommender service which tries to detect and\nrecommend (by sending periodic emails) the most secure SSL/TLS setting\nyour origin servers support.\n","operationId":"zone-settings-change-ssl_recommender-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/ssl_recommender"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/ssl_recommender"}}}]}}},"description":"Change SSL/TLS Recommender enrollment setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change SSL/TLS Recommender enrollment setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change SSL/TLS Recommender enrollment setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/tls_1_3":{"get":{"description":"Gets TLS 1.3 setting enabled for a zone.","operationId":"zone-settings-get-tls-1.-3-setting-enabled-for-a-zone","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/tls_1_3"}}}]}}},"description":"Get TLS 1.3 setting enabled for a zone response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get TLS 1.3 setting enabled for a zone response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get TLS 1.3 setting enabled for a zone","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Changes TLS 1.3 setting.","operationId":"zone-settings-change-tls-1.-3-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/tls_1_3_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/tls_1_3"}}}]}}},"description":"Change TLS 1.3 setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change TLS 1.3 setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change TLS 1.3 setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/settings/tls_client_auth":{"get":{"description":"TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only).","operationId":"zone-settings-get-tls-client-auth-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/tls_client_auth"}}}]}}},"description":"Get TLS Client Auth setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get TLS Client Auth setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get TLS Client Auth setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"patch":{"description":"TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only).","operationId":"zone-settings-change-tls-client-auth-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/tls_client_auth_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/tls_client_auth"}}}]}}},"description":"Change TLS Client Auth setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change TLS Client Auth setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change TLS Client Auth setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/settings/true_client_ip_header":{"get":{"description":"Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones.","operationId":"zone-settings-get-true-client-ip-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/true_client_ip_header"}}}]}}},"description":"Get True Client IP setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get True Client IP setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get True Client IP setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"patch":{"description":"Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones.","operationId":"zone-settings-change-true-client-ip-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/true_client_ip_header_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/true_client_ip_header"}}}]}}},"description":"Change True Client IP setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change True Client IP setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change True Client IP setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/settings/waf":{"get":{"description":"The WAF examines HTTP requests to your website. It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will 'challenge' the web visitor with a page that asks them to submit a CAPTCHA successfully to continue their action. If the challenge is failed, the action will be stopped. What this means is that Cloudflare's WAF will block any traffic identified as illegitimate before it reaches your origin web server. (https://support.cloudflare.com/hc/en-us/articles/200172016).","operationId":"zone-settings-get-web-application-firewall-(-waf)-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/waf"}}}]}}},"description":"Get Web Application Firewall (WAF) setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get Web Application Firewall (WAF) setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Web Application Firewall (WAF) setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"patch":{"description":"The WAF examines HTTP requests to your website. It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will 'challenge' the web visitor with a page that asks them to submit a CAPTCHA successfully to continue their action. If the challenge is failed, the action will be stopped. What this means is that Cloudflare's WAF will block any traffic identified as illegitimate before it reaches your origin web server. (https://support.cloudflare.com/hc/en-us/articles/200172016).","operationId":"zone-settings-change-web-application-firewall-(-waf)-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/waf_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/waf"}}}]}}},"description":"Change Web Application Firewall (WAF) setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change Web Application Firewall (WAF) setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change Web Application Firewall (WAF) setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_identifier}/settings/webp":{"get":{"description":"When the client requesting the image supports the WebP image codec, and WebP offers a performance advantage over the original image format, Cloudflare will serve a WebP version of the original image.","operationId":"zone-settings-get-web-p-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/webp"}}}]}}},"description":"Get WebP setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get WebP setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get WebP setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"When the client requesting the image supports the WebP image codec, and WebP offers a performance advantage over the original image format, Cloudflare will serve a WebP version of the original image.","operationId":"zone-settings-change-web-p-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/webp_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/webp"}}}]}}},"description":"Change WebP setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change WebP setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change WebP setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_identifier}/settings/websockets":{"get":{"description":"Gets Websockets setting. For more information about Websockets, please refer to [Using Cloudflare with WebSockets](https://support.cloudflare.com/hc/en-us/articles/200169466-Using-Cloudflare-with-WebSockets).","operationId":"zone-settings-get-web-sockets-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/websockets"}}}]}}},"description":"Get WebSockets setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Get WebSockets setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get WebSockets setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Changes Websockets setting. For more information about Websockets, please refer to [Using Cloudflare with WebSockets](https://support.cloudflare.com/hc/en-us/articles/200169466-Using-Cloudflare-with-WebSockets).","operationId":"zone-settings-change-web-sockets-setting","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-MZFDye9j"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"value":{"$ref":"#/components/schemas/websockets_value"}},"required":["value"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single-WcbmxR67"},{"properties":{"result":{"$ref":"#/components/schemas/websockets"}}}]}}},"description":"Change WebSockets setting response"},"4xx":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-common-failure-3ET5U4FT"}}},"description":"Change WebSockets setting response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Change WebSockets setting","tags":["Zone Settings"],"x-cfPermissionsRequired":{"enum":["#zone_settings:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/ssl/certificate_packs":{"get":{"description":"For a given zone, list all active certificate packs.","operationId":"certificate-packs-list-certificate-packs","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"status","schema":{"description":"Include Certificate Packs of all statuses, not just active ones.","enum":["all"],"example":"all"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificate_pack_response_collection"}}},"description":"List Certificate Packs response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificate_pack_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Certificate Packs response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Certificate Packs","tags":["Certificate Packs"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/ssl/certificate_packs/order":{"post":{"description":"For a given zone, order an advanced certificate pack.","operationId":"certificate-packs-order-advanced-certificate-manager-certificate-pack","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"certificate_authority":{"$ref":"#/components/schemas/certificate_authority-VxFhhbhi"},"cloudflare_branding":{"$ref":"#/components/schemas/cloudflare_branding"},"hosts":{"$ref":"#/components/schemas/schemas-hosts"},"type":{"$ref":"#/components/schemas/advanced_type"},"validation_method":{"$ref":"#/components/schemas/validation_method"},"validity_days":{"$ref":"#/components/schemas/validity_days"}},"required":["type","hosts","validation_method","validity_days","certificate_authority"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/advanced_certificate_pack_response_single-M4alsr79"}}},"description":"Order Advanced Certificate Manager Certificate Pack response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/advanced_certificate_pack_response_single-M4alsr79"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Order Advanced Certificate Manager Certificate Pack response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Order Advanced Certificate Manager Certificate Pack","tags":["Certificate Packs"],"x-cfPermissionsRequired":{"enum":["#ssl:read","#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/ssl/certificate_packs/quota":{"get":{"description":"For a given zone, list certificate pack quotas.","operationId":"certificate-packs-get-certificate-pack-quotas","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificate_pack_quota_response"}}},"description":"Get Certificate Pack Quotas response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificate_pack_quota_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Certificate Pack Quotas response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Certificate Pack Quotas","tags":["Certificate Packs"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/ssl/certificate_packs/{identifier}":{"delete":{"description":"For a given zone, delete an advanced certificate pack.","operationId":"certificate-packs-delete-advanced-certificate-manager-certificate-pack","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/certificate-packs_components-schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/delete_advanced_certificate_pack_response_single-AepvbdfN"}}},"description":"Delete Advanced Certificate Manager Certificate Pack response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/delete_advanced_certificate_pack_response_single-AepvbdfN"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Advanced Certificate Manager Certificate Pack response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Advanced Certificate Manager Certificate Pack","tags":["Certificate Packs"],"x-cfPermissionsRequired":{"enum":["#ssl:read","#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"For a given zone, get a certificate pack.","operationId":"certificate-packs-get-certificate-pack","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/certificate-packs_components-schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/certificate_pack_response_single"}}},"description":"Get Certificate Pack response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/certificate_pack_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Certificate Pack response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Certificate Pack","tags":["Certificate Packs"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"For a given zone, restart validation for an advanced certificate pack. This is only a validation operation for a Certificate Pack in a validation_timed_out status.","operationId":"certificate-packs-restart-validation-for-advanced-certificate-manager-certificate-pack","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/certificate-packs_components-schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/advanced_certificate_pack_response_single-M4alsr79"}}},"description":"Restart Validation for Advanced Certificate Manager Certificate Pack response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/advanced_certificate_pack_response_single-M4alsr79"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Restart Validation for Advanced Certificate Manager Certificate Pack response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Restart Validation for Advanced Certificate Manager Certificate Pack","tags":["Certificate Packs"],"x-cfPermissionsRequired":{"enum":["#ssl:read","#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/ssl/recommendation":{"get":{"description":"Retrieve the SSL/TLS Recommender's recommendation for a zone.","operationId":"ssl/-tls-mode-recommendation-ssl/-tls-recommendation","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/id-6U71Robk"},"modified_on":{"$ref":"#/components/schemas/timestamp"},"value":{"$ref":"#/components/schemas/ssl-recommender_components-schemas-value"}}}}}]}}},"description":"SSL/TLS Recommendation response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/id-6U71Robk"},"modified_on":{"$ref":"#/components/schemas/timestamp"},"value":{"$ref":"#/components/schemas/ssl-recommender_components-schemas-value"}}}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"SSL/TLS Recommendation response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"SSL/TLS Recommendation","tags":["SSL/TLS Mode Recommendation"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/ssl/universal/settings":{"get":{"description":"Get Universal SSL Settings for a Zone.","operationId":"universal-ssl-settings-for-a-zone-universal-ssl-settings-details","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ssl_universal_settings_response"}}},"description":"Universal SSL Settings Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ssl_universal_settings_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Universal SSL Settings Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Universal SSL Settings Details","tags":["Universal SSL Settings for a Zone"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Patch Universal SSL Settings for a Zone.","operationId":"universal-ssl-settings-for-a-zone-edit-universal-ssl-settings","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/universal"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ssl_universal_settings_response"}}},"description":"Edit Universal SSL Settings response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ssl_universal_settings_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Edit Universal SSL Settings response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Edit Universal SSL Settings","tags":["Universal SSL Settings for a Zone"],"x-cfPermissionsRequired":{"enum":["#ssl:read","#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/ssl/verification":{"get":{"description":"Get SSL Verification Info for a Zone.","operationId":"ssl-verification-ssl-verification-details","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"retry","schema":{"description":"Immediately retry SSL Verification.","enum":[true],"example":true}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ssl_verification_response_collection"}}},"description":"SSL Verification Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ssl_verification_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"SSL Verification Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"SSL Verification Details","tags":["SSL Verification"],"x-cfPermissionsRequired":{"enum":["#ssl:read"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/ssl/verification/{cert_pack_uuid}":{"patch":{"description":"Edit SSL validation method for a certificate pack. A PATCH request will request an immediate validation check on any certificate, and return the updated status. If a validation method is provided, the validation will be immediately attempted using that method.","operationId":"ssl-verification-edit-ssl-certificate-pack-validation-method","parameters":[{"in":"path","name":"cert_pack_uuid","required":true,"schema":{"$ref":"#/components/schemas/cert_pack_uuid"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-validation_method"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ssl_validation_method_response_collection"}}},"description":"Edit SSL Certificate Pack Validation Method response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ssl_validation_method_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Edit SSL Certificate Pack Validation Method response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Edit SSL Certificate Pack Validation Method","tags":["SSL Verification"],"x-cfPermissionsRequired":{"enum":["#ssl:read","#ssl:edit"]},"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/waiting_rooms":{"get":{"description":"Lists waiting rooms.","operationId":"waiting-room-list-waiting-rooms","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-fzl1amog"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_collection-AZRlrYzF"}}},"description":"List waiting rooms response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_collection-AZRlrYzF"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List waiting rooms response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List waiting rooms","tags":["Waiting Room"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Creates a new waiting room.","operationId":"waiting-room-create-waiting-room","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-fzl1amog"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/query_waitingroom"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response-ZvEjOvIb"}}},"description":"Create waiting room response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response-ZvEjOvIb"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create waiting room response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create waiting room","tags":["Waiting Room"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/waiting_rooms/preview":{"post":{"description":"Creates a waiting room page preview. Upload a custom waiting room page for preview. You will receive a preview URL in the form `http://waitingrooms.dev/preview/\u003cuuid\u003e`. You can use the following query parameters to change the state of the preview:\n1. `force_queue`: Boolean indicating if all users will be queued in the waiting room and no one will be let into the origin website (also known as queueAll).\n2. `queue_is_full`: Boolean indicating if the waiting room's queue is currently full and not accepting new users at the moment.\n3. `queueing_method`: The queueing method currently used by the waiting room.\n\t- **fifo** indicates a FIFO queue.\n\t- **random** indicates a Random queue.\n\t- **passthrough** indicates a Passthrough queue. Keep in mind that the waiting room page will only be displayed if `force_queue=true` or `event=prequeueing` — for other cases the request will pass through to the origin. For our preview, this will be a fake origin website returning \"Welcome\". \n\t- **reject** indicates a Reject queue.\n4. `event`: Used to preview a waiting room event.\n\t- **none** indicates no event is occurring.\n\t- **prequeueing** indicates that an event is prequeueing (between `prequeue_start_time` and `event_start_time`).\n\t- **started** indicates that an event has started (between `event_start_time` and `event_end_time`).\n5. `shuffle_at_event_start`: Boolean indicating if the event will shuffle users in the prequeue when it starts. This can only be set to **true** if an event is active (`event` is not **none**).\n\nFor example, you can make a request to `http://waitingrooms.dev/preview/\u003cuuid\u003e?force_queue=false\u0026queue_is_full=false\u0026queueing_method=random\u0026event=started\u0026shuffle_at_event_start=true`\n6. `waitTime`: Non-zero, positive integer indicating the estimated wait time in minutes. The default value is 10 minutes.\n\nFor example, you can make a request to `http://waitingrooms.dev/preview/\u003cuuid\u003e?waitTime=50` to configure the estimated wait time as 50 minutes.","operationId":"waiting-room-create-a-custom-waiting-room-page-preview","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-fzl1amog"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/query_preview"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/preview_response"}}},"description":"Create a custom waiting room page preview response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/preview_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create a custom waiting room page preview response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create a custom waiting room page preview","tags":["Waiting Room"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}":{"delete":{"description":"Deletes a waiting room.","operationId":"waiting-room-delete-waiting-room","parameters":[{"in":"path","name":"waiting_room_id","required":true,"schema":{"$ref":"#/components/schemas/waiting_room_id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-fzl1amog"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waiting_room_id_response"}}},"description":"Delete waiting room response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/waiting_room_id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete waiting room response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete waiting room","tags":["Waiting Room"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Fetches a single configured waiting room.","operationId":"waiting-room-waiting-room-details","parameters":[{"in":"path","name":"waiting_room_id","required":true,"schema":{"$ref":"#/components/schemas/waiting_room_id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-fzl1amog"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response-ZvEjOvIb"}}},"description":"Waiting room details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response-ZvEjOvIb"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Waiting room details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Waiting room details","tags":["Waiting Room"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"patch":{"description":"Patches a configured waiting room.","operationId":"waiting-room-patch-waiting-room","parameters":[{"in":"path","name":"waiting_room_id","required":true,"schema":{"$ref":"#/components/schemas/waiting_room_id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-fzl1amog"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/query_waitingroom"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response-ZvEjOvIb"}}},"description":"Patch waiting room response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response-ZvEjOvIb"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Patch waiting room response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Patch waiting room","tags":["Waiting Room"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Updates a configured waiting room.","operationId":"waiting-room-update-waiting-room","parameters":[{"in":"path","name":"waiting_room_id","required":true,"schema":{"$ref":"#/components/schemas/waiting_room_id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-fzl1amog"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/query_waitingroom"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response-ZvEjOvIb"}}},"description":"Update waiting room response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response-ZvEjOvIb"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update waiting room response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update waiting room","tags":["Waiting Room"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events":{"get":{"description":"Lists events for a waiting room.","operationId":"waiting-room-list-events","parameters":[{"in":"path","name":"waiting_room_id","required":true,"schema":{"$ref":"#/components/schemas/waiting_room_id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-fzl1amog"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/event_response_collection"}}},"description":"List events response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/event_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List events response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List events","tags":["Waiting Room"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Only available for the Waiting Room Advanced subscription. Creates an event for a waiting room. An event takes place during a specified period of time, temporarily changing the behavior of a waiting room. While the event is active, some of the properties in the event's configuration may either override or inherit from the waiting room's configuration. Note that events cannot overlap with each other, so only one event can be active at a time.","operationId":"waiting-room-create-event","parameters":[{"in":"path","name":"waiting_room_id","required":true,"schema":{"$ref":"#/components/schemas/waiting_room_id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-fzl1amog"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/query_event"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/event_response"}}},"description":"Create event response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/event_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create event response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create event","tags":["Waiting Room"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events/{event_id}":{"delete":{"description":"Deletes an event for a waiting room.","operationId":"waiting-room-delete-event","parameters":[{"in":"path","name":"event_id","required":true,"schema":{"$ref":"#/components/schemas/event_id"}},{"in":"path","name":"waiting_room_id","required":true,"schema":{"$ref":"#/components/schemas/waiting_room_id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-fzl1amog"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/event_id_response"}}},"description":"Delete event response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/event_id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete event response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete event","tags":["Waiting Room"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"description":"Fetches a single configured event for a waiting room.","operationId":"waiting-room-event-details","parameters":[{"in":"path","name":"event_id","required":true,"schema":{"$ref":"#/components/schemas/event_id"}},{"in":"path","name":"waiting_room_id","required":true,"schema":{"$ref":"#/components/schemas/waiting_room_id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-fzl1amog"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/event_response"}}},"description":"Event details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/event_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Event details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Event details","tags":["Waiting Room"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"patch":{"description":"Patches a configured event for a waiting room.","operationId":"waiting-room-patch-event","parameters":[{"in":"path","name":"event_id","required":true,"schema":{"$ref":"#/components/schemas/event_id"}},{"in":"path","name":"waiting_room_id","required":true,"schema":{"$ref":"#/components/schemas/waiting_room_id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-fzl1amog"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/query_event"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/event_response"}}},"description":"Patch event response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/event_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Patch event response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Patch event","tags":["Waiting Room"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Updates a configured event for a waiting room.","operationId":"waiting-room-update-event","parameters":[{"in":"path","name":"event_id","required":true,"schema":{"$ref":"#/components/schemas/event_id"}},{"in":"path","name":"waiting_room_id","required":true,"schema":{"$ref":"#/components/schemas/waiting_room_id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-fzl1amog"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/query_event"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/event_response"}}},"description":"Update event response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/event_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update event response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update event","tags":["Waiting Room"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events/{event_id}/details":{"get":{"description":"Previews an event's configuration as if it was active. Inherited fields from the waiting room will be displayed with their current values.","operationId":"waiting-room-preview-active-event-details","parameters":[{"in":"path","name":"event_id","required":true,"schema":{"$ref":"#/components/schemas/event_id"}},{"in":"path","name":"waiting_room_id","required":true,"schema":{"$ref":"#/components/schemas/waiting_room_id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-fzl1amog"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/event_details_response"}}},"description":"Preview active event details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/event_details_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Preview active event details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Preview active event details","tags":["Waiting Room"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/rules":{"get":{"description":"Lists rules for a waiting room.","operationId":"waiting-room-list-waiting-room-rules","parameters":[{"in":"path","name":"waiting_room_id","required":true,"schema":{"$ref":"#/components/schemas/waiting_room_id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-fzl1amog"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rules_response_collection"}}},"description":"List Waiting Room Rules response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rules_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Waiting Room Rules response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Waiting Room Rules","tags":["Waiting Room"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Only available for the Waiting Room Advanced subscription. Creates a rule for a waiting room.","operationId":"waiting-room-create-waiting-room-rule","parameters":[{"in":"path","name":"waiting_room_id","required":true,"schema":{"$ref":"#/components/schemas/waiting_room_id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-fzl1amog"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_rule"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rules_response_collection"}}},"description":"Create Waiting Room Rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rules_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Waiting Room Rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Waiting Room Rule","tags":["Waiting Room"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"description":"Only available for the Waiting Room Advanced subscription. Replaces all rules for a waiting room.","operationId":"waiting-room-replace-waiting-room-rules","parameters":[{"in":"path","name":"waiting_room_id","required":true,"schema":{"$ref":"#/components/schemas/waiting_room_id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-fzl1amog"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_rules"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rules_response_collection"}}},"description":"Replace Waiting Room Rules response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rules_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Replace Waiting Room Rules response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Replace Waiting Room Rules","tags":["Waiting Room"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/rules/{rule_id}":{"delete":{"description":"Deletes a rule for a waiting room.","operationId":"waiting-room-delete-waiting-room-rule","parameters":[{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/rule_id"}},{"in":"path","name":"waiting_room_id","required":true,"schema":{"$ref":"#/components/schemas/waiting_room_id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-fzl1amog"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rules_response_collection"}}},"description":"Delete Waiting Room Rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rules_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Waiting Room Rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Waiting Room Rule","tags":["Waiting Room"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"patch":{"description":"Patches a rule for a waiting room.","operationId":"waiting-room-patch-waiting-room-rule","parameters":[{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/rule_id"}},{"in":"path","name":"waiting_room_id","required":true,"schema":{"$ref":"#/components/schemas/waiting_room_id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-fzl1amog"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/patch_rule"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rules_response_collection"}}},"description":"Patch Waiting Room Rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rules_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Patch Waiting Room Rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Patch Waiting Room Rule","tags":["Waiting Room"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/status":{"get":{"description":"Fetches the status of a configured waiting room. Response fields include:\n1. `status`: String indicating the status of the waiting room. The possible status are:\n\t- **not_queueing** indicates that the configured thresholds have not been met and all users are going through to the origin.\n\t- **queueing** indicates that the thresholds have been met and some users are held in the waiting room.\n\t- **event_prequeueing** indicates that an event is active and is currently prequeueing users before it starts.\n2. `event_id`: String of the current event's `id` if an event is active, otherwise an empty string.\n3. `estimated_queued_users`: Integer of the estimated number of users currently waiting in the queue.\n4. `estimated_total_active_users`: Integer of the estimated number of users currently active on the origin.\n5. `max_estimated_time_minutes`: Integer of the maximum estimated time currently presented to the users.","operationId":"waiting-room-get-waiting-room-status","parameters":[{"in":"path","name":"waiting_room_id","required":true,"schema":{"$ref":"#/components/schemas/waiting_room_id"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/identifier-fzl1amog"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/status_response"}}},"description":"Get waiting room status response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/status_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get waiting room status response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get waiting room status","tags":["Waiting Room"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/web3/hostnames":{"get":{"operationId":"web3-hostname-list-web3-hostnames","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-collection_response"}}},"description":"List Web3 Hostnames response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Web3 Hostnames response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Web3 Hostnames","tags":["Web3 Hostname"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"operationId":"web3-hostname-create-web3-hostname","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/web3-hostname_components-schemas-single_response"}}},"description":"Create Web3 Hostname response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/web3-hostname_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Web3 Hostname response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Web3 Hostname","tags":["Web3 Hostname"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/web3/hostnames/{identifier}":{"delete":{"operationId":"web3-hostname-delete-web3-hostname","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single-id-u7jsvBJu"}}},"description":"Delete Web3 Hostname response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single-id-u7jsvBJu"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Web3 Hostname response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Web3 Hostname","tags":["Web3 Hostname"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"operationId":"web3-hostname-web3-hostname-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/web3-hostname_components-schemas-single_response"}}},"description":"Web3 Hostname Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/web3-hostname_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Web3 Hostname Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Web3 Hostname Details","tags":["Web3 Hostname"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"operationId":"web3-hostname-edit-web3-hostname","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/modify_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/web3-hostname_components-schemas-single_response"}}},"description":"Edit Web3 Hostname response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/web3-hostname_components-schemas-single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Edit Web3 Hostname response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Edit Web3 Hostname","tags":["Web3 Hostname"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list":{"get":{"operationId":"web3-hostname-ipfs-universal-path-gateway-content-list-details","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/content_list_details_response"}}},"description":"IPFS Universal Path Gateway Content List Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/content_list_details_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"IPFS Universal Path Gateway Content List Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"IPFS Universal Path Gateway Content List Details","tags":["Web3 Hostname"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"operationId":"web3-hostname-update-ipfs-universal-path-gateway-content-list","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/content_list_update_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/content_list_details_response"}}},"description":"Update IPFS Universal Path Gateway Content List response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/content_list_details_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update IPFS Universal Path Gateway Content List response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update IPFS Universal Path Gateway Content List","tags":["Web3 Hostname"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries":{"get":{"operationId":"web3-hostname-list-ipfs-universal-path-gateway-content-list-entries","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/content_list_entry_collection_response"}}},"description":"List IPFS Universal Path Gateway Content List Entries response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/content_list_entry_collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List IPFS Universal Path Gateway Content List Entries response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List IPFS Universal Path Gateway Content List Entries","tags":["Web3 Hostname"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"operationId":"web3-hostname-create-ipfs-universal-path-gateway-content-list-entry","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/content_list_entry_create_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/content_list_entry_single_response"}}},"description":"Create IPFS Universal Path Gateway Content List Entry response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/content_list_entry_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create IPFS Universal Path Gateway Content List Entry response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create IPFS Universal Path Gateway Content List Entry","tags":["Web3 Hostname"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries/{content_list_entry_identifier}":{"delete":{"operationId":"web3-hostname-delete-ipfs-universal-path-gateway-content-list-entry","parameters":[{"in":"path","name":"content_list_entry_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single-id-u7jsvBJu"}}},"description":"Delete IPFS Universal Path Gateway Content List Entry response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single-id-u7jsvBJu"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete IPFS Universal Path Gateway Content List Entry response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete IPFS Universal Path Gateway Content List Entry","tags":["Web3 Hostname"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"operationId":"web3-hostname-ipfs-universal-path-gateway-content-list-entry-details","parameters":[{"in":"path","name":"content_list_entry_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/content_list_entry_single_response"}}},"description":"IPFS Universal Path Gateway Content List Entry Details response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/content_list_entry_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"IPFS Universal Path Gateway Content List Entry Details response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"IPFS Universal Path Gateway Content List Entry Details","tags":["Web3 Hostname"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"operationId":"web3-hostname-edit-ipfs-universal-path-gateway-content-list-entry","parameters":[{"in":"path","name":"content_list_entry_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/content_list_entry_create_request"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/content_list_entry_single_response"}}},"description":"Edit IPFS Universal Path Gateway Content List Entry response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/content_list_entry_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Edit IPFS Universal Path Gateway Content List Entry response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Edit IPFS Universal Path Gateway Content List Entry","tags":["Web3 Hostname"],"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_identifier}/workers/script":{"delete":{"deprecated":true,"description":"Delete your worker. This call has no response body on a successful delete.","operationId":"worker-script-(-deprecated)-delete-worker","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{}},"description":"Delete Worker response"},"4xx":{"content":{"application/json":{}},"description":"Delete Worker response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Worker","tags":["Worker Script (Deprecated)"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs. These APIs are for use with the previously limited single-script zones.","display":true,"id":"worker_script_deprecation"}},"get":{"deprecated":true,"description":"Fetch raw script content for your worker. Note this is the original script content, not JSON encoded.","operationId":"worker-script-(-deprecated)-download-worker","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"undefined":{"schema":{"example":"addEventListener('fetch', event =\u003e { event.respondWith(fetch(event.request)) })"}}},"description":"Download Worker response"},"4xx":{"content":{"undefined":{"schema":{"example":"addEventListener('fetch', event =\u003e { event.respondWith(fetch(event.request)) })"}}},"description":"Download Worker response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Download Worker","tags":["Worker Script (Deprecated)"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs. These APIs are for use with the previously limited single-script zones.","display":true,"id":"worker_script_deprecation"}},"put":{"deprecated":true,"description":"Upload a worker, or a new version of a worker.","operationId":"worker-script-(-deprecated)-upload-worker","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/javascript":{"schema":{"example":"addEventListener('fetch', event =\u003e { event.respondWith(fetch(event.request)) })"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/script-response-single-qkojssqp"}}},"description":"Upload Worker response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/script-response-single-qkojssqp"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Upload Worker response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Upload Worker","tags":["Worker Script (Deprecated)"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs. These APIs are for use with the previously limited single-script zones.","display":true,"id":"worker_script_deprecation"}}},"/zones/{zone_identifier}/workers/script/bindings":{"get":{"deprecated":true,"description":"List the bindings for a Workers script.","operationId":"worker-binding-(-deprecated)-list-bindings","parameters":[{"in":"path","name":"zone_identifier","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/binding"},"type":"array"}},"type":"object"}]}}},"description":"List Bindings response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-common"},{"properties":{"result":{"items":{"$ref":"#/components/schemas/binding"},"type":"array"}},"type":"object"}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Bindings response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Bindings","tags":["Worker Binding (Deprecated)"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs. These APIs are for use with the previously limited single-script zones.","display":true,"id":"worker_binding_deprecation"}}},"/zones/{zone_id}/activation_check":{"put":{"description":"Triggeres a new activation check for a PENDING Zone. This can be\ntriggered every 5 min for paygo/ent customers, every hour for FREE\nZones.","operationId":"put-zones-zone_id-activation_check","parameters":[{"description":"Zone ID","in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/identifier-JiolAARC"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/identifier-JiolAARC"}},"type":"object"}},"type":"object"}]}}},"description":"Successful Response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Client Error"}},"summary":"Rerun the Activation Check","tags":["Client"]}},"/zones/{zone_id}/api_gateway/configuration":{"get":{"operationId":"api-shield-settings-retrieve-information-about-specific-configuration-properties","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"properties","schema":{"$ref":"#/components/schemas/properties"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/single_response-lMJq2fgM"}}},"description":"Retrieve information about specific configuration properties response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/single_response-lMJq2fgM"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Retrieve information about specific configuration properties response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Retrieve information about specific configuration properties","tags":["API Shield Settings"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.zone.api-gateway.read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"put":{"operationId":"api-shield-settings-set-configuration-properties","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/configuration"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/default_response"}}},"description":"Set configuration properties response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/default_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Set configuration properties response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Set configuration properties","tags":["API Shield Settings"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.zone.api-gateway.update"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/api_gateway/discovery":{"get":{"description":"Retrieve the most up to date view of API Discovery on a zone.","operationId":"api-shield-endpoint-management-retrieve-api-discovery-results-for-a-zone","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schema_response_discovery"}}},"description":"Retrieve API Discovery results for a zone response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schema_response_discovery"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Retrieve API Discovery results for a zone response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Retrieve API Discovery results for a zone","tags":["API Shield Endpoint Management"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.zone.api-gateway.read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/api_gateway/operations":{"get":{"operationId":"api-shield-endpoint-management-retrieve-information-about-all-operations-on-a-zone","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"per_page","schema":{"$ref":"#/components/schemas/per_page"}},{"in":"query","name":"order","schema":{"description":"Field to order by. When requesting a feature, the feature keys are available for ordering as well, e.g., thresholds.suggested_threshold.","enum":["method","host","endpoint","thresholds.$key"],"example":"method","type":"string"}},{"in":"query","name":"host","schema":{"description":"Filter results to only include the specified hosts.","items":{"example":"api.cloudflare.com","type":"string"},"type":"array","uniqueItems":true}},{"in":"query","name":"method","schema":{"description":"Filter results to only include the specified HTTP methods.","items":{"example":"GET","type":"string"},"type":"array","uniqueItems":true}},{"in":"query","name":"endpoint","schema":{"description":"Filter results to only include endpoints containing this pattern.","example":"/api/v1","type":"string"}},{"in":"query","name":"page","schema":{"default":1,"description":"Page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"feature","schema":{"description":"Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.","example":["thresholds"],"items":{"enum":["thresholds","parameter_schemas"],"example":"thresholds","type":"string"},"type":"array","uniqueItems":true}},{"in":"query","name":"direction","schema":{"description":"Direction to order results.","enum":["asc","desc"],"example":"desc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/collection_response_paginated"}}},"description":"Retrieve information about all operations on a zone response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/collection_response_paginated"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Retrieve information about all operations on a zone response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Retrieve information about all operations on a zone","tags":["API Shield Endpoint Management"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.zone.api-gateway.read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"post":{"description":"Add one or more operations to a zone. Endpoints can contain path variables. Host, method, endpoint will be normalized to a canoncial form when creating an operation and must be unique on the zone. Inserting an operation that matches an existing one will return the record of the already existing operation and update its last_updated date.","operationId":"api-shield-endpoint-management-add-operations-to-a-zone","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"properties":{"endpoint":{"$ref":"#/components/schemas/endpoint"},"host":{"$ref":"#/components/schemas/host-nm3Leu3G"},"method":{"$ref":"#/components/schemas/method"}},"type":"object"},"required":["host","method","endpoint"],"type":"array"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/collection_response"}}},"description":"Add operations to a zone response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Add operations to a zone response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Add operations to a zone","tags":["API Shield Endpoint Management"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.zone.api-gateway.create"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/api_gateway/operations/{operation_id}":{"delete":{"operationId":"api-shield-endpoint-management-delete-an-operation","parameters":[{"in":"path","name":"operation_id","required":true,"schema":{"$ref":"#/components/schemas/uuid-s0SXln0q"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/default_response"}}},"description":"Delete an operation response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/default_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete an operation response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete an operation","tags":["API Shield Endpoint Management"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.zone.api-gateway.delete"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}},"get":{"operationId":"api-shield-endpoint-management-retrieve-information-about-an-operation","parameters":[{"in":"path","name":"operation_id","required":true,"schema":{"$ref":"#/components/schemas/uuid-s0SXln0q"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"feature","schema":{"description":"Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.","example":["thresholds"],"items":{"enum":["thresholds","parameter_schemas"],"example":"thresholds","type":"string"},"type":"array","uniqueItems":true}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-single_response-h7shsYQI"}}},"description":"Retrieve information about an operation response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-single_response-h7shsYQI"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Retrieve information about an operation response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Retrieve information about an operation","tags":["API Shield Endpoint Management"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.zone.api-gateway.read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/api_gateway/schemas":{"get":{"operationId":"api-shield-endpoint-management-retrieve-operations-and-features-as-open-api-schemas","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"host","schema":{"description":"Receive schema only for the given host(s).","items":{"example":"www.example.com","type":"string"},"type":"array","uniqueItems":true}},{"in":"query","name":"feature","schema":{"description":"Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.","example":["thresholds"],"items":{"enum":["thresholds","parameter_schemas"],"example":"thresholds","type":"string"},"type":"array","uniqueItems":true}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schema_response_with_thresholds"}}},"description":"Retrieve operations and features as OpenAPI schemas response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schema_response_with_thresholds"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Retrieve operations and features as OpenAPI schemas response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Retrieve operations and features as OpenAPI schemas","tags":["API Shield Endpoint Management"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.api.account.zone.api-gateway.read"]},"x-cfPlanAvailability":{"business":false,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/firewall/access_rules/rules":{"get":{"description":"Fetches IP Access rules of a zone. You can filter the results using several optional parameters.","operationId":"ip-access-rules-for-a-zone-list-ip-access-rules","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"filters","schema":{"$ref":"#/components/schemas/schemas-filters"}},{"in":"query","name":"egs-pagination.json","schema":{"$ref":"#/components/schemas/egs-pagination"}},{"in":"query","name":"page","schema":{"description":"Requested page within paginated list of results.","example":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"description":"Maximum number of results requested.","example":20,"type":"number"}},{"in":"query","name":"order","schema":{"description":"The field used to sort returned rules.","enum":["configuration.target","configuration.value","mode"],"example":"mode","type":"string"}},{"in":"query","name":"direction","schema":{"description":"The direction used to sort returned rules.","enum":["asc","desc"],"example":"desc","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_collection_response"}}},"description":"List IP Access rules response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rule_collection_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List IP Access rules response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List IP Access rules","tags":["IP Access rules for a zone"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Creates a new IP Access rule for a zone.\n\nNote: To create an IP Access rule that applies to multiple zones, refer to [IP Access rules for a user](#ip-access-rules-for-a-user) or [IP Access rules for an account](#ip-access-rules-for-an-account) as appropriate.","operationId":"ip-access-rules-for-a-zone-create-an-ip-access-rule","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"configuration":{"$ref":"#/components/schemas/schemas-configuration"},"mode":{"$ref":"#/components/schemas/schemas-mode"},"notes":{"$ref":"#/components/schemas/notes"}},"required":["mode","configuration","notes"]}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_single_response"}}},"description":"Create an IP Access rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rule_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create an IP Access rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create an IP Access rule","tags":["IP Access rules for a zone"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/firewall/access_rules/rules/{identifier}":{"delete":{"description":"Deletes an IP Access rule defined at the zone level.\n\nOptionally, you can use the `cascade` property to specify that you wish to delete similar rules in other zones managed by the same zone owner.","operationId":"ip-access-rules-for-a-zone-delete-an-ip-access-rule","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/rule_components-schemas-identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"cascade":{"default":"none","description":"The level to attempt to delete similar rules defined for other zones with the same owner. The default value is `none`, which will only delete the current rule. Using `basic` will delete rules that match the same action (mode) and configuration, while using `aggressive` will delete rules that match the same configuration.","enum":["none","basic","aggressive"],"type":"string"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_single_id_response"}}},"description":"Delete an IP Access rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rule_single_id_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete an IP Access rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete an IP Access rule","tags":["IP Access rules for a zone"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Updates an IP Access rule defined at the zone level. You can only update the rule action (`mode` parameter) and notes.","operationId":"ip-access-rules-for-a-zone-update-an-ip-access-rule","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/rule_components-schemas-identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"mode":{"$ref":"#/components/schemas/schemas-mode"},"notes":{"$ref":"#/components/schemas/notes"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_single_response"}}},"description":"Update an IP Access rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rule_single_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update an IP Access rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update an IP Access rule","tags":["IP Access rules for a zone"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/firewall/waf/packages/{package_id}/rules":{"get":{"description":"Fetches WAF rules in a WAF package.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).","operationId":"waf-rules-list-waf-rules","parameters":[{"in":"path","name":"package_id","required":true,"schema":{"$ref":"#/components/schemas/package_components-schemas-identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"mode","schema":{"description":"The action/mode a rule has been overridden to perform.","enum":["DIS","CHL","BLK","SIM"],"example":"CHL","type":"string"}},{"in":"query","name":"group_id","schema":{"$ref":"#/components/schemas/group_components-schemas-identifier"}},{"in":"query","name":"page","schema":{"default":1,"description":"The page number of paginated results.","minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":50,"description":"The number of rules per page.","maximum":100,"minimum":5,"type":"number"}},{"in":"query","name":"order","schema":{"description":"The field used to sort returned rules.","enum":["priority","group_id","description"],"example":"status","type":"string"}},{"in":"query","name":"direction","schema":{"description":"The direction used to sort returned rules.","enum":["asc","desc"],"example":"desc","type":"string"}},{"in":"query","name":"match","schema":{"default":"all","description":"When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match.","enum":["any","all"],"type":"string"}},{"in":"query","name":"description","schema":{"description":"The public description of the WAF rule.","example":"SQL injection prevention for SELECT statements","readOnly":true,"type":"string"}},{"in":"query","name":"priority","schema":{"description":"The order in which the individual WAF rule is executed within its rule group.","readOnly":true,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_response_collection"}}},"description":"List WAF rules response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rule_response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List WAF rules response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List WAF rules","tags":["WAF rules"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_id}/firewall/waf/packages/{package_id}/rules/{identifier}":{"get":{"description":"Fetches the details of a WAF rule in a WAF package.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).","operationId":"waf-rules-get-a-waf-rule","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/rule_components-schemas-identifier-2"}},{"in":"path","name":"package_id","required":true,"schema":{"$ref":"#/components/schemas/package_components-schemas-identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rule_response_single"}}},"description":"Get a WAF rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rule_response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get a WAF rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a WAF rule","tags":["WAF rules"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"patch":{"description":"Updates a WAF rule. You can only update the mode/action of the rule.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).","operationId":"waf-rules-update-a-waf-rule","parameters":[{"in":"path","name":"identifier","required":true,"schema":{"$ref":"#/components/schemas/rule_components-schemas-identifier-2"}},{"in":"path","name":"package_id","required":true,"schema":{"$ref":"#/components/schemas/package_components-schemas-identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"mode":{"description":"The mode/action of the rule when triggered. You must use a value from the `allowed_modes` array of the current rule.","enum":["default","disable","simulate","block","challenge","on","off"],"example":"on"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rule_response_single"},{"properties":{"result":{"oneOf":[{"$ref":"#/components/schemas/anomaly_rule"},{"$ref":"#/components/schemas/traditional_deny_rule"},{"$ref":"#/components/schemas/traditional_allow_rule"}]}}}]}}},"description":"Update a WAF rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/rule_response_single"},{"properties":{"result":{"oneOf":[{"$ref":"#/components/schemas/anomaly_rule"},{"$ref":"#/components/schemas/traditional_deny_rule"},{"$ref":"#/components/schemas/traditional_allow_rule"}]}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update a WAF rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update a WAF rule","tags":["WAF rules"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_id}/managed_headers":{"get":{"description":"Fetches a list of all Managed Transforms.","operationId":"managed-transforms-list-managed-transforms","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"managed_request_headers":{"$ref":"#/components/schemas/request_list"},"managed_response_headers":{"$ref":"#/components/schemas/request_list"}},"type":"object"}}},"description":"List Managed Transforms response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"properties":{"managed_request_headers":{"$ref":"#/components/schemas/request_list"},"managed_response_headers":{"$ref":"#/components/schemas/request_list"}},"type":"object"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Managed Transforms response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Managed Transforms","tags":["Managed Transforms"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Updates the status of one or more Managed Transforms.","operationId":"managed-transforms-update-status-of-managed-transforms","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"managed_request_headers":{"$ref":"#/components/schemas/request_list"},"managed_response_headers":{"$ref":"#/components/schemas/request_list"}},"required":["managed_request_headers","managed_response_headers"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"managed_request_headers":{"$ref":"#/components/schemas/response_list"},"managed_response_headers":{"$ref":"#/components/schemas/response_list"}},"type":"object"}}},"description":"Update status of Managed Transforms response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"properties":{"managed_request_headers":{"$ref":"#/components/schemas/response_list"},"managed_response_headers":{"$ref":"#/components/schemas/response_list"}},"type":"object"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update status of Managed Transforms response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update status of Managed Transforms","tags":["Managed Transforms"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/page_shield":{"get":{"description":"Fetches the Page Shield settings.","operationId":"page-shield-get-page-shield-settings","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/identifier-jnfvAiHn"}}],"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/get-zone-settings-response"}}}]}}},"description":"Get Page Shield settings response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/get-zone-settings-response"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Page Shield settings response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Page Shield settings","tags":["Page Shield"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}},"put":{"description":"Updates Page Shield settings.","operationId":"page-shield-update-page-shield-settings","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/identifier-jnfvAiHn"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"enabled":{"$ref":"#/components/schemas/enabled-N6CliIvj"},"use_cloudflare_reporting_endpoint":{"$ref":"#/components/schemas/use_cloudflare_reporting_endpoint"},"use_connection_url_path":{"$ref":"#/components/schemas/use_connection_url_path"}}}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/update-zone-settings-response"}}}]}}},"description":"Update Page Shield settings response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/zone_settings_response_single"},{"properties":{"result":{"$ref":"#/components/schemas/update-zone-settings-response"}}}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Page Shield settings response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Page Shield settings","tags":["Page Shield"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_id}/page_shield/connections":{"get":{"description":"Lists all connections detected by Page Shield.","operationId":"page-shield-list-page-shield-connections","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/identifier-jnfvAiHn"}},{"in":"query","name":"exclude_urls","schema":{"description":"Excludes connections whose URL contains one the URL-encoded URL substrings (separated by commas) from the returned connections.","example":"blog.cloudflare.com,www.example","type":"string"}},{"in":"query","name":"urls","schema":{"description":"Filters the returned connections by one or more URL-encoded URL substrings separated by commas.","example":"blog.cloudflare.com,www.example","type":"string"}},{"in":"query","name":"hosts","schema":{"description":"Filters the returned connections by one or more URL-encoded hostname substrings separated by commas.","example":"blog.cloudflare.com,www.example","type":"string"}},{"in":"query","name":"page","schema":{"description":"The current page number of the paginated results.","example":2,"minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"description":"The number of results per page.","example":100,"maximum":100,"minimum":1,"type":"number"}},{"in":"query","name":"order_by","schema":{"description":"The field used to sort returned connections.","enum":["first_seen_at","last_seen_at"],"example":"first_seen_at","type":"string"}},{"in":"query","name":"direction","schema":{"description":"The direction used to sort returned connections.","enum":["asc","desc"],"example":"asc","type":"string"}},{"in":"query","name":"prioritize_malicious","schema":{"description":"When true, malicious connections appear first in the returned connections.","example":true,"type":"boolean"}},{"in":"query","name":"exclude_cdn_cgi","schema":{"description":"When true, excludes connections seen in a `/cdn-cgi` path from the returned connections. The default value is true.","example":true,"type":"boolean"}},{"in":"query","name":"status","schema":{"description":"Filters the returned connections using a comma-separated list of connection statuses. Accepted values: `active`, `infrequent`, and `inactive`. The default value is `active`.","example":"active,inactive","type":"string"}},{"in":"query","name":"page_url","schema":{"description":"Filters the returned connections by the page URL where they were last seen.","example":"example.com/page","type":"string"}},{"in":"query","name":"export","schema":{"description":"Export the list of connections as a file. Cannot be used with per_page or page options.","enum":["csv"],"example":"csv","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/list-zone-connections-response"}}},"description":"List Page Shield connections response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/list-zone-connections-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Page Shield connections response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Page Shield connections","tags":["Page Shield"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/page_shield/connections/{id}":{"get":{"description":"Fetches a connection detected by Page Shield by connection ID.","operationId":"page-shield-get-a-page-shield-connection","parameters":[{"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/id-ZJpijMo1"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/identifier-jnfvAiHn"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get-zone-connection-response"}}},"description":"Get a Page Shield connection response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/get-zone-connection-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get a Page Shield connection response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a Page Shield connection","tags":["Page Shield"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":false}}},"/zones/{zone_id}/page_shield/scripts":{"get":{"description":"Lists all scripts detected by Page Shield.","operationId":"page-shield-list-page-shield-scripts","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/identifier-jnfvAiHn"}},{"in":"query","name":"exclude_urls","schema":{"description":"Excludes scripts whose URL contains one the URL-encoded URL substrings (separated by commas) from the returned scripts.","example":"blog.cloudflare.com,www.example","type":"string"}},{"in":"query","name":"urls","schema":{"description":"Filters the returned scripts by one or more URL-encoded URL substrings separated by commas.","example":"blog.cloudflare.com,www.example","type":"string"}},{"in":"query","name":"hosts","schema":{"description":"Filters the returned scripts by one or more URL-encoded hostname substrings separated by commas.","example":"blog.cloudflare.com,www.example","type":"string"}},{"in":"query","name":"page","schema":{"description":"The current page number of the paginated results.","example":2,"minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"description":"The number of results per page.","example":100,"maximum":100,"minimum":1,"type":"number"}},{"in":"query","name":"order_by","schema":{"description":"The field used to sort returned scripts.","enum":["first_seen_at","last_seen_at"],"example":"first_seen_at","type":"string"}},{"in":"query","name":"direction","schema":{"description":"The direction used to sort returned scripts.","enum":["asc","desc"],"example":"asc","type":"string"}},{"in":"query","name":"prioritize_malicious","schema":{"description":"When true, malicious scripts appear first in the returned scripts.","example":true,"type":"boolean"}},{"in":"query","name":"exclude_cdn_cgi","schema":{"description":"When true, excludes scripts seen in a `/cdn-cgi` path from the returned scripts. The default value is true.","example":true,"type":"boolean"}},{"in":"query","name":"status","schema":{"description":"Filters the returned scripts using a comma-separated list of scripts statuses. Accepted values: `active`, `infrequent`, and `inactive`. The default value is `active`.","example":"active,inactive","type":"string"}},{"in":"query","name":"page_url","schema":{"description":"Filters the returned scripts by the page URL where they were last seen.","example":"example.com/page","type":"string"}},{"in":"query","name":"export","schema":{"description":"Export the list of scripts as a file. Cannot be used with per_page or page options.","enum":["csv"],"example":"csv","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/list-zone-scripts-response"}}},"description":"List Page Shield scripts response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/list-zone-scripts-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Page Shield scripts response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Page Shield scripts","tags":["Page Shield"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_id}/page_shield/scripts/{id}":{"get":{"description":"Fetches a script detected by Page Shield by script ID.","operationId":"page-shield-get-a-page-shield-script","parameters":[{"in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/id-ZJpijMo1"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/identifier-jnfvAiHn"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/get-zone-script-response"}}},"description":"Get a Page Shield script response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/get-zone-script-response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get a Page Shield script response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a Page Shield script","tags":["Page Shield"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":false,"pro":true}}},"/zones/{zone_id}/rulesets":{"get":{"description":"Fetches all rulesets at the zone level.","operationId":"zone-rulesets-list-zone-rulesets","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rulesets_response"}}},"description":"List zone rulesets response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rulesets_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List zone rulesets response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List zone rulesets","tags":["Zone Rulesets"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"post":{"description":"Creates a ruleset at the zone level.","operationId":"zone-rulesets-create-a-zone-ruleset","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_ruleset"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}},"description":"Create a zone ruleset response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create a zone ruleset response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create a zone ruleset","tags":["Zone Rulesets"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/rulesets/phases/http_config_settings/entrypoint":{"get":{"description":"Fetches all Config Rules in a zone.","operationId":"config-rules-list-config-rules","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/config-rules_components-schemas-ruleset"}}},"description":"List Config Rules response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/config-rules_components-schemas-ruleset"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Config Rules response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Config Rules","tags":["Config Rules"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Updates the Config Rules of a zone.","operationId":"config-rules-update-config-rules","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_ruleset"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single"}}},"description":"Update Config Rules response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Config Rules response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Config Rules","tags":["Config Rules"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/rulesets/phases/http_custom_errors/entrypoint":{"get":{"description":"Fetches all Custom Error Responses in a zone.","operationId":"custom-error-responses-get-custom-error-responses","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom-error-responses_components-schemas-ruleset"}}},"description":"Get Custom Error Responses response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/custom-error-responses_components-schemas-ruleset"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Custom Error Responses response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Custom Error Responses","tags":["Custom Error Responses"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Updates the Custom Error Responses of a zone.","operationId":"custom-error-responses-update-custom-error-responses","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_ruleset"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single"}}},"description":"Update Custom Error Responses response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Custom Error Responses response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Custom Error Responses","tags":["Custom Error Responses"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/rulesets/phases/http_request_cache_settings/entrypoint":{"get":{"description":"Fetches all Cache Rules in a zone.","operationId":"cache-rules-list-cache-rules","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/cache-rules_components-schemas-ruleset"}}},"description":"List Cache Rules response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/cache-rules_components-schemas-ruleset"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Cache Rules response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Cache Rules","tags":["Cache Rules"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Updates the Cache Rules of a zone.","operationId":"cache-rules-update-cache-rules","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_ruleset"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single"}}},"description":"Update Cache Rules response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Cache Rules response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Cache Rules","tags":["Cache Rules"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/rulesets/phases/http_request_dynamic_redirect/entrypoint":{"get":{"description":"Fetches all Single Redirect Rules in a zone.","operationId":"single-redirect-rules-list-single-redirect-rules","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-ruleset"}}},"description":"List Single Redirect Rules response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-ruleset"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Single Redirect Rules response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Single Redirect Rules","tags":["Single Redirect Rules"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Updates the Single Redirect Rules of a zone.","operationId":"single-redirect-rules-update-single-redirect-rules","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_ruleset"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single"}}},"description":"Update Single Redirect Rules response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Single Redirect Rules response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Single Redirect Rules","tags":["Single Redirect Rules"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/rulesets/phases/http_request_origin/entrypoint":{"get":{"description":"Fetches all Origin Rules in a zone.","operationId":"origin-rules-list-origin-rules","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-ruleset"}}},"description":"List Origin Rules response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-ruleset"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Origin Rules response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Origin Rules","tags":["Origin Rules"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Updates the Origin Rules of a zone.","operationId":"origin-rules-update-origin-rules","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_ruleset"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single"}}},"description":"Update Origin Rules response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Origin Rules response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Origin Rules","tags":["Origin Rules"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint":{"get":{"description":"Fetches all Transform Rules in a zone.","operationId":"transform-rules-list-transform-rules","parameters":[{"in":"path","name":"phase","required":true,"schema":{"$ref":"#/components/schemas/schemas-phase"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/transform-rules_components-schemas-ruleset"}}},"description":"List Transform Rules response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/transform-rules_components-schemas-ruleset"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Transform Rules response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Transform Rules","tags":["Transform Rules"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Updates the Transform Rules of a zone.","operationId":"transform-rules-update-transform-rules","parameters":[{"in":"path","name":"phase","required":true,"schema":{"$ref":"#/components/schemas/schemas-phase"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_ruleset"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single"}}},"description":"Update Transform Rules response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Transform Rules response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Transform Rules","tags":["Transform Rules"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions":{"get":{"description":"Fetches the versions of a zone entry point ruleset.","operationId":"zone-rulesets-list-a-zone-entry-point-ruleset'-s-versions","parameters":[{"in":"path","name":"ruleset_phase","required":true,"schema":{"$ref":"#/components/schemas/phase"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rulesets_response"}}},"description":"List a zone entry point ruleset's versions response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rulesets_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List a zone entry point ruleset's versions response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List a zone entry point ruleset's versions","tags":["Zone Rulesets"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions/{ruleset_version}":{"get":{"description":"Fetches a specific version of a zone entry point ruleset.","operationId":"zone-rulesets-get-a-zone-entry-point-ruleset-version","parameters":[{"in":"path","name":"ruleset_version","required":true,"schema":{"$ref":"#/components/schemas/version-VHkxmcSG"}},{"in":"path","name":"ruleset_phase","required":true,"schema":{"$ref":"#/components/schemas/phase"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}},"description":"Get a zone entry point ruleset version response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get a zone entry point ruleset version response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a zone entry point ruleset version","tags":["Zone Rulesets"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/rulesets/{ruleset_id}":{"delete":{"description":"Deletes all versions of an existing zone ruleset.","operationId":"zone-rulesets-delete-a-zone-ruleset","parameters":[{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{}},"description":"Delete a zone ruleset response"},"4xx":{"content":{"application/json":{}},"description":"Delete a zone ruleset response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete a zone ruleset","tags":["Zone Rulesets"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Fetches the latest version of a zone ruleset.","operationId":"zone-rulesets-get-a-zone-ruleset","parameters":[{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}},"description":"Get a zone ruleset response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get a zone ruleset response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a zone ruleset","tags":["Zone Rulesets"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Updates a zone ruleset, creating a new version.","operationId":"zone-rulesets-update-a-zone-ruleset","parameters":[{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_ruleset"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}},"description":"Update a zone ruleset response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update a zone ruleset response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update a zone ruleset","tags":["Zone Rulesets"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/rulesets/{ruleset_id}/rules":{"post":{"description":"Adds a new rule to a zone ruleset. The rule will be added to the end of the existing list of rules in the ruleset.","operationId":"zone-rulesets-create-a-zone-ruleset-rule","parameters":[{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_update_rule"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}},"description":"Create a zone ruleset rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create a zone ruleset rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create a zone ruleset rule","tags":["Zone Rulesets"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id}":{"delete":{"description":"Deletes an existing rule from a zone ruleset.","operationId":"zone-rulesets-delete-a-zone-ruleset-rule","parameters":[{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/rules_components-schemas-id"}},{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}},"description":"Delete a zone ruleset rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete a zone ruleset rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete a zone ruleset rule","tags":["Zone Rulesets"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"patch":{"description":"Updates an existing rule in a zone ruleset.","operationId":"zone-rulesets-update-a-zone-ruleset-rule","parameters":[{"in":"path","name":"rule_id","required":true,"schema":{"$ref":"#/components/schemas/rules_components-schemas-id"}},{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_update_rule"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}},"description":"Update a zone ruleset rule response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update a zone ruleset rule response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update a zone ruleset rule","tags":["Zone Rulesets"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/rulesets/{ruleset_id}/versions":{"get":{"description":"Fetches the versions of a zone ruleset.","operationId":"zone-rulesets-list-a-zone-ruleset'-s-versions","parameters":[{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rulesets_response"}}},"description":"List a zone ruleset's versions response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/rulesets_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List a zone ruleset's versions response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List a zone ruleset's versions","tags":["Zone Rulesets"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}":{"delete":{"description":"Deletes an existing version of a zone ruleset.","operationId":"zone-rulesets-delete-a-zone-ruleset-version","parameters":[{"in":"path","name":"ruleset_version","required":true,"schema":{"$ref":"#/components/schemas/version-VHkxmcSG"}},{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{}},"description":"Delete a zone ruleset version response"},"4xx":{"content":{"application/json":{}},"description":"Delete a zone ruleset version response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete a zone ruleset version","tags":["Zone Rulesets"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"get":{"description":"Fetches a specific version of a zone ruleset.","operationId":"zone-rulesets-get-a-zone-ruleset-version","parameters":[{"in":"path","name":"ruleset_version","required":true,"schema":{"$ref":"#/components/schemas/version-VHkxmcSG"}},{"in":"path","name":"ruleset_id","required":true,"schema":{"$ref":"#/components/schemas/rulesets_components-schemas-id"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ruleset_response"}}},"description":"Get a zone ruleset version response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ruleset_response"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get a zone ruleset version response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get a zone ruleset version","tags":["Zone Rulesets"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/url_normalization":{"get":{"description":"Fetches the current URL normalization settings.","operationId":"url-normalization-get-url-normalization-settings","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-response_model"}}},"description":"Get URL normalization settings response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-response_model"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get URL normalization settings response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get URL normalization settings","tags":["URL Normalization"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}},"put":{"description":"Updates the URL normalization settings.","operationId":"url-normalization-update-url-normalization-settings","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-request_model"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-response_model"}}},"description":"Update URL normalization settings response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-response_model"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update URL normalization settings response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update URL normalization settings","tags":["URL Normalization"],"x-cfPlanAvailability":{"business":true,"enterprise":true,"free":true,"pro":true}}},"/zones/{zone_id}/workers/filters":{"get":{"deprecated":true,"operationId":"worker-filters-(-deprecated)-list-filters","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filter-response-collection"}}},"description":"List Filters response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/filter-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Filters response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Filters","tags":["Worker Filters (Deprecated)"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the `/routes` equivalent APIs. These APIs are for use with the previously limited single-script zones.","display":true,"id":"worker_filter_deprecation"}},"post":{"deprecated":true,"operationId":"worker-filters-(-deprecated)-create-filter","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filter-no-id"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single-id-u7jsvBJu"}}},"description":"Create Filter response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single-id-u7jsvBJu"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Filter response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Filter","tags":["Worker Filters (Deprecated)"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the `/routes` equivalent APIs. These APIs are for use with the previously limited single-script zones.","display":true,"id":"worker_filter_deprecation"}}},"/zones/{zone_id}/workers/filters/{filter_id}":{"delete":{"deprecated":true,"operationId":"worker-filters-(-deprecated)-delete-filter","parameters":[{"in":"path","name":"filter_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single-id-u7jsvBJu"}}},"description":"Delete Filter response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single-id-u7jsvBJu"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Filter response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Filter","tags":["Worker Filters (Deprecated)"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the `/routes` equivalent APIs. These APIs are for use with the previously limited single-script zones.","display":true,"id":"worker_filter_deprecation"}},"put":{"deprecated":true,"operationId":"worker-filters-(-deprecated)-update-filter","parameters":[{"in":"path","name":"filter_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filter-no-id"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/filter-response-single"}}},"description":"Update Filter response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/filter-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Filter response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Filter","tags":["Worker Filters (Deprecated)"],"x-cfDeprecation":{"description":"This endpoint and its related APIs are deprecated in favor of the `/routes` equivalent APIs. These APIs are for use with the previously limited single-script zones.","display":true,"id":"worker_filter_deprecation"}}},"/zones/{zone_id}/workers/routes":{"get":{"operationId":"worker-routes-list-routes","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/route-response-collection"}}},"description":"List Routes response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/route-response-collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Routes response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Routes","tags":["Worker Routes"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.route.list"]}},"post":{"operationId":"worker-routes-create-route","parameters":[{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/route-no-id"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single-id-u7jsvBJu"}}},"description":"Create Route response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single-id-u7jsvBJu"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Route response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Route","tags":["Worker Routes"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.route.create"]}}},"/zones/{zone_id}/workers/routes/{route_id}":{"delete":{"operationId":"worker-routes-delete-route","parameters":[{"in":"path","name":"route_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single-id-u7jsvBJu"}}},"description":"Delete Route response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single-id-u7jsvBJu"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Route response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Route","tags":["Worker Routes"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.route.delete"]}},"get":{"operationId":"worker-routes-get-route","parameters":[{"in":"path","name":"route_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/route-response-single"}}},"description":"Get Route response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/route-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Route response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Route","tags":["Worker Routes"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.route.read"]}},"put":{"operationId":"worker-routes-update-route","parameters":[{"in":"path","name":"route_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"path","name":"zone_id","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/route-no-id"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/route-response-single"}}},"description":"Update Route response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/route-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Route response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Route","tags":["Worker Routes"],"x-cfPermissionsRequired":{"enum":["com.cloudflare.edge.worker.route.update"]}}},"/zones/{zone}/spectrum/analytics/aggregate/current":{"get":{"description":"Retrieves analytics aggregated from the last minute of usage on Spectrum applications underneath a given zone.","operationId":"spectrum-aggregate-analytics-get-current-aggregated-analytics","parameters":[{"in":"path","name":"zone","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"appID","schema":{"$ref":"#/components/schemas/app_id_param"}},{"in":"query","name":"app_id_param","schema":{"$ref":"#/components/schemas/app_id_param"}},{"in":"query","name":"colo_name","schema":{"description":"Co-location identifier.","example":"PDX","maxLength":3,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/analytics-aggregate_components-schemas-response_collection"}}},"description":"Get current aggregated analytics response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/analytics-aggregate_components-schemas-response_collection"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get current aggregated analytics response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get current aggregated analytics","tags":["Spectrum Aggregate Analytics"]}},"/zones/{zone}/spectrum/analytics/events/bytime":{"get":{"description":"Retrieves a list of aggregate metrics grouped by time interval.","operationId":"spectrum-analytics-(-by-time)-get-analytics-by-time","parameters":[{"in":"path","name":"zone","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"dimensions","schema":{"$ref":"#/components/schemas/dimensions-ICwErPf5"}},{"in":"query","name":"sort","schema":{"$ref":"#/components/schemas/sort-KhE8n2c0"}},{"in":"query","name":"until","schema":{"$ref":"#/components/schemas/schemas-until"}},{"in":"query","name":"metrics","schema":{"description":"One or more metrics to compute. Options are: \n\nMetric | Name | Example | Unit\n--------------------------|-------------------------------------|--------------------------|--------------------------\ncount | Count of total events | 1000 | Count\nbytesIngress | Sum of ingress bytes | 1000 | Sum\nbytesEgress | Sum of egress bytes | 1000 | Sum\ndurationAvg | Average connection duration | 1.0 | Time in milliseconds\ndurationMedian | Median connection duration | 1.0 | Time in milliseconds\nduration90th | 90th percentile connection duration | 1.0 | Time in milliseconds\nduration99th | 99th percentile connection duration | 1.0 | Time in milliseconds.","example":["count","bytesIngress"],"items":{"enum":["count","bytesIngress","bytesEgress","durationAvg","durationMedian","duration90th","duration99th"],"type":"string"},"type":"array"}},{"in":"query","name":"filters","schema":{"description":"Used to filter rows by one or more dimensions. Filters can be combined using OR and AND boolean logic. AND takes precedence over OR in all the expressions. The OR operator is defined using a comma (,) or OR keyword surrounded by whitespace. The AND operator is defined using a semicolon (;) or AND keyword surrounded by whitespace. Note that the semicolon is a reserved character in URLs (rfc1738) and needs to be percent-encoded as %3B. Comparison options are: \n\nOperator | Name | URL Encoded\n--------------------------|---------------------------------|--------------------------\n== | Equals | %3D%3D\n!= | Does not equals | !%3D\n\u003e | Greater Than | %3E\n\u003c | Less Than | %3C\n\u003e= | Greater than or equal to | %3E%3D\n\u003c= | Less than or equal to | %3C%3D .","example":"event==disconnect%20AND%20coloName!=SFO","type":"string"}},{"in":"query","name":"since","schema":{"description":"Start of time interval to query, defaults to `until` - 6 hours. Timestamp must be in RFC3339 format and uses UTC unless otherwise specified.","example":"2014-01-02T02:20:00Z","format":"date-time","type":"string"}},{"in":"query","name":"time_delta","schema":{"description":"Used to select time series resolution.","enum":["year","quarter","month","week","day","hour","dekaminute","minute"],"example":"minute","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single"}}},"description":"Get analytics by time response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get analytics by time response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get analytics by time","tags":["Spectrum Analytics (By Time)"]}},"/zones/{zone}/spectrum/analytics/events/summary":{"get":{"description":"Retrieves a list of summarised aggregate metrics over a given time period.","operationId":"spectrum-analytics-(-summary)-get-analytics-summary","parameters":[{"in":"path","name":"zone","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"dimensions","schema":{"$ref":"#/components/schemas/dimensions-ICwErPf5"}},{"in":"query","name":"sort","schema":{"$ref":"#/components/schemas/sort-KhE8n2c0"}},{"in":"query","name":"until","schema":{"$ref":"#/components/schemas/schemas-until"}},{"in":"query","name":"metrics","schema":{"description":"One or more metrics to compute. Options are: \n\nMetric | Name | Example | Unit\n--------------------------|-------------------------------------|--------------------------|--------------------------\ncount | Count of total events | 1000 | Count\nbytesIngress | Sum of ingress bytes | 1000 | Sum\nbytesEgress | Sum of egress bytes | 1000 | Sum\ndurationAvg | Average connection duration | 1.0 | Time in milliseconds\ndurationMedian | Median connection duration | 1.0 | Time in milliseconds\nduration90th | 90th percentile connection duration | 1.0 | Time in milliseconds\nduration99th | 99th percentile connection duration | 1.0 | Time in milliseconds.","example":["count","bytesIngress"],"items":{"enum":["count","bytesIngress","bytesEgress","durationAvg","durationMedian","duration90th","duration99th"],"type":"string"},"type":"array"}},{"in":"query","name":"filters","schema":{"description":"Used to filter rows by one or more dimensions. Filters can be combined using OR and AND boolean logic. AND takes precedence over OR in all the expressions. The OR operator is defined using a comma (,) or OR keyword surrounded by whitespace. The AND operator is defined using a semicolon (;) or AND keyword surrounded by whitespace. Note that the semicolon is a reserved character in URLs (rfc1738) and needs to be percent-encoded as %3B. Comparison options are: \n\nOperator | Name | URL Encoded\n--------------------------|---------------------------------|--------------------------\n== | Equals | %3D%3D\n!= | Does not equals | !%3D\n\u003e | Greater Than | %3E\n\u003c | Less Than | %3C\n\u003e= | Greater than or equal to | %3E%3D\n\u003c= | Less than or equal to | %3C%3D .","example":"event==disconnect%20AND%20coloName!=SFO","type":"string"}},{"in":"query","name":"since","schema":{"description":"Start of time interval to query, defaults to `until` - 6 hours. Timestamp must be in RFC3339 format and uses UTC unless otherwise specified.","example":"2014-01-02T02:20:00Z","format":"date-time","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api-response-single"}}},"description":"Get analytics summary response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get analytics summary response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get analytics summary","tags":["Spectrum Analytics (Summary)"]}},"/zones/{zone}/spectrum/apps":{"get":{"description":"Retrieves a list of currently existing Spectrum applications inside a zone.","operationId":"spectrum-applications-list-spectrum-applications","parameters":[{"in":"path","name":"zone","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}},{"in":"query","name":"page","schema":{"description":"Page number of paginated results. This parameter is required in order to use other pagination parameters. If included in the query, `result_info` will be present in the response.","example":1,"minimum":1,"type":"number"}},{"in":"query","name":"per_page","schema":{"default":20,"description":"Sets the maximum number of results per page.","maximum":100,"minimum":1,"type":"number"}},{"in":"query","name":"direction","schema":{"default":"asc","description":"Sets the direction by which results are ordered.","enum":["asc","desc"],"example":"desc","type":"string"}},{"in":"query","name":"order","schema":{"default":"dns","description":"Application field by which results are ordered.","enum":["protocol","app_id","created_on","modified_on","dns"],"example":"protocol","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/components-schemas-response_collection-7Rg5C3fo"}}},"description":"List Spectrum applications response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/components-schemas-response_collection-7Rg5C3fo"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"List Spectrum applications response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"List Spectrum applications","tags":["Spectrum Applications"]},"post":{"description":"Creates a new Spectrum application from a configuration using a name for the origin.","operationId":"spectrum-applications-create-spectrum-application-using-a-name-for-the-origin","parameters":[{"in":"path","name":"zone","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"argo_smart_routing":{"$ref":"#/components/schemas/argo_smart_routing"},"dns":{"$ref":"#/components/schemas/dns"},"edge_ips":{"$ref":"#/components/schemas/edge_ips"},"ip_firewall":{"$ref":"#/components/schemas/ip_firewall"},"origin_dns":{"$ref":"#/components/schemas/origin_dns"},"origin_port":{"$ref":"#/components/schemas/origin_port"},"protocol":{"$ref":"#/components/schemas/protocol"},"proxy_protocol":{"$ref":"#/components/schemas/proxy_protocol"},"tls":{"$ref":"#/components/schemas/tls"},"traffic_type":{"$ref":"#/components/schemas/traffic_type"}},"required":["protocol","dns","origin_dns","origin_port"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_single_origin_dns"}}},"description":"Create Spectrum application using a name for the origin response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_single_origin_dns"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Create Spectrum application using a name for the origin response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Create Spectrum application using a name for the origin","tags":["Spectrum Applications"]}},"/zones/{zone}/spectrum/apps/{app_id}":{"delete":{"description":"Deletes a previously existing application.","operationId":"spectrum-applications-delete-spectrum-application","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/app_id-yTGvAfYO"}},{"in":"path","name":"zone","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/app_id-yTGvAfYO"}},"type":"object"}},"type":"object"}]}}},"description":"Delete Spectrum application response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"allOf":[{"$ref":"#/components/schemas/api-response-single"},{"properties":{"result":{"properties":{"id":{"$ref":"#/components/schemas/app_id-yTGvAfYO"}},"type":"object"}},"type":"object"}]},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Delete Spectrum application response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Delete Spectrum application","tags":["Spectrum Applications"]},"get":{"description":"Gets the application configuration of a specific application inside a zone.","operationId":"spectrum-applications-get-spectrum-application-configuration","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/app_id-yTGvAfYO"}},{"in":"path","name":"zone","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas-response_single"}}},"description":"Get Spectrum application configuration response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/schemas-response_single"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Get Spectrum application configuration response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Get Spectrum application configuration","tags":["Spectrum Applications"]},"put":{"description":"Updates a previously existing application's configuration that uses a name for the origin.","operationId":"spectrum-applications-update-spectrum-application-configuration-using-a-name-for-the-origin","parameters":[{"in":"path","name":"app_id","required":true,"schema":{"$ref":"#/components/schemas/app_id-yTGvAfYO"}},{"in":"path","name":"zone","required":true,"schema":{"$ref":"#/components/schemas/common_components-schemas-identifier"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"argo_smart_routing":{"$ref":"#/components/schemas/argo_smart_routing"},"dns":{"$ref":"#/components/schemas/dns"},"edge_ips":{"$ref":"#/components/schemas/edge_ips"},"ip_firewall":{"$ref":"#/components/schemas/ip_firewall"},"origin_dns":{"$ref":"#/components/schemas/origin_dns"},"origin_port":{"$ref":"#/components/schemas/origin_port"},"protocol":{"$ref":"#/components/schemas/protocol"},"proxy_protocol":{"$ref":"#/components/schemas/proxy_protocol"},"tls":{"$ref":"#/components/schemas/tls"},"traffic_type":{"$ref":"#/components/schemas/traffic_type"}},"required":["protocol","dns","origin_dns","origin_port"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/response_single_origin_dns"}}},"description":"Update Spectrum application configuration using a name for the origin response"},"4xx":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/response_single_origin_dns"},{"$ref":"#/components/schemas/api-response-common-failure"}]}}},"description":"Update Spectrum application configuration using a name for the origin response failure"}},"security":[{"api_email":[],"api_key":[]},{"api_token":[]}],"summary":"Update Spectrum application configuration using a name for the origin","tags":["Spectrum Applications"]}}},"servers":[{"description":"Client API","url":"https://api.cloudflare.com/client/v4"}]} diff --git a/test/specs/large-file-memory-leak/cloudflare.json b/test/specs/large-file-memory-leak/cloudflare.json new file mode 100644 index 00000000..85dfb849 --- /dev/null +++ b/test/specs/large-file-memory-leak/cloudflare.json @@ -0,0 +1,98357 @@ +{ + "components": { + "schemas": { + "0rtt": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { "description": "ID of the zone setting.", "enum": ["0rtt"], "example": "0rtt" }, + "value": { "$ref": "#/components/schemas/0rtt_value" } + } + } + ], + "description": "0-RTT session resumption enabled for this zone.", + "title": "0-RTT Value" + }, + "0rtt_value": { + "default": "off", + "description": "Value of the 0-RTT setting.", + "enum": ["on", "off"], + "type": "string" + }, + "AAAARecord": { + "allOf": [ + { + "properties": { + "content": { + "description": "A valid IPv6 address.", + "example": "2400:cb00:2049:1::173.245.59.16", + "format": "ipv6", + "type": "string" + }, + "name": { "$ref": "#/components/schemas/name-xThA5RuS" }, + "proxied": { "$ref": "#/components/schemas/proxied" }, + "type": { "description": "Record type.", "enum": ["AAAA"], "example": "AAAA", "type": "string" } + } + }, + { "$ref": "#/components/schemas/base" } + ], + "required": ["type", "name", "content"], + "title": "AAAA Record" + }, + "ARecord": { + "allOf": [ + { + "properties": { + "content": { + "description": "A valid IPv4 address.", + "example": "198.51.100.4", + "format": "ipv4", + "type": "string" + }, + "name": { "$ref": "#/components/schemas/name-xThA5RuS" }, + "proxied": { "$ref": "#/components/schemas/proxied" }, + "type": { "description": "Record type.", "enum": ["A"], "example": "A", "type": "string" } + } + }, + { "$ref": "#/components/schemas/base" } + ], + "required": ["type", "name", "content"], + "title": "A Record" + }, + "CAARecord": { + "allOf": [ + { + "properties": { + "content": { + "description": "Formatted CAA content. See 'data' to set CAA properties.", + "readOnly": true, + "type": "string" + }, + "data": { + "description": "Components of a CAA record.", + "properties": { + "flags": { + "description": "Flags for the CAA record.", + "example": 1, + "maximum": 255, + "minimum": 0, + "type": "number" + }, + "tag": { + "description": "Name of the property controlled by this record (e.g.: issue, issuewild, iodef).", + "example": "issue", + "type": "string" + }, + "value": { + "description": "Value of the record. This field's semantics depend on the chosen tag.", + "type": "string" + } + }, + "type": "object" + }, + "name": { "$ref": "#/components/schemas/name-xThA5RuS" }, + "type": { "description": "Record type.", "enum": ["CAA"], "example": "CAA", "type": "string" } + } + }, + { "$ref": "#/components/schemas/base" } + ], + "required": ["type", "name", "data"], + "title": "CAA Record" + }, + "CERTRecord": { + "allOf": [ + { + "properties": { + "content": { + "description": "Formatted CERT content. See 'data' to set CERT properties.", + "readOnly": true, + "type": "string" + }, + "data": { + "description": "Components of a CERT record.", + "properties": { + "algorithm": { + "description": "Algorithm.", + "example": 8, + "maximum": 255, + "minimum": 0, + "type": "number" + }, + "certificate": { "description": "Certificate.", "type": "string" }, + "key_tag": { + "description": "Key Tag.", + "example": 1, + "maximum": 65535, + "minimum": 0, + "type": "number" + }, + "type": { "description": "Type.", "example": 9, "maximum": 65535, "minimum": 0, "type": "number" } + }, + "type": "object" + }, + "name": { "$ref": "#/components/schemas/name-xThA5RuS" }, + "type": { "description": "Record type.", "enum": ["CERT"], "example": "CERT", "type": "string" } + } + }, + { "$ref": "#/components/schemas/base" } + ], + "required": ["type", "name", "data"], + "title": "CERT Record" + }, + "CNAMERecord": { + "allOf": [ + { + "properties": { + "content": { "description": "A valid hostname." }, + "name": { "$ref": "#/components/schemas/name-xThA5RuS" }, + "proxied": { "$ref": "#/components/schemas/proxied" }, + "type": { "description": "Record type.", "enum": ["CNAME"], "example": "CNAME", "type": "string" } + } + }, + { "$ref": "#/components/schemas/base" } + ], + "required": ["type", "name", "content"], + "title": "CNAME Record" + }, + "CustomNS": { + "description": "A single account custom nameserver.", + "properties": { + "dns_records": { + "description": "A and AAAA records associated with the nameserver.", + "items": { + "properties": { + "type": { "description": "DNS record type.", "enum": ["A", "AAAA"], "example": "A", "type": "string" }, + "value": { + "description": "DNS record contents (an IPv4 or IPv6 address).", + "example": "1.1.1.1", + "type": "string" + } + } + }, + "type": "array" + }, + "ns_name": { "$ref": "#/components/schemas/ns_name" }, + "status": { + "deprecated": true, + "description": "Verification status of the nameserver.", + "enum": ["moved", "pending", "verified"], + "example": "verified", + "type": "string" + }, + "zone_tag": { "$ref": "#/components/schemas/schemas-identifier" } + }, + "required": ["dns_records", "ns_name", "status", "zone_tag"], + "title": "Custom NS" + }, + "CustomNSInput": { + "properties": { "ns_name": { "$ref": "#/components/schemas/ns_name" } }, + "required": ["ns_name"], + "title": "Custom NS Input" + }, + "DNSKEYRecord": { + "allOf": [ + { + "properties": { + "content": { + "description": "Formatted DNSKEY content. See 'data' to set DNSKEY properties.", + "readOnly": true, + "type": "string" + }, + "data": { + "description": "Components of a DNSKEY record.", + "properties": { + "algorithm": { + "description": "Algorithm.", + "example": 5, + "maximum": 255, + "minimum": 0, + "type": "number" + }, + "flags": { "description": "Flags.", "example": 1, "maximum": 65535, "minimum": 0, "type": "number" }, + "protocol": { + "description": "Protocol.", + "example": 3, + "maximum": 255, + "minimum": 0, + "type": "number" + }, + "public_key": { "description": "Public Key.", "type": "string" } + }, + "type": "object" + }, + "name": { "$ref": "#/components/schemas/name-xThA5RuS" }, + "type": { "description": "Record type.", "enum": ["DNSKEY"], "example": "DNSKEY", "type": "string" } + } + }, + { "$ref": "#/components/schemas/base" } + ], + "required": ["type", "name", "data"], + "title": "DNSKEY Record" + }, + "DSRecord": { + "allOf": [ + { + "properties": { + "content": { + "description": "Formatted DS content. See 'data' to set DS properties.", + "readOnly": true, + "type": "string" + }, + "data": { + "description": "Components of a DS record.", + "properties": { + "algorithm": { + "description": "Algorithm.", + "example": 3, + "maximum": 255, + "minimum": 0, + "type": "number" + }, + "digest": { "description": "Digest.", "type": "string" }, + "digest_type": { + "description": "Digest Type.", + "example": 1, + "maximum": 255, + "minimum": 0, + "type": "number" + }, + "key_tag": { + "description": "Key Tag.", + "example": 1, + "maximum": 65535, + "minimum": 0, + "type": "number" + } + }, + "type": "object" + }, + "name": { "$ref": "#/components/schemas/name-xThA5RuS" }, + "type": { "description": "Record type.", "enum": ["DS"], "example": "DS", "type": "string" } + } + }, + { "$ref": "#/components/schemas/base" } + ], + "required": ["type", "name", "data"], + "title": "DS Record" + }, + "Everything": { "properties": { "purge_everything": { "type": "boolean" } }, "type": "object" }, + "File": { "example": "http://www.example.com/css/styles.css", "type": "string" }, + "Files": { + "properties": { + "files": { + "items": { + "anyOf": [{ "$ref": "#/components/schemas/File" }, { "$ref": "#/components/schemas/UrlAndHeaders" }] + }, + "type": "array" + } + }, + "type": "object" + }, + "Flex": { + "anyOf": [ + { "$ref": "#/components/schemas/Tags" }, + { "$ref": "#/components/schemas/Hosts" }, + { "$ref": "#/components/schemas/Prefixes" } + ] + }, + "HTTPSRecord": { + "allOf": [ + { + "properties": { + "content": { + "description": "Formatted HTTPS content. See 'data' to set HTTPS properties.", + "readOnly": true, + "type": "string" + }, + "data": { + "description": "Components of a HTTPS record.", + "properties": { + "priority": { + "description": "priority.", + "example": 1, + "maximum": 65535, + "minimum": 0, + "type": "number" + }, + "target": { "description": "target.", "example": ".", "type": "string" }, + "value": { + "description": "value.", + "example": "alpn=\"h3,h2\" ipv4hint=\"127.0.0.1\" ipv6hint=\"::1\"", + "type": "string" + } + }, + "type": "object" + }, + "name": { "$ref": "#/components/schemas/name-xThA5RuS" }, + "type": { "description": "Record type.", "enum": ["HTTPS"], "example": "HTTPS", "type": "string" } + } + }, + { "$ref": "#/components/schemas/base" } + ], + "required": ["type", "name", "data"], + "title": "HTTPS Record" + }, + "Host": { + "description": "The 'Host' header allows to override the hostname set in the HTTP request. Current support is 1 'Host' header override per origin.", + "items": { "example": "example.com", "type": "string" }, + "type": "array" + }, + "Hosts": { + "properties": { + "hosts": { + "example": ["www.example.com", "images.example.com"], + "items": { "type": "string" }, + "type": "array" + } + }, + "type": "object" + }, + "LOCRecord": { + "allOf": [ + { + "properties": { + "content": { + "description": "Formatted LOC content. See 'data' to set LOC properties.", + "example": "IN LOC 37 46 46 N 122 23 35 W 0m 100m 0m 0m", + "readOnly": true, + "type": "string" + }, + "data": { + "description": "Components of a LOC record.", + "properties": { + "altitude": { + "description": "Altitude of location in meters.", + "example": 0, + "maximum": 42849672.95, + "minimum": -100000, + "type": "number" + }, + "lat_degrees": { + "description": "Degrees of latitude.", + "example": 37, + "maximum": 90, + "minimum": 0, + "type": "number" + }, + "lat_direction": { "description": "Latitude direction.", "enum": ["N", "S"], "example": "N" }, + "lat_minutes": { + "default": 0, + "description": "Minutes of latitude.", + "example": 46, + "maximum": 59, + "minimum": 0, + "type": "number" + }, + "lat_seconds": { + "default": 0, + "description": "Seconds of latitude.", + "example": 46, + "maximum": 59.999, + "minimum": 0, + "type": "number" + }, + "long_degrees": { + "description": "Degrees of longitude.", + "example": 122, + "maximum": 180, + "minimum": 0, + "type": "number" + }, + "long_direction": { "description": "Longitude direction.", "enum": ["E", "W"], "example": "W" }, + "long_minutes": { + "default": 0, + "description": "Minutes of longitude.", + "example": 23, + "maximum": 59, + "minimum": 0, + "type": "number" + }, + "long_seconds": { + "default": 0, + "description": "Seconds of longitude.", + "example": 35, + "maximum": 59.999, + "minimum": 0, + "type": "number" + }, + "precision_horz": { + "default": 0, + "description": "Horizontal precision of location.", + "example": 0, + "maximum": 90000000, + "minimum": 0, + "type": "number" + }, + "precision_vert": { + "default": 0, + "description": "Vertical precision of location.", + "example": 0, + "maximum": 90000000, + "minimum": 0, + "type": "number" + }, + "size": { + "default": 0, + "description": "Size of location in meters.", + "example": 100, + "maximum": 90000000, + "minimum": 0, + "type": "number" + } + }, + "type": "object" + }, + "name": { "$ref": "#/components/schemas/name-xThA5RuS" }, + "type": { "description": "Record type.", "enum": ["LOC"], "example": "LOC", "type": "string" } + } + }, + { "$ref": "#/components/schemas/base" } + ], + "required": ["type", "name", "data"], + "title": "LOC Record" + }, + "MXRecord": { + "allOf": [ + { + "properties": { + "content": { + "description": "A valid mail server hostname.", + "example": "mx.example.com", + "format": "hostname", + "type": "string" + }, + "name": { "$ref": "#/components/schemas/name-xThA5RuS" }, + "priority": { "$ref": "#/components/schemas/priority-hJRwn9f1" }, + "type": { "description": "Record type.", "enum": ["MX"], "example": "MX", "type": "string" } + } + }, + { "$ref": "#/components/schemas/base" } + ], + "required": ["type", "name", "content", "priority"], + "title": "MX Record" + }, + "NAPTRRecord": { + "allOf": [ + { + "properties": { + "content": { + "description": "Formatted NAPTR content. See 'data' to set NAPTR properties.", + "readOnly": true, + "type": "string" + }, + "data": { + "description": "Components of a NAPTR record.", + "properties": { + "flags": { "description": "Flags.", "type": "string" }, + "order": { + "description": "Order.", + "example": 100, + "maximum": 65535, + "minimum": 0, + "type": "number" + }, + "preference": { + "description": "Preference.", + "example": 10, + "maximum": 65535, + "minimum": 0, + "type": "number" + }, + "regex": { "description": "Regex.", "type": "string" }, + "replacement": { "description": "Replacement.", "type": "string" }, + "service": { "description": "Service.", "type": "string" } + }, + "type": "object" + }, + "name": { "$ref": "#/components/schemas/name-xThA5RuS" }, + "type": { "description": "Record type.", "enum": ["NAPTR"], "example": "NAPTR", "type": "string" } + } + }, + { "$ref": "#/components/schemas/base" } + ], + "required": ["type", "name", "data"], + "title": "NAPTR Record" + }, + "NSRecord": { + "allOf": [ + { + "properties": { + "content": { "description": "A valid name server host name.", "example": "ns1.example.com" }, + "name": { "$ref": "#/components/schemas/name-xThA5RuS" }, + "type": { "description": "Record type.", "enum": ["NS"], "example": "NS", "type": "string" } + } + }, + { "$ref": "#/components/schemas/base" } + ], + "required": ["type", "name", "content"], + "title": "NS Record" + }, + "PTRRecord": { + "allOf": [ + { + "properties": { + "content": { + "description": "Domain name pointing to the address.", + "example": "example.com", + "type": "string" + }, + "name": { "$ref": "#/components/schemas/name-xThA5RuS" }, + "type": { "description": "Record type.", "enum": ["PTR"], "example": "PTR", "type": "string" } + } + }, + { "$ref": "#/components/schemas/base" } + ], + "required": ["type", "name", "content"], + "title": "PTR Record" + }, + "Prefixes": { + "properties": { + "prefixes": { + "example": ["www.example.com/foo", "images.example.com/bar/baz"], + "items": { "type": "string" }, + "type": "array" + } + }, + "type": "object" + }, + "SMIMEARecord": { + "allOf": [ + { + "properties": { + "content": { + "description": "Formatted SMIMEA content. See 'data' to set SMIMEA properties.", + "readOnly": true, + "type": "string" + }, + "data": { + "description": "Components of a SMIMEA record.", + "properties": { + "certificate": { "description": "Certificate.", "type": "string" }, + "matching_type": { + "description": "Matching Type.", + "example": 0, + "maximum": 255, + "minimum": 0, + "type": "number" + }, + "selector": { + "description": "Selector.", + "example": 0, + "maximum": 255, + "minimum": 0, + "type": "number" + }, + "usage": { "description": "Usage.", "example": 3, "maximum": 255, "minimum": 0, "type": "number" } + }, + "type": "object" + }, + "name": { "$ref": "#/components/schemas/name-xThA5RuS" }, + "type": { "description": "Record type.", "enum": ["SMIMEA"], "example": "SMIMEA", "type": "string" } + } + }, + { "$ref": "#/components/schemas/base" } + ], + "required": ["type", "name", "data"], + "title": "SMIMEA Record" + }, + "SRVRecord": { + "allOf": [ + { + "properties": { + "content": { + "description": "Priority, weight, port, and SRV target. See 'data' for setting the individual component values.", + "example": "10 IN SRV 5 8806 example.com.", + "readOnly": true, + "type": "string" + }, + "data": { + "description": "Components of a SRV record.", + "properties": { + "name": { + "description": "A valid hostname.", + "example": "example.com", + "format": "hostname", + "type": "string" + }, + "port": { + "description": "The port of the service.", + "example": 8806, + "maximum": 65535, + "minimum": 0, + "type": "number" + }, + "priority": { "$ref": "#/components/schemas/priority-hJRwn9f1" }, + "proto": { "description": "A valid protocol.", "example": "_tcp", "type": "string" }, + "service": { + "description": "A service type, prefixed with an underscore.", + "example": "_sip", + "type": "string" + }, + "target": { + "description": "A valid hostname.", + "example": "example.com", + "format": "hostname", + "type": "string" + }, + "weight": { + "description": "The record weight.", + "example": 5, + "maximum": 65535, + "minimum": 0, + "type": "number" + } + }, + "type": "object" + }, + "name": { + "description": "Service, protocol, and SRV name content. See 'data' for setting the individual component values.", + "example": "_sip._tcp.example.com", + "maxLength": 255, + "readOnly": true, + "type": "string" + }, + "type": { "description": "Record type.", "enum": ["SRV"], "example": "SRV", "type": "string" } + } + }, + { "$ref": "#/components/schemas/base" } + ], + "required": ["type", "data"], + "title": "SRV Record" + }, + "SSHFPRecord": { + "allOf": [ + { + "properties": { + "content": { + "description": "Formatted SSHFP content. See 'data' to set SSHFP properties.", + "readOnly": true, + "type": "string" + }, + "data": { + "description": "Components of a SSHFP record.", + "properties": { + "algorithm": { + "description": "algorithm.", + "example": 2, + "maximum": 255, + "minimum": 0, + "type": "number" + }, + "fingerprint": { "description": "fingerprint.", "type": "string" }, + "type": { "description": "type.", "example": 1, "maximum": 255, "minimum": 0, "type": "number" } + }, + "type": "object" + }, + "name": { "$ref": "#/components/schemas/name-xThA5RuS" }, + "type": { "description": "Record type.", "enum": ["SSHFP"], "example": "SSHFP", "type": "string" } + } + }, + { "$ref": "#/components/schemas/base" } + ], + "required": ["type", "name", "data"], + "title": "SSHFP Record" + }, + "SVCBRecord": { + "allOf": [ + { + "properties": { + "content": { + "description": "Formatted SVCB content. See 'data' to set SVCB properties.", + "readOnly": true, + "type": "string" + }, + "data": { + "description": "Components of a SVCB record.", + "properties": { + "priority": { + "description": "priority.", + "example": 1, + "maximum": 65535, + "minimum": 0, + "type": "number" + }, + "target": { "description": "target.", "example": ".", "type": "string" }, + "value": { + "description": "value.", + "example": "alpn=\"h3,h2\" ipv4hint=\"127.0.0.1\" ipv6hint=\"::1\"", + "type": "string" + } + }, + "type": "object" + }, + "name": { "$ref": "#/components/schemas/name-xThA5RuS" }, + "type": { "description": "Record type.", "enum": ["SVCB"], "example": "SVCB", "type": "string" } + } + }, + { "$ref": "#/components/schemas/base" } + ], + "required": ["type", "name", "data"], + "title": "SVCB Record" + }, + "TLSARecord": { + "allOf": [ + { + "properties": { + "content": { + "description": "Formatted TLSA content. See 'data' to set TLSA properties.", + "readOnly": true, + "type": "string" + }, + "data": { + "description": "Components of a TLSA record.", + "properties": { + "certificate": { "description": "certificate.", "type": "string" }, + "matching_type": { + "description": "Matching Type.", + "example": 1, + "maximum": 255, + "minimum": 0, + "type": "number" + }, + "selector": { + "description": "Selector.", + "example": 0, + "maximum": 255, + "minimum": 0, + "type": "number" + }, + "usage": { "description": "Usage.", "example": 0, "maximum": 255, "minimum": 0, "type": "number" } + }, + "type": "object" + }, + "name": { "$ref": "#/components/schemas/name-xThA5RuS" }, + "type": { "description": "Record type.", "enum": ["TLSA"], "example": "TLSA", "type": "string" } + } + }, + { "$ref": "#/components/schemas/base" } + ], + "required": ["type", "name", "data"], + "title": "TLSA Record" + }, + "TXTRecord": { + "allOf": [ + { + "properties": { + "content": { + "description": "Text content for the record.", + "example": "example text content", + "type": "string" + }, + "name": { "$ref": "#/components/schemas/name-xThA5RuS" }, + "type": { "description": "Record type.", "enum": ["TXT"], "example": "TXT", "type": "string" } + } + }, + { "$ref": "#/components/schemas/base" } + ], + "required": ["type", "name", "content"], + "title": "TXT Record" + }, + "Tags": { + "properties": { + "tags": { "example": ["some-tag", "another-tag"], "items": { "type": "string" }, "type": "array" } + }, + "type": "object" + }, + "URIRecord": { + "allOf": [ + { + "properties": { + "content": { + "description": "Formatted URI content. See 'data' to set URI properties.", + "readOnly": true, + "type": "string" + }, + "data": { + "description": "Components of a URI record.", + "properties": { + "content": { + "description": "The record content.", + "example": "http://example.com/example.html", + "type": "string" + }, + "weight": { + "description": "The record weight.", + "example": 20, + "maximum": 65535, + "minimum": 0, + "type": "number" + } + }, + "type": "object" + }, + "name": { "$ref": "#/components/schemas/name-xThA5RuS" }, + "priority": { "$ref": "#/components/schemas/priority-hJRwn9f1" }, + "type": { "description": "Record type.", "enum": ["URI"], "example": "URI", "type": "string" } + } + }, + { "$ref": "#/components/schemas/base" } + ], + "required": ["type", "name", "data", "priority"], + "title": "URI Record" + }, + "UrlAndHeaders": { + "properties": { + "headers": { + "example": "{\n \"Origin\": \"https://www.cloudflare.com\",\n \"CF-IPCountry\": \"US\",\n \"CF-Device-Type\": \"desktop\"\n}", + "type": "object" + }, + "url": { "example": "http://www.example.com/cat_picture.jpg", "type": "string" } + }, + "type": "object" + }, + "access-policy": { + "oneOf": [{ "$ref": "#/components/schemas/policy_with_permission_groups" }], + "type": "object" + }, + "access-requests": { + "properties": { + "action": { "$ref": "#/components/schemas/action-Ib2HEWrw" }, + "allowed": { "$ref": "#/components/schemas/allowed" }, + "app_domain": { "$ref": "#/components/schemas/app_domain" }, + "app_uid": { "$ref": "#/components/schemas/app_uid" }, + "connection": { "$ref": "#/components/schemas/connection-CprJdVPV" }, + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "ip_address": { "$ref": "#/components/schemas/ip-ibmclV7b" }, + "ray_id": { "$ref": "#/components/schemas/ray_id" }, + "user_email": { "$ref": "#/components/schemas/email" } + }, + "type": "object" + }, + "access-requests-X9B1uf1S": { + "properties": { + "action": { "$ref": "#/components/schemas/access-requests_components-schemas-action" }, + "allowed": { "$ref": "#/components/schemas/schemas-allowed" }, + "app_domain": { "$ref": "#/components/schemas/app_domain" }, + "app_uid": { "$ref": "#/components/schemas/app_uid" }, + "connection": { "$ref": "#/components/schemas/schemas-connection" }, + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "ip_address": { "$ref": "#/components/schemas/schemas-ip" }, + "ray_id": { "$ref": "#/components/schemas/ray_id" }, + "user_email": { "$ref": "#/components/schemas/schemas-email-EQUZrKsL" } + }, + "type": "object" + }, + "access-requests_components-schemas-action": { + "description": "The event that occurred, such as a login attempt.", + "example": "login", + "type": "string" + }, + "access-requests_components-schemas-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/access-requests-X9B1uf1S" }, "type": "array" } + } + } + ] + }, + "accessRules": { + "description": "Defines rules for fine-grained control over content than signed URL tokens alone. Access rules primarily make tokens conditionally valid based on user information. Access Rules are specified on token payloads as the `accessRules` property containing an array of Rule objects.", + "properties": { + "action": { + "description": "The action to take when a request matches a rule. If the action is `block`, the signed token blocks views for viewers matching the rule.", + "enum": ["allow", "block"], + "example": "allow", + "readOnly": true, + "type": "string" + }, + "country": { + "description": "An array of 2-letter country codes in ISO 3166-1 Alpha-2 format used to match requests.", + "items": { "type": "string" }, + "readOnly": true, + "type": "array" + }, + "ip": { + "description": "An array of IPv4 or IPV6 addresses or CIDRs used to match requests.", + "items": { "type": "string" }, + "readOnly": true, + "type": "array" + }, + "type": { + "description": "Lists available rule types to match for requests. An `any` type matches all requests and can be used as a wildcard to apply default actions after other rules.", + "enum": ["any", "ip.src", "ip.geoip.country"], + "example": "ip.src", + "readOnly": true, + "type": "string" + } + }, + "readOnly": true, + "type": "object" + }, + "access_group_rule": { + "description": "Matches an Access group.", + "properties": { + "group": { + "properties": { + "id": { + "description": "The ID of a previously created Access group.", + "example": "aa0a4aab-672b-4bdb-bc33-a59f1130a11f", + "type": "string" + } + }, + "required": ["id"], + "type": "object" + } + }, + "required": ["group"], + "title": "Access groups", + "type": "object" + }, + "access_seat": { "description": "True if the seat is part of Access.", "example": false, "type": "boolean" }, + "account": { + "properties": { + "created_on": { + "description": "Timestamp for the creation of the account", + "example": "2014-03-01T12:21:02.0000Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" }, + "name": { "description": "Account name", "example": "Demo Account", "maxLength": 100, "type": "string" }, + "settings": { + "description": "Account settings", + "properties": { + "enforce_twofactor": { + "default": false, + "description": "Indicates whether membership in this account requires that\nTwo-Factor Authentication is enabled", + "type": "boolean" + }, + "use_account_custom_ns_by_default": { + "default": false, + "description": "Indicates whether new zones should use the account-level custom\nnameservers by default", + "type": "boolean" + } + }, + "type": "object" + } + }, + "required": ["id", "name"], + "type": "object" + }, + "account-settings-response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { + "properties": { + "result": { + "properties": { "default_usage_model": { "readOnly": true }, "green_compute": { "readOnly": true } }, + "type": "object" + } + } + } + ] + }, + "account_identifier": { "$ref": "#/components/schemas/identifier-59LodGbZ" }, + "account_identifier-D3Kod1Eh": {}, + "account_identifier-DCAPOmrB": { "example": "01a7362d577a6c3019a474fd6f485823", "readOnly": true }, + "account_identifier-JMTrNzhX": { "$ref": "#/components/schemas/identifier-YhmC5GTP" }, + "account_identifier-hNAyEE6b": { "$ref": "#/components/schemas/identifier-gI2sCanq" }, + "account_identifier-u0eFsPPd": { + "description": "The account identifier tag.", + "example": "023e105f4ecef8ad9ca31a8372d0c353", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "account_subscription_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { "result": { "items": { "$ref": "#/components/schemas/subscription" }, "type": "array" } }, + "type": "object" + } + ] + }, + "account_subscription_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } }, "type": "object" } + ] + }, + "acl": { + "properties": { + "id": { "$ref": "#/components/schemas/components-schemas-identifier" }, + "ip_range": { "$ref": "#/components/schemas/ip_range" }, + "name": { "$ref": "#/components/schemas/acl_components-schemas-name" } + }, + "required": ["id", "name", "ip_range"], + "type": "object" + }, + "acl_components-schemas-name": { "description": "The name of the acl.", "example": "my-acl-1", "type": "string" }, + "acns_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { "result": { "items": { "$ref": "#/components/schemas/CustomNS" }, "type": "array" } }, + "type": "object" + } + ] + }, + "acns_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/CustomNS" } }, "type": "object" } + ] + }, + "action": { + "description": "The action to preform when the associated traffic, identity, and device posture expressions are either absent or evaluate to 'true'.", + "enum": [ + "on", + "off", + "allow", + "block", + "scan", + "noscan", + "safesearch", + "ytrestricted", + "isolate", + "noisolate", + "override", + "l4_override", + "egress", + "audit_ssh" + ], + "example": "allow", + "type": "string" + }, + "action-Ib2HEWrw": { + "description": "The event that occurred, such as a login attempt.", + "example": "login", + "type": "string" + }, + "action-ypBxWT3F": { + "description": "The billing item action.", + "example": "subscription", + "maxLength": 30, + "readOnly": true, + "type": "string" + }, + "action_mode": { + "default": "challenge", + "description": "The default action performed by the rules in the WAF package.", + "enum": ["simulate", "block", "challenge"], + "type": "string" + }, + "action_parameters": { + "description": "The parameters configuring the rule action.", + "example": { "id": "4814384a9e5d4991b9815dcfc25d2f1f" }, + "type": "object" + }, + "action_parameters_redirect": { + "description": "The configuration parameters for the redirect action.", + "properties": { + "from_value": { + "description": "The parameters that control the redirect.", + "properties": { + "preserve_query_string": { + "description": "Whether the query string for the request should be carried to the redirect's target url.", + "example": true, + "type": "boolean" + }, + "status_code": { "description": "The status code to use for the redirect.", "type": "integer" }, + "target_url": { + "oneOf": [ + { + "properties": { + "expression": { + "description": "An expression defining a dynamic value for the target url of the redirect.", + "example": "concat(http.request.full_uri, \"/latest\")", + "type": "string" + } + }, + "type": "object" + }, + { + "properties": { + "value": { + "description": "The value defining the target url of the redirect.", + "example": "https://example.com/blog/latest", + "type": "string" + } + }, + "type": "object" + } + ] + } + }, + "type": "object" + } + } + }, + "action_parameters_rewrite": { + "description": "The configuration parameters for the rewrite action.", + "properties": { + "uri": { + "description": "The URI rewrite configuration to rewrite the URI path, the query string, or both.", + "properties": { + "path": { "description": "The new URI path sent to the origin." }, + "query": { "description": "The new query string sent to the origin." } + }, + "type": "object" + } + } + }, + "action_parameters_route": { + "description": "The configuration parameters for the route action.", + "properties": { + "host_header": { + "description": "The value of the Host header.", + "example": "foo.example.com", + "type": "string" + }, + "origin": { + "description": "The parameters that control where the origin is.", + "properties": { + "host": { "description": "The host to use for origin.", "example": "foo.example.com", "type": "string" }, + "port": { "description": "The port to use for origin.", "type": "integer" } + }, + "type": "object" + }, + "sni": { + "description": "The parameters that control the SNI.", + "properties": { + "value": { + "description": "The SNI used to connect to the origin.", + "example": "foo.example.com", + "type": "string" + } + }, + "type": "object" + } + } + }, + "action_parameters_serve_error": { + "description": "The action parameters for the serve_error action.", + "properties": { + "content": { + "description": "The new content for the response error.", + "example": "some html error page", + "type": "string" + }, + "content_type": { + "description": "The content-type of the response error.", + "example": "text/html", + "type": "string" + }, + "status_code": { + "description": "The HTTP status code of the response error.", + "example": 530, + "type": "number" + } + } + }, + "action_parameters_set_cache_settings": { + "description": "The configuration parameters for the set_cache_settings action.", + "properties": { + "browser_ttl": { + "description": "Set the Browser TTL.", + "properties": { + "default": { "type": "integer" }, + "mode": { "example": "override_origin", "type": "string" } + }, + "type": "object" + }, + "cache_key": { + "description": "Set the Cache TTL.", + "properties": { + "cache_deception_armor": { "example": true, "type": "boolean" }, + "custom_key": { + "properties": { + "cookie": { + "properties": { + "check_presence": { "example": ["cookie_1"], "items": {}, "type": "array" }, + "include": { "example": ["cookie1"], "items": {}, "type": "array" } + }, + "type": "object" + }, + "header": { + "properties": { + "check_presence": { "example": ["header_1"], "items": {}, "type": "array" }, + "include": { "example": ["header1"], "items": {}, "type": "array" } + }, + "type": "object" + }, + "host": { "properties": { "resolved": { "example": false, "type": "boolean" } }, "type": "object" }, + "query_string": { + "properties": { "include": { "example": "*", "type": "string" } }, + "type": "object" + }, + "user": { + "properties": { + "device_type": { "example": true, "type": "boolean" }, + "geo": { "example": false, "type": "boolean" }, + "lang": { "example": false, "type": "boolean" } + }, + "type": "object" + } + }, + "type": "object" + }, + "ignore_query_strings_order": { "example": true, "type": "boolean" } + }, + "type": "object" + }, + "edge_ttl": { + "description": "Set the Cache TTL.", + "properties": { + "mode": { "example": "respect_origin", "type": "string" }, + "status_code_ttl": { + "properties": { "status_code": { "type": "integer" }, "value": { "type": "integer" } }, + "type": "object" + } + }, + "type": "object" + }, + "origin_error_page_passthru": { "example": true, "type": "boolean" }, + "respect_strong_etags": { "example": true, "type": "boolean" }, + "serve_stale": { + "properties": { "disable_stale_while_updating": { "example": true, "type": "boolean" } }, + "type": "object" + } + } + }, + "action_parameters_set_config": { + "description": "The configuration parameters for the set_config action.", + "properties": { + "automatic_https_rewrites": { + "description": "Enable or disable Automatic HTTPS Rewrites for matching requests", + "example": true, + "type": "boolean" + }, + "autominify": { + "description": "Select which file extensions to minify automatically.", + "properties": { + "css": { "example": true, "type": "boolean" }, + "html": { "example": true, "type": "boolean" }, + "js": { "example": true, "type": "boolean" } + }, + "type": "object" + }, + "bic": { "description": "Enable or disable Browser Integrity Check", "example": true, "type": "boolean" }, + "disable_apps": { "description": "Disable all active Cloudflare Apps", "example": true, "type": "boolean" }, + "disable_railgun": { "description": "Disable Cloudflare Railgun", "example": true, "type": "boolean" }, + "disable_zaraz": { "description": "Disable Cloudflare Railgun", "example": true, "type": "boolean" }, + "email_obfuscation": { + "description": "Enable or disable Email Obfuscation", + "example": false, + "type": "boolean" + }, + "hotlink_protection": { + "description": "Enable or disable Hotlink Protection", + "example": false, + "type": "boolean" + }, + "mirage": { "description": "Enable or disable Mirage", "example": false, "type": "boolean" }, + "opportunistic_encryption": { + "description": "Enable or disableOpportunistic Encryption", + "example": false, + "type": "boolean" + }, + "polish": { "description": "Set Polish compression options", "example": "lossless", "type": "string" }, + "rocket_loader": { "description": "Enable or disable Rocket Loader", "example": false, "type": "boolean" }, + "security_level": { "description": "Set the Security Level", "example": "low", "type": "string" }, + "server_side_excludes": { + "description": "Enable or disable Server Side Excludes", + "example": false, + "type": "boolean" + }, + "ssl": { "description": "Select the SSL encryption mode", "example": "flexible", "type": "string" }, + "sxg": { "description": "Enable or disable Signed Exchangesn(SXG)", "example": false, "type": "boolean" } + } + }, + "actions": { + "description": "The set of actions to perform if the targets of this rule match the request. Actions can redirect to another URL or override settings, but not both.", + "example": [{ "id": "browser_check", "value": "on" }], + "items": { "oneOf": [{ "$ref": "#/components/schemas/route-k62zYPUS" }] }, + "type": "array" + }, + "activated_on": { + "description": "When the Railgun was activated.", + "example": "2014-01-02T02:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "activation": { + "properties": { + "activated_on": { "$ref": "#/components/schemas/activated_on" }, + "key": { "$ref": "#/components/schemas/activation_key" }, + "version": { + "properties": { + "build": { "$ref": "#/components/schemas/build" }, + "number": { "$ref": "#/components/schemas/components-schemas-version" }, + "revision": { "$ref": "#/components/schemas/revision" } + }, + "required": ["number"], + "type": "object" + } + }, + "readOnly": true, + "required": ["key"], + "type": "object" + }, + "activation_key": { + "example": "e4edc00281cb56ebac22c81be9bac8f3", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "active_device_count": { + "description": "The number of active devices registered to the user.", + "example": 2, + "type": "number" + }, + "activity-log-settings": { + "description": "Activity log settings.", + "properties": { "enabled": { "description": "Enable activity logging.", "example": true, "type": "boolean" } }, + "type": "object" + }, + "adaptive_routing": { + "description": "Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.", + "properties": { + "failover_across_pools": { + "default": false, + "description": "Extends zero-downtime failover of requests to healthy origins from alternate pools, when no healthy alternate exists in the same pool, according to the failover order defined by traffic and origin steering. When set false (the default) zero-downtime failover will only occur between origins within the same pool. See `session_affinity_attributes` for control over when sessions are broken or reassigned.", + "example": true, + "type": "boolean" + } + }, + "type": "object" + }, + "additional_information": { + "description": "Additional information related to the host name.", + "properties": { + "suspected_malware_family": { + "description": "Suspected DGA malware family.", + "example": "", + "type": "string" + } + }, + "type": "object" + }, + "address": { + "description": "The hostname or IP address of the origin server to run health checks on.", + "example": "www.example.com", + "type": "string" + }, + "address-95deJOax": { + "description": "The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare. To set an internal/reserved address, virtual_network_id must also be set.", + "example": "0.0.0.0", + "type": "string" + }, + "address-SVXLSyuc": { + "description": "The IP address (IPv4 or IPv6) of the origin, or its publicly addressable hostname. Hostnames entered here should resolve directly to the origin, and not be a hostname proxied by Cloudflare. To set an internal/reserved address, virtual_network_id must also be set.", + "example": "0.0.0.0", + "type": "string" + }, + "address-maps": { + "properties": { + "can_delete": { "$ref": "#/components/schemas/can_delete" }, + "can_modify_ips": { "$ref": "#/components/schemas/can_modify_ips" }, + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "default_sni": { "$ref": "#/components/schemas/default_sni" }, + "description": { "$ref": "#/components/schemas/schemas-description-Fsn87iOz" }, + "enabled": { "$ref": "#/components/schemas/enabled-i0fFiRwL" }, + "id": { "$ref": "#/components/schemas/identifier-v0xEcFCj" }, + "modified_at": { "$ref": "#/components/schemas/timestamp" } + }, + "type": "object" + }, + "address-maps-ip": { + "properties": { + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "ip": { "$ref": "#/components/schemas/ip-8QKcCQCp" } + }, + "type": "object" + }, + "address-maps-ip-spXX1kUy": { + "properties": { + "created_at": { "$ref": "#/components/schemas/created-on" }, + "ip": { "$ref": "#/components/schemas/ip-gs35mKhq" } + }, + "type": "object" + }, + "address-maps-ldXASIMl": { + "properties": { + "can_delete": { "$ref": "#/components/schemas/can_delete" }, + "can_modify_ips": { "$ref": "#/components/schemas/can_modify_ips" }, + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "default_sni": { "$ref": "#/components/schemas/default_sni" }, + "description": { "$ref": "#/components/schemas/address-maps_components-schemas-description" }, + "enabled": { "$ref": "#/components/schemas/address-maps_components-schemas-enabled" }, + "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" }, + "modified_at": { "$ref": "#/components/schemas/timestamp" } + }, + "type": "object" + }, + "address-maps-membership": { + "properties": { + "can_delete": { "$ref": "#/components/schemas/schemas-can_delete" }, + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "identifier": { "$ref": "#/components/schemas/identifier-v0xEcFCj" }, + "kind": { "$ref": "#/components/schemas/kind" } + }, + "type": "object" + }, + "address-maps-membership-upHJKSmv": { + "properties": { + "can_delete": { "$ref": "#/components/schemas/schemas-can_delete" }, + "created_at": { "$ref": "#/components/schemas/created-on" }, + "identifier": { "$ref": "#/components/schemas/common_components-schemas-identifier" }, + "kind": { "$ref": "#/components/schemas/components-schemas-kind" } + }, + "type": "object" + }, + "address-maps_components-schemas-description": { + "description": "An optional description field which may be used to describe the types of IPs or zones on the map.", + "example": "My Ecommerce zones", + "nullable": true, + "type": "string" + }, + "address-maps_components-schemas-enabled": { + "default": false, + "description": "Whether the Address Map is enabled or not. Cloudflare's DNS will not respond with IP addresses on an Address Map until the map is enabled.", + "example": true, + "nullable": true, + "type": "boolean" + }, + "address-maps_components-schemas-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/address-maps-ldXASIMl" }, "type": "array" } + } + } + ] + }, + "address-maps_components-schemas-single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/address-maps-ldXASIMl" } } } + ] + }, + "address2": { + "description": "Optional address line for unit, floor, suite, etc.", + "example": "Suite 430", + "type": "string" + }, + "addresses": { "allOf": [{ "$ref": "#/components/schemas/destination_address_properties" }], "type": "object" }, + "advanced_certificate_pack_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "certificate_authority": { "$ref": "#/components/schemas/schemas-certificate_authority" }, + "cloudflare_branding": { "$ref": "#/components/schemas/cloudflare_branding" }, + "hosts": { "$ref": "#/components/schemas/schemas-hosts" }, + "id": { "$ref": "#/components/schemas/identifier-tZwYoMuc" }, + "status": { "$ref": "#/components/schemas/certificate-packs_components-schemas-status" }, + "type": { "$ref": "#/components/schemas/advanced_type" }, + "validation_method": { "$ref": "#/components/schemas/validation_method" }, + "validity_days": { "$ref": "#/components/schemas/validity_days" } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "advanced_certificate_pack_response_single-M4alsr79": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "certificate_authority": { "$ref": "#/components/schemas/certificate_authority-VxFhhbhi" }, + "cloudflare_branding": { "$ref": "#/components/schemas/cloudflare_branding" }, + "hosts": { "$ref": "#/components/schemas/schemas-hosts" }, + "id": { "$ref": "#/components/schemas/certificate-packs_components-schemas-identifier" }, + "status": { "$ref": "#/components/schemas/certificate-packs_components-schemas-status" }, + "type": { "$ref": "#/components/schemas/advanced_type" }, + "validation_method": { "$ref": "#/components/schemas/validation_method" }, + "validity_days": { "$ref": "#/components/schemas/validity_days" } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "advanced_ddos": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { "description": "ID of the zone setting.", "enum": ["advanced_ddos"], "example": "advanced_ddos" }, + "value": { "$ref": "#/components/schemas/advanced_ddos_value" } + } + } + ], + "description": "Advanced protection from Distributed Denial of Service (DDoS) attacks on your website. This is an uneditable value that is 'on' in the case of Business and Enterprise zones.", + "title": "Advanced DDoS Protection" + }, + "advanced_ddos_value": { + "default": "off", + "description": "Value of the zone setting.\nNotes: Defaults to on for Business+ plans", + "enum": ["on", "off"], + "type": "string" + }, + "advanced_type": { + "description": "Type of certificate pack.", + "enum": ["advanced"], + "example": "advanced", + "type": "string" + }, + "advertised": { + "description": "Prefix advertisement status to the Internet. This field is only not 'null' if on demand is enabled.", + "example": true, + "nullable": true, + "type": "boolean" + }, + "advertised_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "advertised": { "$ref": "#/components/schemas/schemas-advertised" }, + "advertised_modified_at": { "$ref": "#/components/schemas/modified_at_nullable" } + }, + "type": "object" + } + } + } + ] + }, + "alert-types": { + "properties": { + "description": { "$ref": "#/components/schemas/alert-types_components-schemas-description" }, + "display_name": { "$ref": "#/components/schemas/display_name" }, + "filter_options": { "$ref": "#/components/schemas/schemas-filter_options" }, + "type": { "$ref": "#/components/schemas/alert-types_components-schemas-type" } + }, + "type": "object" + }, + "alert-types_components-schemas-description": { + "description": "Describes the alert type.", + "example": "High levels of 5xx HTTP errors at your origin", + "type": "string" + }, + "alert-types_components-schemas-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "additionalProperties": { "items": { "$ref": "#/components/schemas/alert-types" }, "type": "array" }, + "example": { + "Origin Monitoring": [ + { + "description": "High levels of 5xx HTTP errors at your origin.", + "display_name": "Origin Error Rate Alert", + "filter_options": [ + { "ComparisonOperator": "==", "Key": "zones", "Optional": false }, + { "ComparisonOperator": "\u003e=", "Key": "slo", "Optional": true } + ], + "type": "http_alert_origin_error" + } + ] + }, + "type": "object" + } + } + } + ] + }, + "alert-types_components-schemas-type": { + "description": "Use this value when creating and updating a notification policy.", + "example": "http_alert_origin_error", + "type": "string" + }, + "alert_body": { + "description": "Message body included in the notification sent.", + "example": "SSL certificate has expired", + "type": "string" + }, + "alert_type": { + "description": "Refers to which event will trigger a Notification dispatch. You can use the endpoint to get available alert types which then will give you a list of possible values.", + "example": "universal_ssl_event_type", + "type": "string" + }, + "algo": { "description": "TSIG algorithm.", "example": "hmac-sha512.", "type": "string" }, + "algorithm": { + "description": "Algorithm key code.", + "example": "13", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "allow_all_headers": { "description": "Allows all HTTP request headers.", "example": true, "type": "boolean" }, + "allow_all_methods": { "description": "Allows all HTTP request methods.", "type": "boolean" }, + "allow_all_origins": { "description": "Allows all origins.", "type": "boolean" }, + "allow_credentials": { + "description": "When set to `true`, includes credentials (cookies, authorization headers, or TLS client certificates) with requests.", + "type": "boolean" + }, + "allow_insecure": { + "default": false, + "description": "Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.", + "example": true, + "type": "boolean" + }, + "allow_mode_switch": { + "description": "Whether to allow the user to switch WARP between modes.", + "example": true, + "type": "boolean" + }, + "allow_null_cipher": { + "description": "When `true`, the tunnel can use a null-cipher (`ENCR_NULL`) in the ESP tunnel (Phase 2).", + "example": true, + "type": "boolean" + }, + "allow_updates": { + "description": "Whether to receive update notifications when a new version of the client is available.", + "example": true, + "type": "boolean" + }, + "allowed": { "default": false, "description": "The result of the authentication event.", "type": "boolean" }, + "allowed-r2rT3jf5": { + "description": "Cloudflare Images allowed usage.", + "example": 100000, + "readOnly": true, + "type": "number" + }, + "allowedOrigins": { + "description": "Lists the origins allowed to display the video. Enter allowed origin domains in an array and use `*` for wildcard subdomains. Empty arrays allow the video to be viewed on any origin.", + "example": ["example.com"], + "items": { "type": "string" }, + "type": "array" + }, + "allowed_headers": { "description": "Allowed HTTP request headers.", "items": {}, "type": "array" }, + "allowed_idps": { + "description": "The identity providers your users can select when connecting to this application. Defaults to all IdPs configured in your account.", + "items": { + "description": "The identity providers selected for application.", + "example": "699d98642c564d2e855e9661899b7252", + "type": "string" + }, + "type": "array" + }, + "allowed_match_count": { + "default": 0, + "description": "Related DLP policies will trigger when the match count exceeds the number set.", + "example": 5, + "maximum": 1000, + "minimum": 0, + "type": "number" + }, + "allowed_methods": { + "description": "Allowed HTTP request methods.", + "example": ["GET"], + "items": { + "enum": ["GET", "POST", "HEAD", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH"], + "type": "string" + }, + "type": "array" + }, + "allowed_modes": { + "description": "The available states for the rule group.", + "example": ["on", "off"], + "items": { "$ref": "#/components/schemas/components-schemas-mode" }, + "readOnly": true, + "type": "array" + }, + "allowed_modes_allow_traditional": { + "description": "Defines the available modes for the current WAF rule.", + "example": ["on", "off"], + "items": { "$ref": "#/components/schemas/mode_allow_traditional" }, + "readOnly": true, + "type": "array" + }, + "allowed_modes_anomaly": { + "description": "Defines the available modes for the current WAF rule. Applies to anomaly detection WAF rules.", + "example": ["on", "off"], + "items": { "$ref": "#/components/schemas/mode_anomaly" }, + "readOnly": true, + "type": "array" + }, + "allowed_modes_deny_traditional": { + "description": "The list of possible actions of the WAF rule when it is triggered.", + "example": ["default", "disable", "simulate", "block", "challenge"], + "items": { "$ref": "#/components/schemas/mode_deny_traditional" }, + "readOnly": true, + "type": "array" + }, + "allowed_origins": { + "description": "Allowed origins.", + "example": ["https://example.com"], + "items": {}, + "type": "array" + }, + "allowed_to_leave": { + "description": "Whether to allow devices to leave the organization.", + "example": true, + "type": "boolean" + }, + "always_online": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { "description": "ID of the zone setting.", "enum": ["always_online"], "example": "always_online" }, + "value": { "$ref": "#/components/schemas/always_online_value" } + } + } + ], + "description": "When enabled, Cloudflare serves limited copies of web pages available from the [Internet Archive's Wayback Machine](https://archive.org/web/) if your server is offline. Refer to [Always Online](https://developers.cloudflare.com/cache/about/always-online) for more information.", + "title": "Always Online Mode" + }, + "always_online_value": { + "default": "on", + "description": "Value of the zone setting.", + "enum": ["on", "off"], + "type": "string" + }, + "always_use_https": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { + "description": "ID of the zone setting.", + "enum": ["always_use_https"], + "example": "always_use_https" + }, + "value": { "$ref": "#/components/schemas/always_use_https_value" } + } + } + ], + "default": "off", + "description": "Reply to all requests for URLs that use \"http\" with a 301 redirect to the equivalent \"https\" URL. If you only want to redirect for a subset of requests, consider creating an \"Always use HTTPS\" page rule.", + "title": "Zone Enable Always Use HTTPS" + }, + "always_use_https_value": { + "default": "off", + "description": "Value of the zone setting.", + "enum": ["on", "off"], + "type": "string" + }, + "amount": { + "description": "The amount associated with this billing item.", + "example": 20.99, + "readOnly": true, + "type": "number" + }, + "analytics": { + "properties": { + "id": { "default": 1, "type": "integer" }, + "origins": { + "example": [ + { + "address": "198.51.100.4", + "changed": true, + "enabled": true, + "failure_reason": "No failures", + "healthy": true, + "ip": "198.51.100.4", + "name": "some-origin" + } + ], + "items": {}, + "type": "array" + }, + "pool": { + "example": { + "changed": true, + "healthy": true, + "id": "74bc6a8b9b0dda3d651707a2928bad0c", + "minimum_origins": 1, + "name": "some-pool" + }, + "type": "object" + }, + "timestamp": { "example": "2014-01-01T05:20:00.12345Z", "format": "date-time", "type": "string" } + }, + "type": "object" + }, + "analytics-aggregate_components-schemas-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { "properties": { "result": { "items": { "type": "object" }, "type": "array" } } } + ] + }, + "analytics_components-schemas-identifier": { "example": "17b5962d775c646f3f9725cbc7a53df4" }, + "analytics_components-schemas-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/analytics" }, "type": "array" } } } + ] + }, + "anomaly_description": { + "description": "A summary of the purpose/function of the WAF package.", + "example": "Covers OWASP Top 10 vulnerabilities and more.", + "readOnly": true, + "type": "string" + }, + "anomaly_detection_mode": { + "description": "When a WAF package uses anomaly detection, each rule is given a score when triggered. If the total score of all triggered rules exceeds the sensitivity defined on the WAF package, the action defined on the package will be taken.", + "example": "anomaly", + "readOnly": true, + "type": "string" + }, + "anomaly_name": { + "description": "The name of the WAF package.", + "example": "OWASP ModSecurity Core Rule Set", + "readOnly": true, + "type": "string" + }, + "anomaly_package": { + "allOf": [ + { "$ref": "#/components/schemas/package_definition" }, + { + "properties": { + "action_mode": { "$ref": "#/components/schemas/action_mode" }, + "description": { "$ref": "#/components/schemas/anomaly_description" }, + "detection_mode": { "$ref": "#/components/schemas/anomaly_detection_mode" }, + "name": { "$ref": "#/components/schemas/anomaly_name" }, + "sensitivity": { "$ref": "#/components/schemas/sensitivity" } + } + } + ], + "required": ["id", "name", "description", "zone_id", "detection_mode", "sensitivity", "action_mode"], + "title": "Anomaly detection WAF package (OWASP)" + }, + "anomaly_rule": { + "allOf": [ + { "$ref": "#/components/schemas/rule_components-schemas-base-2" }, + { + "properties": { + "allowed_modes": { "$ref": "#/components/schemas/allowed_modes_anomaly" }, + "mode": { "$ref": "#/components/schemas/mode_anomaly" } + } + } + ], + "description": "When triggered, anomaly detection WAF rules contribute to an overall threat score that will determine if a request is considered malicious. You can configure the total scoring threshold through the 'sensitivity' property of the WAF package.", + "required": ["id", "description", "priority", "allowed_modes", "mode", "group", "package_id"], + "title": "Anomaly detection WAF rule" + }, + "anti-virus-settings": { + "description": "Anti virus settings.", + "properties": { + "enabled_download_phase": { "$ref": "#/components/schemas/enabled_download_phase" }, + "enabled_upload_phase": { "$ref": "#/components/schemas/enabled_upload_phase" }, + "fail_closed": { "$ref": "#/components/schemas/fail_closed" } + }, + "type": "object" + }, + "api-response-collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { + "properties": { + "result": { "items": {}, "nullable": true, "type": "array" }, + "result_info": { "$ref": "#/components/schemas/result_info" } + } + } + ], + "type": "object" + }, + "api-response-collection-common": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { "properties": { "result": { "items": {}, "nullable": true, "type": "array" } } } + ], + "type": "object" + }, + "api-response-common": { + "properties": { + "errors": { "$ref": "#/components/schemas/messages" }, + "messages": { "$ref": "#/components/schemas/messages" }, + "result": { "anyOf": [{ "type": "object" }, { "items": {}, "type": "array" }, { "type": "string" }] }, + "success": { + "description": "Whether the API call was successful", + "enum": [true], + "example": true, + "type": "boolean" + } + }, + "required": ["success", "errors", "messages", "result"], + "type": "object" + }, + "api-response-common-failure": { + "properties": { + "errors": { + "allOf": [{ "$ref": "#/components/schemas/messages" }], + "example": [{ "code": 7003, "message": "No route for the URI" }], + "minLength": 1 + }, + "messages": { "allOf": [{ "$ref": "#/components/schemas/messages" }], "example": [] }, + "result": { "enum": [null], "nullable": true, "type": "object" }, + "success": { + "description": "Whether the API call was successful", + "enum": [false], + "example": false, + "type": "boolean" + } + }, + "required": ["success", "errors", "messages", "result"], + "type": "object" + }, + "api-response-common-failure-3ET5U4FT": { + "properties": { + "errors": { + "allOf": [{ "$ref": "#/components/schemas/messages" }], + "example": [{ "code": 7003, "message": "No route for the URI" }], + "minLength": 1 + }, + "messages": { "allOf": [{ "$ref": "#/components/schemas/messages" }], "example": [] }, + "result": { "nullable": true, "type": "object" }, + "success": { "description": "Whether the API call was successful", "example": false, "type": "boolean" } + }, + "required": ["success", "errors", "messages", "result"], + "type": "object" + }, + "api-response-common-failure-C6O0X824": { + "properties": { + "errors": { + "allOf": [{ "$ref": "#/components/schemas/messages" }], + "example": [{ "code": 7003, "message": "No route for the URI." }], + "minLength": 1 + }, + "messages": { "allOf": [{ "$ref": "#/components/schemas/messages" }], "example": [] }, + "result": { "enum": [null], "nullable": true }, + "success": { + "description": "Whether the API call was successful.", + "enum": [false], + "example": false, + "type": "boolean" + } + }, + "required": ["success", "errors", "messages", "result"], + "type": "object" + }, + "api-response-common-jkxlh21Y": { + "properties": { + "errors": { "$ref": "#/components/schemas/messages" }, + "messages": { "$ref": "#/components/schemas/messages" }, + "success": { "description": "Whether the API call was successful", "example": true, "type": "boolean" } + }, + "required": ["success", "errors", "messages"], + "type": "object" + }, + "api-response-single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { "properties": { "result": { "anyOf": [{ "type": "object" }, { "type": "string" }], "nullable": true } } } + ], + "type": "object" + }, + "api-response-single-id": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { + "properties": { + "result": { + "nullable": true, + "properties": { "id": { "$ref": "#/components/schemas/schemas-identifier" } }, + "required": ["id"], + "type": "object" + } + } + } + ], + "type": "object" + }, + "api-response-single-id-TFlitJo2": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common-jkxlh21Y" }, + { + "properties": { + "result": { + "nullable": true, + "properties": { "id": { "$ref": "#/components/schemas/identifier-MZFDye9j" } }, + "required": ["id"], + "type": "object" + } + } + } + ], + "type": "object" + }, + "api-response-single-id-u7jsvBJu": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { + "properties": { + "result": { + "nullable": true, + "properties": { "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" } }, + "required": ["id"], + "type": "object" + } + } + } + ], + "type": "object" + }, + "api-response-single-ktIvFt8K": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-api-response-common" }, + { "properties": { "result": { "anyOf": [{ "type": "object" }, { "type": "string" }] } } } + ], + "type": "object" + }, + "api-shield": { "allOf": [{ "$ref": "#/components/schemas/operation" }] }, + "api_access_enabled": { + "description": "Enterprise only. Indicates whether or not API access is enabled specifically for this user on a given account.", + "example": true, + "nullable": true, + "type": "boolean" + }, + "app-types": { + "oneOf": [{ "$ref": "#/components/schemas/application" }, { "$ref": "#/components/schemas/application_type" }], + "readOnly": true, + "type": "object" + }, + "app-types_components-schemas-name": { + "description": "The name of the application or application type.", + "example": "Facebook", + "type": "string" + }, + "app-types_components-schemas-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/app-types" }, "type": "array" } } } + ] + }, + "app_domain": { + "description": "The URL of the Access application.", + "example": "test.example.com/admin", + "type": "string" + }, + "app_id": { + "description": "The identifier for this application. There is only one application per id.", + "type": "integer" + }, + "app_id-akwLjhUv": { "example": "699d98642c564d2e855e9661899b7252" }, + "app_id-yTGvAfYO": { + "description": "Application identifier.", + "example": "ea95132c15732412d22c1476fa83f27a", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "app_id_param": { + "description": "Comma-delimited list of Spectrum Application Id(s). If provided, the response will be limited to Spectrum Application Id(s) that match.", + "example": "ea95132c15732412d22c1476fa83f27a,d122c5f4bb71e25cc9e86ab43b142e2f", + "type": "string" + }, + "app_launcher_props": { + "allOf": [ + { "$ref": "#/components/schemas/feature_app_props-g2VC0WUC" }, + { + "properties": { + "domain": { "example": "authdomain.cloudflareaccess.com", "readOnly": true }, + "name": { "default": "App Launcher", "example": "App Launcher", "readOnly": true }, + "type": { "description": "The application type.", "example": "app_launcher", "type": "string" } + } + } + ] + }, + "app_launcher_visible": { + "default": true, + "description": "Displays the application in the App Launcher.", + "example": true, + "type": "boolean" + }, + "app_type_id": { + "description": "The identifier for the type of this application. There can be many applications with the same type. This refers to the `id` of an Application Type that has been returned.", + "type": "integer" + }, + "app_uid": { + "description": "The unique identifier for the Access application.", + "example": "df7e2w5f-02b7-4d9d-af26-8d1988fca630" + }, + "application": { + "properties": { + "application_type_id": { "$ref": "#/components/schemas/app_type_id" }, + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "id": { "$ref": "#/components/schemas/app_id" }, + "name": { "$ref": "#/components/schemas/app-types_components-schemas-name" } + }, + "type": "object" + }, + "application-WiomAg5h": { + "description": "Application that the hostname belongs to.", + "properties": { "id": { "type": "integer" }, "name": { "example": "CLOUDFLARE", "type": "string" } }, + "type": "object" + }, + "application_type": { + "properties": { + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "description": { + "description": "A short summary of applications with this type.", + "example": "Applications used to communicate or collaborate in a business setting.", + "type": "string" + }, + "id": { "$ref": "#/components/schemas/app_type_id" }, + "name": { "$ref": "#/components/schemas/app-types_components-schemas-name" } + }, + "type": "object" + }, + "approval_group": { + "description": "A group of email addresses that can approve a temporary authentication request.", + "properties": { + "approvals_needed": { + "description": "The number of approvals needed to obtain access.", + "example": 1, + "minimum": 0, + "type": "number" + }, + "email_addresses": { + "description": "A list of emails that can approve the access request.", + "example": ["test@cloudflare.com", "test2@cloudflare.com"], + "items": {}, + "type": "array" + }, + "email_list_uuid": { "description": "The UUID of an re-usable email list.", "type": "string" } + }, + "required": ["approvals_needed"], + "type": "object" + }, + "approval_groups": { + "description": "Administrators who can approve a temporary authentication request.", + "example": [ + { "approvals_needed": 1, "email_addresses": ["test1@cloudflare.com", "test2@cloudflare.com"] }, + { "approvals_needed": 3, "email_list_uuid": "597147a1-976b-4ef2-9af0-81d5d007fc34" } + ], + "items": { "$ref": "#/components/schemas/approval_group" }, + "type": "array" + }, + "approval_required": { + "default": false, + "description": "Requires the user to request access from an administrator at the start of each session.", + "example": true, + "type": "boolean" + }, + "approved": { + "description": "Approval state of the prefix (P = pending, V = active).", + "example": "P", + "type": "string" + }, + "apps": { + "anyOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/basic_app_response_props-4oEch10U" }, + { "$ref": "#/components/schemas/self_hosted_props-pFu7lQyL" } + ], + "title": "Self Hosted Application", + "type": "object" + }, + { + "allOf": [ + { "$ref": "#/components/schemas/basic_app_response_props-4oEch10U" }, + { "$ref": "#/components/schemas/saas_props-3mDdjpPa" } + ], + "title": "SaaS Application", + "type": "object" + }, + { + "allOf": [ + { "$ref": "#/components/schemas/basic_app_response_props-4oEch10U" }, + { "$ref": "#/components/schemas/ssh_props" } + ], + "title": "Browser SSH Application", + "type": "object" + }, + { + "allOf": [ + { "$ref": "#/components/schemas/basic_app_response_props-4oEch10U" }, + { "$ref": "#/components/schemas/vnc_props" } + ], + "title": "Browser VNC Application", + "type": "object" + }, + { + "allOf": [ + { "$ref": "#/components/schemas/basic_app_response_props-4oEch10U" }, + { "$ref": "#/components/schemas/app_launcher_props" } + ], + "title": "App Launcher Application", + "type": "object" + }, + { + "allOf": [ + { "$ref": "#/components/schemas/basic_app_response_props-4oEch10U" }, + { "$ref": "#/components/schemas/warp_props" } + ], + "title": "Device Enrollment Permissions Application", + "type": "object" + }, + { + "allOf": [ + { "$ref": "#/components/schemas/basic_app_response_props-4oEch10U" }, + { "$ref": "#/components/schemas/biso_props" } + ], + "title": "Browser Isolation Permissions Application", + "type": "object" + }, + { + "allOf": [ + { "$ref": "#/components/schemas/basic_app_response_props-4oEch10U" }, + { "$ref": "#/components/schemas/bookmark_props" } + ], + "title": "Bookmark application", + "type": "object" + } + ] + }, + "apps_components-schemas-id_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { "properties": { "id": { "$ref": "#/components/schemas/uuid-s0SXln0q" } }, "type": "object" } + } + } + ] + }, + "apps_components-schemas-name": { + "description": "The name of the application.", + "example": "Admin Site", + "type": "string" + }, + "apps_components-schemas-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/apps" }, "type": "array" } } } + ] + }, + "apps_components-schemas-response_collection-2": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/schemas-apps-DgI9Bh95" }, "type": "array" } + } + } + ] + }, + "apps_components-schemas-single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/apps" } } } + ] + }, + "apps_components-schemas-single_response-2": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/schemas-apps-DgI9Bh95" } } } + ] + }, + "apps_components-schemas-type": { + "description": "The application type.", + "enum": ["self_hosted", "saas", "ssh", "vnc", "app_launcher", "warp", "biso", "bookmark", "dash_sso"], + "example": "self_hosted", + "type": "string" + }, + "arch": { + "description": "The cloudflared OS architecture used to establish this connection.", + "example": "linux_amd64", + "type": "string" + }, + "argo-tunnel": { + "properties": { + "connections": { + "description": "The tunnel connections between your origin and Cloudflare's edge.", + "items": { "$ref": "#/components/schemas/components-schemas-connection" }, + "type": "array" + }, + "created_at": { "$ref": "#/components/schemas/cloudflare-tunnel_components-schemas-created_at" }, + "deleted_at": { "$ref": "#/components/schemas/deleted_at-5nLnuPfs" }, + "id": { "$ref": "#/components/schemas/tunnel_id" }, + "name": { "$ref": "#/components/schemas/tunnel_name" } + }, + "required": ["id", "name", "created_at", "connections"], + "type": "object" + }, + "argo_smart_routing": { + "default": false, + "description": "Enables Argo Smart Routing for this application.\nNotes: Only available for TCP applications with traffic_type set to \"direct\".", + "example": true, + "type": "boolean" + }, + "asn": { + "description": "Autonomous System Number (ASN) the prefix will be advertised under.", + "example": 209242, + "nullable": true, + "type": "integer" + }, + "asn-N957CyNV": { + "description": "Autonomous System Number (ASN) the prefix will be advertised under.", + "nullable": true, + "type": "integer" + }, + "asn_components-schemas-asn": { + "properties": { + "asn": { "$ref": "#/components/schemas/components-schemas-asn" }, + "country": { "$ref": "#/components/schemas/asn_country" }, + "description": { "$ref": "#/components/schemas/asn_description" }, + "domain_count": { "type": "integer" }, + "top_domains": { "example": ["example.com"], "items": { "type": "string" }, "type": "array" }, + "type": { "$ref": "#/components/schemas/asn_type" } + } + }, + "asn_components-schemas-response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/asn_components-schemas-asn" } } } + ] + }, + "asn_configuration": { + "properties": { + "target": { + "description": "The configuration target. You must set the target to `asn` when specifying an Autonomous System Number (ASN) in the rule.", + "enum": ["asn"], + "example": "asn" + }, + "value": { "description": "The AS number to match.", "example": "AS12345", "type": "string" } + }, + "title": "An ASN configuration." + }, + "asn_country": { "example": "US", "type": "string" }, + "asn_description": { "example": "CLOUDFLARENET", "type": "string" }, + "asn_type": { + "description": "Infrastructure type of this ASN.", + "enum": ["hosting_provider", "isp", "organization"], + "example": "hosting_provider", + "type": "string" + }, + "associated_hostnames": { + "description": "The hostnames of the applications that will use this certificate.", + "items": { + "description": "A fully-qualified domain name (FQDN).", + "example": "admin.example.com", + "type": "string" + }, + "type": "array" + }, + "associationObject": { + "properties": { + "service": { "$ref": "#/components/schemas/service" }, + "status": { "$ref": "#/components/schemas/mtls-management_components-schemas-status" } + } + }, + "association_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/associationObject" }, "type": "array" } + } + } + ] + }, + "attack_mitigation": { + "description": "Attack mitigation settings.", + "nullable": true, + "properties": { + "enabled": { + "description": "When enabled, random-prefix attacks are automatically mitigated and the origin DNS servers protected.", + "example": true, + "type": "boolean" + }, + "only_when_origin_unhealthy": { + "default": true, + "description": "Only mitigate attacks when origin servers seem unhealthy.", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "aud": { + "description": "The Application Audience (AUD) tag. Identifies the application associated with the CA.", + "example": "737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893", + "maxLength": 64, + "readOnly": true, + "type": "string" + }, + "audit-logs": { + "properties": { + "action": { + "properties": { + "result": { + "description": "A boolean that indicates if the action attempted was successful.", + "example": true, + "type": "boolean" + }, + "type": { + "description": "A short string that describes the action that was performed.", + "example": "change_setting", + "type": "string" + } + }, + "type": "object" + }, + "actor": { + "properties": { + "email": { + "description": "The email of the user that performed the action.", + "example": "michelle@example.com", + "format": "email", + "type": "string" + }, + "id": { + "description": "The ID of the actor that performed the action. If a user performed the action, this will be their User ID.", + "example": "f6b5de0326bb5182b8a4840ee01ec774", + "type": "string" + }, + "ip": { + "description": "The IP address of the request that performed the action.", + "example": "198.41.129.166", + "type": "string" + }, + "type": { + "description": "The type of actor, whether a User, Cloudflare Admin, or an Automated System.", + "enum": ["user", "admin", "Cloudflare"], + "example": "user", + "type": "string" + } + }, + "type": "object" + }, + "id": { + "description": "A string that uniquely identifies the audit log.", + "example": "d5b0f326-1232-4452-8858-1089bd7168ef", + "type": "string" + }, + "interface": { "description": "The source of the event.", "example": "API", "type": "string" }, + "metadata": { + "description": "An object which can lend more context to the action being logged. This is a flexible value and varies between different actions.", + "example": { "name": "security_level", "type": "firewall", "value": "high", "zone_name": "example.com" }, + "type": "object" + }, + "newValue": { + "description": "The new value of the resource that was modified.", + "example": "low", + "type": "string" + }, + "oldValue": { + "description": "The value of the resource before it was modified.", + "example": "high", + "type": "string" + }, + "owner": { + "properties": { "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" } }, + "type": "object" + }, + "resource": { + "properties": { + "id": { + "description": "An identifier for the resource that was affected by the action.", + "example": "023e105f4ecef8ad9ca31a8372d0c353", + "type": "string" + }, + "type": { + "description": "A short string that describes the resource that was affected by the action.", + "example": "zone", + "type": "string" + } + }, + "type": "object" + }, + "when": { + "description": "A UTC RFC3339 timestamp that specifies when the action being logged occured.", + "example": "2017-04-26T17:31:07Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "audit_logs_response_collection": { + "oneOf": [ + { + "properties": { + "errors": { "nullable": true }, + "messages": { "example": [], "items": {}, "type": "array" }, + "result": { "items": { "$ref": "#/components/schemas/audit-logs" }, "type": "array" }, + "success": { "example": true, "type": "boolean" } + } + }, + { "$ref": "#/components/schemas/api-response-common" } + ] + }, + "auth_domain": { + "description": "The unique subdomain assigned to your Zero Trust organization.", + "example": "test.cloudflareaccess.com", + "type": "string" + }, + "auth_id_tokens": { + "description": "The total number of auth-ids seen across this calculation.", + "readOnly": true, + "type": "integer" + }, + "auto_connect": { + "description": "The amount of time in minutes to reconnect after having been disabled.", + "example": 0, + "type": "number" + }, + "auto_redirect_to_identity": { + "default": false, + "description": "When set to `true`, users skip the identity provider selection step during login.", + "type": "boolean" + }, + "auto_redirect_to_identity-zRTYoQOC": { + "default": false, + "description": "When set to `true`, users skip the identity provider selection step during login. You must specify only one identity provider in allowed_idps.", + "type": "boolean" + }, + "auto_refresh_seconds": { + "description": "How often should a secondary zone auto refresh regardless of DNS NOTIFY.\nNot applicable for primary zones.", + "example": 86400, + "type": "number" + }, + "auto_renew": { + "description": "Auto-renew controls whether subscription is automatically renewed upon domain expiration.", + "example": true, + "type": "boolean" + }, + "automatic_https_rewrites": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { + "description": "ID of the zone setting.", + "enum": ["automatic_https_rewrites"], + "example": "automatic_https_rewrites" + }, + "value": { "$ref": "#/components/schemas/automatic_https_rewrites_value" } + } + } + ], + "default": "off", + "description": "Enable the Automatic HTTPS Rewrites feature for this zone.", + "title": "Zone Enable Automatic HTTPS Rewrites" + }, + "automatic_https_rewrites_value": { + "default": "on", + "description": "Value of the zone setting.\nNotes: Default value depends on the zone's plan level.", + "enum": ["on", "off"], + "type": "string" + }, + "automatic_platform_optimization": { + "properties": { + "cache_by_device_type": { + "description": "Indicates whether or not [cache by device type](https://developers.cloudflare.com/automatic-platform-optimization/reference/cache-device-type/) is enabled.", + "example": false, + "type": "boolean" + }, + "cf": { + "default": false, + "description": "Indicates whether or not Cloudflare proxy is enabled.", + "example": true, + "type": "boolean" + }, + "enabled": { + "default": false, + "description": "Indicates whether or not Automatic Platform Optimization is enabled.", + "example": true, + "type": "boolean" + }, + "hostnames": { + "description": "An array of hostnames where Automatic Platform Optimization for WordPress is activated.", + "example": ["www.example.com", "example.com", "shop.example.com"], + "items": { "format": "hostname", "type": "string" }, + "type": "array" + }, + "wordpress": { + "default": false, + "description": "Indicates whether or not site is powered by WordPress.", + "example": true, + "type": "boolean" + }, + "wp_plugin": { + "default": false, + "description": "Indicates whether or not [Cloudflare for WordPress plugin](https://wordpress.org/plugins/cloudflare/) is installed.", + "example": true, + "type": "boolean" + } + }, + "required": ["enabled", "cf", "wordpress", "wp_plugin", "hostnames", "cache_by_device_type"], + "type": "object" + }, + "availability_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "items": { + "description": "Name of zone based on which account custom nameservers can be created. For example, if example.com is returned, then ns1.example.com can be used as an account custom nameserver.", + "example": "example.com", + "format": "hostname", + "readOnly": true, + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + ] + }, + "available": { + "description": "When true, the Managed Transform is available in the current Cloudflare plan.", + "example": true, + "type": "boolean" + }, + "available-rate-plan": { + "properties": { + "can_subscribe": { "$ref": "#/components/schemas/can_subscribe" }, + "currency": { "$ref": "#/components/schemas/currency" }, + "externally_managed": { "$ref": "#/components/schemas/externally_managed" }, + "frequency": { "$ref": "#/components/schemas/schemas-frequency" }, + "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" }, + "is_subscribed": { "$ref": "#/components/schemas/is_subscribed" }, + "legacy_discount": { "$ref": "#/components/schemas/legacy_discount" }, + "legacy_id": { "$ref": "#/components/schemas/legacy_id" }, + "name": { "$ref": "#/components/schemas/rate-plan_components-schemas-name" }, + "price": { "$ref": "#/components/schemas/schemas-price" } + }, + "type": "object" + }, + "azureAD": { + "allOf": [ + { "$ref": "#/components/schemas/identity-provider" }, + { + "properties": { + "config": { + "allOf": [ + { "$ref": "#/components/schemas/generic-oauth-config" }, + { + "properties": { + "directory_id": { + "description": "Your Azure directory uuid", + "example": "\u003cyour azure directory uuid\u003e", + "type": "string" + }, + "support_groups": { + "description": "Should Cloudflare try to load groups from your account", + "type": "boolean" + } + }, + "type": "object" + } + ] + } + }, + "type": "object" + } + ], + "title": "Azure AD", + "type": "object" + }, + "azure_group_rule": { + "description": "Matches an Azure group.\nRequires an Azure identity provider.", + "properties": { + "azureAD": { + "properties": { + "connection_id": { + "description": "The ID of your Azure identity provider.", + "example": "ea85612a-29c8-46c2-bacb-669d65136971", + "type": "string" + }, + "id": { + "description": "The ID of an Azure group.", + "example": "aa0a4aab-672b-4bdb-bc33-a59f1130a11f", + "type": "string" + } + }, + "required": ["id", "connection_id"], + "type": "object" + } + }, + "required": ["azureAD"], + "title": "Azure group", + "type": "object" + }, + "bandwidth": { + "description": "Breakdown of totals for bandwidth in the form of bytes.", + "properties": { + "all": { "description": "The total number of bytes served within the time frame.", "type": "integer" }, + "cached": { + "description": "The number of bytes that were cached (and served) by Cloudflare.", + "type": "integer" + }, + "content_type": { + "description": "A variable list of key/value pairs where the key represents the type of content served, and the value is the number in bytes served.", + "example": { "css": 237421, "gif": 1234242, "html": 1231290, "javascript": 123245, "jpeg": 784278 }, + "type": "object" + }, + "country": { + "description": "A variable list of key/value pairs where the key is a two-digit country code and the value is the number of bytes served to that country.", + "example": { "AG": 2342483, "GI": 984753, "US": 123145433 }, + "type": "object" + }, + "ssl": { + "description": "A break down of bytes served over HTTPS.", + "properties": { + "encrypted": { "description": "The number of bytes served over HTTPS.", "type": "integer" }, + "unencrypted": { "description": "The number of bytes served over HTTP.", "type": "integer" } + }, + "type": "object" + }, + "ssl_protocols": { + "description": "A breakdown of requests by their SSL protocol.", + "properties": { + "TLSv1": { "description": "The number of requests served over TLS v1.0.", "type": "integer" }, + "TLSv1.1": { "description": "The number of requests served over TLS v1.1.", "type": "integer" }, + "TLSv1.2": { "description": "The number of requests served over TLS v1.2.", "type": "integer" }, + "TLSv1.3": { "description": "The number of requests served over TLS v1.3.", "type": "integer" }, + "none": { "description": "The number of requests served over HTTP.", "type": "integer" } + }, + "type": "object" + }, + "uncached": { + "description": "The number of bytes that were fetched and served from the origin server.", + "type": "integer" + } + }, + "type": "object" + }, + "bandwidth_by_colo": { + "description": "Breakdown of totals for bandwidth in the form of bytes.", + "properties": { + "all": { "description": "The total number of bytes served within the time frame.", "type": "integer" }, + "cached": { + "description": "The number of bytes that were cached (and served) by Cloudflare.", + "type": "integer" + }, + "uncached": { + "description": "The number of bytes that were fetched and served from the origin server.", + "type": "integer" + } + }, + "type": "object" + }, + "base": { + "properties": { + "comment": { "$ref": "#/components/schemas/comment" }, + "created_on": { + "description": "When the record was created.", + "example": "2014-01-01T05:20:00.12345Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "id": { "$ref": "#/components/schemas/identifier-zpETYDGh" }, + "locked": { + "description": "Whether this record can be modified/deleted (true means it's managed by Cloudflare).", + "example": false, + "readOnly": true, + "type": "boolean" + }, + "meta": { + "description": "Extra Cloudflare-specific information about the record.", + "properties": { + "auto_added": { + "description": "Will exist if Cloudflare automatically added this DNS record during initial setup.", + "example": true, + "type": "boolean" + }, + "source": { "description": "Where the record originated from.", "example": "primary", "type": "string" } + }, + "readOnly": true, + "type": "object" + }, + "modified_on": { + "description": "When the record was last modified.", + "example": "2014-01-01T05:20:00.12345Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "proxiable": { + "description": "Whether the record can be proxied by Cloudflare or not.", + "example": true, + "readOnly": true, + "type": "boolean" + }, + "tags": { "$ref": "#/components/schemas/tags" }, + "ttl": { "$ref": "#/components/schemas/ttl-Us5Qprrb" }, + "zone_id": { "$ref": "#/components/schemas/identifier-zpETYDGh" }, + "zone_name": { + "description": "The domain of the record.", + "example": "example.com", + "format": "hostname", + "readOnly": true, + "type": "string" + } + } + }, + "base-bSfRyaRZ": { + "properties": { + "expires_on": { "$ref": "#/components/schemas/schemas-expires_on-SFzDZ8Kt" }, + "id": { "$ref": "#/components/schemas/invite_components-schemas-identifier" }, + "invited_by": { "$ref": "#/components/schemas/invited_by" }, + "invited_member_email": { "$ref": "#/components/schemas/invited_member_email" }, + "invited_member_id": { + "description": "ID of the user to add to the organization.", + "example": "5a7805061c76ada191ed06f989cc3dac", + "maxLength": 32, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "invited_on": { "$ref": "#/components/schemas/invited_on" }, + "organization_id": { + "description": "ID of the organization the user will be added to.", + "example": "5a7805061c76ada191ed06f989cc3dac", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "organization_name": { + "description": "Organization name.", + "example": "Cloudflare, Inc.", + "maxLength": 100, + "readOnly": true, + "type": "string" + }, + "roles": { + "description": "Roles to be assigned to this user.", + "items": { "$ref": "#/components/schemas/schemas-role" }, + "type": "array" + } + }, + "required": ["invited_member_id", "organization_id"], + "type": "object" + }, + "base-cc0u02EK": { + "properties": { + "created_on": { + "description": "When the Keyless SSL was created.", + "example": "2014-01-01T05:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "enabled": { "$ref": "#/components/schemas/enabled-uhOFAV56" }, + "host": { "$ref": "#/components/schemas/host-EEtGIG7W" }, + "id": { "$ref": "#/components/schemas/schemas-identifier-f8xN4YrK" }, + "modified_on": { + "description": "When the Keyless SSL was last modified.", + "example": "2014-01-01T05:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { "$ref": "#/components/schemas/name-VvYEM0tR" }, + "permissions": { + "description": "Available permissions for the Keyless SSL for the current user requesting the item.", + "example": ["#ssl:read", "#ssl:edit"], + "items": {}, + "readOnly": true, + "type": "array" + }, + "port": { "$ref": "#/components/schemas/port-z0PISaVA" }, + "status": { "$ref": "#/components/schemas/schemas-status" }, + "tunnel": { "$ref": "#/components/schemas/keyless_tunnel" } + }, + "required": ["id", "name", "host", "port", "status", "enabled", "permissions", "created_on", "modified_on"], + "type": "object" + }, + "base-ozkeixvx": { + "properties": { + "editable": { + "default": true, + "description": "Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).", + "enum": [true, false], + "readOnly": true, + "type": "boolean" + }, + "id": { "description": "Identifier of the zone setting.", "example": "development_mode", "type": "string" }, + "modified_on": { + "description": "last time this setting was modified.", + "example": "2014-01-01T05:20:00.12345Z", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "value": { "description": "Current value of the zone setting.", "example": "on" } + }, + "required": ["id", "value"] + }, + "basic_app_response_props": { + "properties": { + "aud": { "$ref": "#/components/schemas/schemas-aud" }, + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "id": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" }, + "updated_at": { "$ref": "#/components/schemas/timestamp" } + }, + "type": "object" + }, + "basic_app_response_props-4oEch10U": { + "properties": { + "aud": { "$ref": "#/components/schemas/schemas-aud" }, + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "id": { "$ref": "#/components/schemas/uuid-s0SXln0q" }, + "updated_at": { "$ref": "#/components/schemas/timestamp" } + }, + "type": "object" + }, + "batch_size": { "example": 10, "type": "number" }, + "before": { + "description": "Limit the returned results to history records older than the specified date. This must be a timestamp that conforms to RFC3339.", + "example": "2022-05-20T20:29:58.679897Z", + "format": "date-time", + "type": "string" + }, + "beta": { + "description": "Whether the category is in beta and subject to change.", + "example": false, + "type": "boolean" + }, + "billing-history": { + "properties": { + "action": { "$ref": "#/components/schemas/action-ypBxWT3F" }, + "amount": { "$ref": "#/components/schemas/amount" }, + "currency": { "$ref": "#/components/schemas/currency" }, + "description": { "$ref": "#/components/schemas/schemas-description-MUzoo3Z3" }, + "id": { "$ref": "#/components/schemas/billing-history_components-schemas-identifier" }, + "occurred_at": { "$ref": "#/components/schemas/occurred_at" }, + "type": { "$ref": "#/components/schemas/type-52Dm78wx" }, + "zone": { "$ref": "#/components/schemas/schemas-zone" } + }, + "required": ["id", "type", "action", "description", "occurred_at", "amount", "currency", "zone"], + "type": "object" + }, + "billing-history_components-schemas-identifier": { + "description": "Billing item identifier tag.", + "example": "b69a9f3492637782896352daae219e7d", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "billing_history_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { "result": { "items": { "$ref": "#/components/schemas/billing-history" }, "type": "array" } } + } + ] + }, + "billing_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } }, "type": "object" } + ] + }, + "binding": { + "oneOf": [ + { "$ref": "#/components/schemas/kv_namespace_binding" }, + { "$ref": "#/components/schemas/wasm_module_binding" } + ] + }, + "binding_name": { + "description": "A JavaScript variable name for the binding.", + "example": "myBinding", + "readOnly": true, + "type": "string" + }, + "biso_props": { + "allOf": [ + { "$ref": "#/components/schemas/feature_app_props-g2VC0WUC" }, + { + "properties": { + "domain": { "example": "authdomain.cloudflareaccess.com/browser", "readOnly": true }, + "name": { + "default": "Clientless Web Isolation", + "example": "Clientless Web Isolation", + "readOnly": true + }, + "type": { "description": "The application type.", "example": "biso", "type": "string" } + } + } + ] + }, + "block-page-settings": { + "description": "Block page layout settings.", + "properties": { + "background_color": { "description": "Block page background color in #rrggbb format.", "type": "string" }, + "enabled": { + "description": "Enable only cipher suites and TLS versions compliant with FIPS 140-2.", + "example": true, + "type": "boolean" + }, + "footer_text": { "description": "Block page footer text.", "example": "--footer--", "type": "string" }, + "header_text": { "description": "Block page header text.", "example": "--header--", "type": "string" }, + "logo_path": { + "description": "Full URL to the logo file.", + "example": "https://logos.com/a.png", + "type": "string" + }, + "mailto_address": { + "description": "Admin email for users to contact.", + "example": "admin@example.com", + "type": "string" + }, + "mailto_subject": { + "description": "Subject line for emails created from block page.", + "example": "Blocked User Inquiry", + "type": "string" + }, + "name": { "description": "Block page title.", "example": "Cloudflare", "type": "string" }, + "suppress_footer": { + "description": "Suppress detailed info at the bottom of the block page.", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "body": { + "description": "The response body to return. The value must conform to the configured content type.", + "example": "\u003cerror\u003eThis request has been rate-limited.\u003c/error\u003e", + "maxLength": 10240, + "type": "string" + }, + "body-scanning-settings": { + "description": "DLP body scanning setting", + "properties": { + "inspection_mode": { + "description": "Inspection mode. One of deep or shallow", + "example": "deep", + "type": "string" + } + }, + "type": "object" + }, + "bookmark_props": { + "properties": { + "app_launcher_visible": { "default": true }, + "domain": { "description": "The URL or domain of the bookmark.", "example": "https://mybookmark.com" }, + "logo_url": { "$ref": "#/components/schemas/logo_url" }, + "name": { "$ref": "#/components/schemas/apps_components-schemas-name" }, + "type": { "description": "The application type.", "example": "bookmark", "type": "string" } + }, + "title": "Bookmark application", + "type": "object" + }, + "bookmarks": { + "properties": { + "app_launcher_visible": { "$ref": "#/components/schemas/schemas-app_launcher_visible" }, + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "domain": { "$ref": "#/components/schemas/schemas-domain" }, + "id": { "description": "The unique identifier for the Bookmark application." }, + "logo_url": { "$ref": "#/components/schemas/logo_url" }, + "name": { "$ref": "#/components/schemas/bookmarks_components-schemas-name" }, + "updated_at": { "$ref": "#/components/schemas/timestamp" } + }, + "type": "object" + }, + "bookmarks-XgcqmQIm": { + "properties": { + "app_launcher_visible": { "$ref": "#/components/schemas/schemas-app_launcher_visible" }, + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "domain": { "$ref": "#/components/schemas/components-schemas-domain" }, + "id": { "description": "The unique identifier for the Bookmark application." }, + "logo_url": { "$ref": "#/components/schemas/logo_url" }, + "name": { "$ref": "#/components/schemas/bookmarks_components-schemas-name" }, + "updated_at": { "$ref": "#/components/schemas/timestamp" } + }, + "type": "object" + }, + "bookmarks_components-schemas-id_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { "properties": { "id": { "$ref": "#/components/schemas/uuid-s0SXln0q" } }, "type": "object" } + } + } + ] + }, + "bookmarks_components-schemas-name": { + "description": "The name of the Bookmark application.", + "example": "My Website", + "type": "string" + }, + "bookmarks_components-schemas-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/bookmarks-XgcqmQIm" }, "type": "array" } + } + } + ] + }, + "bookmarks_components-schemas-single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/bookmarks-XgcqmQIm" } } } + ] + }, + "brand_check": { + "description": "Certificate Authority is manually reviewing the order.", + "example": false, + "type": "boolean" + }, + "brotli": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { "description": "ID of the zone setting.", "enum": ["brotli"], "example": "brotli" }, + "value": { "$ref": "#/components/schemas/brotli_value" } + } + } + ], + "description": "When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset.", + "title": "Brotli Compression" + }, + "brotli_value": { + "default": "off", + "description": "Value of the zone setting.", + "enum": ["off", "on"], + "type": "string" + }, + "browser-isolation-settings": { + "description": "Browser isolation settings.", + "properties": { + "url_browser_isolation_enabled": { + "description": "Enable Browser Isolation.", + "example": true, + "type": "boolean" + } + }, + "type": "object" + }, + "browser_cache_ttl": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { + "description": "ID of the zone setting.", + "enum": ["browser_cache_ttl"], + "example": "browser_cache_ttl" + }, + "value": { "$ref": "#/components/schemas/browser_cache_ttl_value" } + } + } + ], + "description": "Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources will remain on your visitors' computers. Cloudflare will honor any larger times specified by your server. (https://support.cloudflare.com/hc/en-us/articles/200168276).", + "title": "Browser Cache TTL" + }, + "browser_cache_ttl_value": { + "default": 14400, + "description": "Value of the zone setting.\nNotes: Setting a TTL of 0 is equivalent to selecting `Respect Existing Headers`", + "enum": [ + 0, 30, 60, 120, 300, 1200, 1800, 3600, 7200, 10800, 14400, 18000, 28800, 43200, 57600, 72000, 86400, 172800, + 259200, 345600, 432000, 691200, 1382400, 2073600, 2678400, 5356800, 16070400, 31536000 + ], + "type": "number" + }, + "browser_check": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { "description": "ID of the zone setting.", "enum": ["browser_check"], "example": "browser_check" }, + "value": { "$ref": "#/components/schemas/browser_check_value" } + } + } + ], + "description": "Browser Integrity Check is similar to Bad Behavior and looks for common HTTP headers abused most commonly by spammers and denies access to your page. It will also challenge visitors that do not have a user agent or a non standard user agent (also commonly used by abuse bots, crawlers or visitors). (https://support.cloudflare.com/hc/en-us/articles/200170086).", + "title": "Browser Check" + }, + "browser_check_value": { + "default": "on", + "description": "Value of the zone setting.", + "enum": ["on", "off"], + "type": "string" + }, + "bucket_name": { + "description": "Name of the bucket. The name must be greater than 2 and less than 64 characters.", + "example": "example-bucket", + "pattern": "^[a-z0-9][a-z0-9-]*[a-z0-9]", + "type": "string" + }, + "build": { + "description": "The build identifier for the Railgun receiver.", + "example": "b1234", + "readOnly": true, + "type": "string" + }, + "build_config": { + "description": "Configs for the project build process.", + "properties": { + "build_command": { + "description": "Command used to build project.", + "example": "npm run build", + "nullable": true, + "type": "string" + }, + "destination_dir": { + "description": "Output directory of the build.", + "example": "build", + "nullable": true, + "type": "string" + }, + "root_dir": { + "description": "Directory to run the command.", + "example": "/", + "nullable": true, + "type": "string" + }, + "web_analytics_tag": { + "description": "The classifying tag for analytics.", + "example": "cee1c73f6e4743d0b5e6bb1a0bcaabcc", + "nullable": true, + "type": "string" + }, + "web_analytics_token": { + "description": "The auth token for analytics.", + "example": "021e1057c18547eca7b79f2516f06o7x", + "nullable": true, + "type": "string" + } + }, + "type": "object" + }, + "bulk-operation-response-collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "$ref": "#/components/schemas/schemas-operation" } }, "type": "object" } + ] + }, + "bulk_delete": { "items": { "$ref": "#/components/schemas/key_name_bulk" }, "type": "array" }, + "bulk_write": { + "items": { + "properties": { + "base64": { + "default": false, + "description": "Whether or not the server should base64 decode the value before storing it. Useful for writing values that wouldn't otherwise be valid JSON strings, such as images.", + "type": "boolean" + }, + "expiration": { "$ref": "#/components/schemas/expiration" }, + "expiration_ttl": { "$ref": "#/components/schemas/expiration_ttl" }, + "key": { "$ref": "#/components/schemas/key_name_bulk" }, + "metadata": { "$ref": "#/components/schemas/list_metadata" }, + "value": { + "description": "A UTF-8 encoded string to be stored, up to 10 MB in length.", + "example": "Some string", + "maxLength": 10485760, + "type": "string" + } + }, + "type": "object" + }, + "required": ["key", "value"], + "type": "array" + }, + "bundle_method": { + "default": "ubiquitous", + "description": "A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it.", + "enum": ["ubiquitous", "optimal", "force"], + "example": "ubiquitous", + "type": "string" + }, + "bypass": { + "description": "Criteria specifying when the current rate limit should be bypassed. You can specify that the rate limit should not apply to one or more URLs.", + "items": { + "properties": { + "name": { "enum": ["url"], "example": "url", "type": "string" }, + "value": { "description": "The URL to bypass.", "example": "api.example.com/*", "type": "string" } + }, + "type": "object" + }, + "type": "array" + }, + "ca": { + "description": "Indicates whether the certificate is a CA or leaf certificate.", + "example": true, + "type": "boolean" + }, + "ca-kzNNh4FQ": { + "properties": { + "aud": { "$ref": "#/components/schemas/aud" }, + "id": { "$ref": "#/components/schemas/id-e2D1eWah" }, + "public_key": { "$ref": "#/components/schemas/public_key-Qrh0Mu1M" } + }, + "type": "object" + }, + "ca_components-schemas-id": { + "description": "The ID of the CA.", + "example": "7eddae4619b50ab1361ba8ae9bd72269a432fea041529ed9", + "maxLength": 48, + "readOnly": true, + "type": "string" + }, + "ca_components-schemas-id_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { "id": { "$ref": "#/components/schemas/ca_components-schemas-id" } }, + "type": "object" + } + } + } + ] + }, + "ca_components-schemas-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/ca-kzNNh4FQ" }, "type": "array" } } } + ] + }, + "ca_components-schemas-response_collection-PJ4wkR9R": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/schemas-ca" }, "type": "array" } } } + ] + }, + "ca_components-schemas-single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } } } + ] + }, + "cache-rules_components-schemas-action_parameters": { + "description": "The parameters configuring the action.", + "oneOf": [{ "$ref": "#/components/schemas/action_parameters_set_cache_settings" }], + "type": "object" + }, + "cache-rules_components-schemas-rule": { + "properties": { + "action": { "example": "set_cache_settings" }, + "action_parameters": { "$ref": "#/components/schemas/cache-rules_components-schemas-action_parameters" }, + "description": { "example": "use the cache settings" }, + "expression": { "example": "http.cookie contains \"something\"" }, + "id": { "example": "3a03d665bac047339bb530ecb439a90d" }, + "version": { "example": "1" } + } + }, + "cache-rules_components-schemas-ruleset": { + "properties": { + "description": { "example": "" }, + "id": { "example": "2f2feab2026849078ba485f918791bdc" }, + "kind": { "example": "zone" }, + "name": { "example": "default" }, + "phase": { "example": "http_request_cache_settings" }, + "rules": { + "description": "The rules in the ruleset.", + "items": { "$ref": "#/components/schemas/cache-rules_components-schemas-rule" }, + "type": "array" + } + } + }, + "cache_level": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { "description": "ID of the zone setting.", "enum": ["cache_level"], "example": "cache_level" }, + "value": { "$ref": "#/components/schemas/cache_level_value" } + } + } + ], + "description": "Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). The simplified setting will ignore the query string when delivering a cached resource. The aggressive setting will cache all static resources, including ones with a query string. (https://support.cloudflare.com/hc/en-us/articles/200168256).", + "title": "Cloudflare Cache Level" + }, + "cache_level_value": { + "default": "aggressive", + "description": "Value of the zone setting.", + "enum": ["aggressive", "basic", "simplified"], + "type": "string" + }, + "cache_reserve": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-base" }, + { + "properties": { + "id": { "description": "ID of the zone setting.", "enum": ["cache_reserve"], "example": "cache_reserve" } + } + } + ], + "description": "Increase cache lifetimes by automatically storing all cacheable files into Cloudflare's persistent object storage buckets. Requires Cache Reserve subscription. Note: using Tiered Cache with Cache Reserve is highly recommended to reduce Reserve operations costs. See the [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve) for more information.", + "title": "Cache Reserve" + }, + "cache_reserve_response_value": { + "properties": { + "result": { + "allOf": [ + { "$ref": "#/components/schemas/cache_reserve" }, + { + "properties": { "value": { "$ref": "#/components/schemas/cache_reserve_value" } }, + "required": ["value"] + } + ] + } + } + }, + "cache_reserve_value": { + "default": "off", + "description": "Value of the Cache Reserve zone setting.", + "enum": ["on", "off"], + "type": "string" + }, + "can_delete": { + "description": "If set to false, then the Address Map cannot be deleted via API. This is true for Cloudflare-managed maps.", + "example": true, + "readOnly": true, + "type": "boolean" + }, + "can_modify_ips": { + "description": "If set to false, then the IPs on the Address Map cannot be modified via the API. This is true for Cloudflare-managed maps.", + "example": true, + "readOnly": true, + "type": "boolean" + }, + "can_register": { + "description": "Indicates if the domain can be registered as a new domain.", + "example": false, + "type": "boolean" + }, + "can_subscribe": { + "default": false, + "description": "Indicates whether you can subscribe to this plan.", + "example": true, + "type": "boolean" + }, + "caption_basic_upload": { + "properties": { + "file": { + "description": "The WebVTT file containing the caption or subtitle content.", + "example": "@/Users/kyle/Desktop/tr.vtt", + "type": "string" + } + }, + "required": ["file"], + "type": "object" + }, + "captions": { + "properties": { + "label": { "$ref": "#/components/schemas/label" }, + "language": { "$ref": "#/components/schemas/language" } + }, + "type": "object" + }, + "captive_portal": { + "description": "Turn on the captive portal after the specified amount of time.", + "example": 180, + "type": "number" + }, + "catch_all_rule": { + "properties": { + "actions": { "$ref": "#/components/schemas/rule_catchall-actions" }, + "enabled": { "$ref": "#/components/schemas/rule_enabled-VMnvyEOL" }, + "matchers": { "$ref": "#/components/schemas/rule_catchall-matchers" }, + "name": { "$ref": "#/components/schemas/rule_name" }, + "tag": { "$ref": "#/components/schemas/rule_identifier-wpFBeqHF" } + }, + "type": "object" + }, + "catch_all_rule_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/catch_all_rule" } } } + ] + }, + "categories": { + "properties": { + "beta": { "$ref": "#/components/schemas/beta" }, + "class": { "$ref": "#/components/schemas/class" }, + "description": { "$ref": "#/components/schemas/components-schemas-description" }, + "id": { "$ref": "#/components/schemas/id" }, + "name": { "$ref": "#/components/schemas/categories_components-schemas-name" }, + "subcategories": { + "description": "All subcategories for this category.", + "items": { "$ref": "#/components/schemas/subcategory" }, + "type": "array" + } + }, + "readOnly": true, + "type": "object" + }, + "categories-YFgu3d0j": { + "description": "The categories of the rule.", + "example": ["directory-traversal", "header"], + "items": { "$ref": "#/components/schemas/category" }, + "type": "array" + }, + "categories_components-schemas-name": { + "description": "The name of the category.", + "example": "Education", + "type": "string" + }, + "categories_components-schemas-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/categories" }, "type": "array" } } } + ] + }, + "category": { "description": "A category of the rule.", "example": "directory-traversal", "type": "string" }, + "centrify": { + "allOf": [ + { "$ref": "#/components/schemas/identity-provider" }, + { + "properties": { + "config": { + "allOf": [ + { "$ref": "#/components/schemas/generic-oauth-config" }, + { + "properties": { + "centrify_account": { + "description": "Your centrify account url", + "example": "https://abc123.my.centrify.com/", + "type": "string" + }, + "centrify_app_id": { + "description": "Your centrify app id", + "example": "exampleapp", + "type": "string" + } + }, + "type": "object" + } + ] + } + }, + "type": "object" + } + ], + "title": "Centrify", + "type": "object" + }, + "cert_id": { + "description": "Certificate identifier tag.", + "example": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60", + "maxLength": 36, + "type": "string" + }, + "cert_pack_uuid": { + "description": "Certificate Pack UUID.", + "example": "a77f8bd7-3b47-46b4-a6f1-75cf98109948", + "type": "string" + }, + "certificate": { + "description": "The zone's SSL certificate or certificate and the intermediate(s).", + "example": "-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n", + "type": "string" + }, + "certificate-packs_components-schemas-identifier": { + "description": "The unique identifier for a certificate_pack.", + "example": "3822ff90-ea29-44df-9e55-21300bb9419b", + "readOnly": true, + "type": "string" + }, + "certificate-packs_components-schemas-status": { + "description": "Status of certificate pack.", + "enum": [ + "initializing", + "pending_validation", + "deleted", + "pending_issuance", + "pending_deployment", + "pending_deletion", + "pending_expiration", + "expired", + "active", + "initializing_timed_out", + "validation_timed_out", + "issuance_timed_out", + "deployment_timed_out", + "deletion_timed_out", + "pending_cleanup", + "staging_deployment", + "staging_active", + "deactivating", + "inactive", + "backup_issued", + "holding_deployment" + ], + "example": "initializing", + "type": "string" + }, + "certificateObject": { + "properties": { + "certificate": { + "$ref": "#/components/schemas/zone-authenticated-origin-pull_components-schemas-certificate" + }, + "expires_on": { "$ref": "#/components/schemas/components-schemas-expires_on" }, + "id": { "$ref": "#/components/schemas/identifier-tZwYoMuc" }, + "issuer": { "$ref": "#/components/schemas/issuer" }, + "signature": { "$ref": "#/components/schemas/signature" }, + "status": { "$ref": "#/components/schemas/zone-authenticated-origin-pull_components-schemas-status" }, + "uploaded_on": { "$ref": "#/components/schemas/schemas-uploaded_on" } + } + }, + "certificateObject-ymFm5Oiv": { + "properties": { + "certificate": { + "$ref": "#/components/schemas/zone-authenticated-origin-pull_components-schemas-certificate" + }, + "expires_on": { "$ref": "#/components/schemas/zone-authenticated-origin-pull_components-schemas-expires_on" }, + "id": { "$ref": "#/components/schemas/zone-authenticated-origin-pull_components-schemas-identifier" }, + "issuer": { "$ref": "#/components/schemas/issuer" }, + "signature": { "$ref": "#/components/schemas/signature" }, + "status": { "$ref": "#/components/schemas/zone-authenticated-origin-pull_components-schemas-status" }, + "uploaded_on": { "$ref": "#/components/schemas/schemas-uploaded_on" } + } + }, + "certificateObjectPost": { + "properties": { + "ca": { "$ref": "#/components/schemas/ca" }, + "certificates": { "$ref": "#/components/schemas/schemas-certificates" }, + "expires_on": { "$ref": "#/components/schemas/mtls-management_components-schemas-expires_on" }, + "id": { "$ref": "#/components/schemas/identifier-tZwYoMuc" }, + "issuer": { "$ref": "#/components/schemas/schemas-issuer" }, + "name": { "$ref": "#/components/schemas/schemas-name-F4rYvN2r" }, + "serial_number": { "$ref": "#/components/schemas/schemas-serial_number" }, + "signature": { "$ref": "#/components/schemas/signature" }, + "updated_at": { "$ref": "#/components/schemas/schemas-updated_at" }, + "uploaded_on": { "$ref": "#/components/schemas/mtls-management_components-schemas-uploaded_on" } + } + }, + "certificateObjectPost-vGa6WWep": { + "properties": { + "ca": { "$ref": "#/components/schemas/ca" }, + "certificates": { "$ref": "#/components/schemas/schemas-certificates" }, + "expires_on": { "$ref": "#/components/schemas/mtls-management_components-schemas-expires_on" }, + "id": { "$ref": "#/components/schemas/mtls-management_components-schemas-identifier" }, + "issuer": { "$ref": "#/components/schemas/schemas-issuer" }, + "name": { "$ref": "#/components/schemas/mtls-management_components-schemas-name" }, + "serial_number": { "$ref": "#/components/schemas/schemas-serial_number" }, + "signature": { "$ref": "#/components/schemas/signature" }, + "updated_at": { "$ref": "#/components/schemas/schemas-updated_at" }, + "uploaded_on": { "$ref": "#/components/schemas/mtls-management_components-schemas-uploaded_on" } + } + }, + "certificate_analyze_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } } } + ] + }, + "certificate_authority": { + "description": "The Certificate Authority that will issue the certificate", + "enum": ["digicert", "google", "lets_encrypt"], + "example": "google", + "type": "string" + }, + "certificate_authority-VxFhhbhi": { + "description": "Certificate Authority selected for the order. Selecting Let's Encrypt will reduce customization of other fields: validation_method must be 'txt', validity_days must be 90, cloudflare_branding must be omitted, and hosts must contain only 2 entries, one for the zone name and one for the subdomain wildcard of the zone name (e.g. example.com, *.example.com).", + "enum": ["digicert", "google", "lets_encrypt"], + "example": "digicert", + "type": "string" + }, + "certificate_pack_quota_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { "properties": { "advanced": { "$ref": "#/components/schemas/quota" } }, "type": "object" } + }, + "type": "object" + } + ] + }, + "certificate_pack_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "type": "object" }, "type": "array" } } } + ] + }, + "certificate_pack_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } }, "type": "object" } + ] + }, + "certificate_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/custom-certificate-CaAadyYf" }, "type": "array" } + } + } + ] + }, + "certificate_response_id_only": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { "id": { "$ref": "#/components/schemas/identifier-tZwYoMuc" } }, + "type": "object" + } + } + } + ] + }, + "certificate_response_id_only-e7wXd3xw": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "id": { "$ref": "#/components/schemas/custom-certificate_components-schemas-identifier" } + }, + "type": "object" + } + } + } + ] + }, + "certificate_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } } } + ] + }, + "certificate_response_single_id": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-certificate_response_single" }, + { + "properties": { + "result": { "properties": { "id": { "$ref": "#/components/schemas/identifier-tZwYoMuc" } } } + } + } + ] + }, + "certificate_response_single_id-NbTd4zHr": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-certificate_response_single" }, + { + "properties": { + "result": { + "properties": { "id": { "$ref": "#/components/schemas/certificates_components-schemas-identifier" } } + } + } + } + ] + }, + "certificate_response_single_post": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "allOf": [{ "$ref": "#/components/schemas/certificateObjectPost-vGa6WWep" }], + "type": "object" + } + } + } + ] + }, + "certificate_rule": { + "description": "Matches any valid client certificate.", + "example": { "certificate": {} }, + "properties": { "certificate": { "example": {}, "type": "object" } }, + "required": ["certificate"], + "title": "Valid certificate", + "type": "object" + }, + "certificate_status": { + "description": "Current status of certificate.", + "enum": ["initializing", "authorizing", "active", "expired", "issuing", "timing_out", "pending_deployment"], + "example": "active", + "type": "string" + }, + "certificates": { + "properties": { + "certificate": { "$ref": "#/components/schemas/components-schemas-certificate" }, + "csr": { "$ref": "#/components/schemas/csr" }, + "expires_on": { "$ref": "#/components/schemas/schemas-expires_on" }, + "hostnames": { "$ref": "#/components/schemas/hostnames" }, + "id": { "$ref": "#/components/schemas/identifier-tZwYoMuc" }, + "request_type": { "$ref": "#/components/schemas/request_type" }, + "requested_validity": { "$ref": "#/components/schemas/requested_validity" } + }, + "required": ["hostnames", "csr", "requested_validity", "request_type"], + "type": "object" + }, + "certificates-M6ivZ4vU": { + "properties": { + "certificate": { "$ref": "#/components/schemas/components-schemas-certificate" }, + "csr": { "$ref": "#/components/schemas/csr" }, + "expires_on": { "$ref": "#/components/schemas/certificates_components-schemas-expires_on" }, + "hostnames": { "$ref": "#/components/schemas/hostnames" }, + "id": { "$ref": "#/components/schemas/certificates_components-schemas-identifier" }, + "request_type": { "$ref": "#/components/schemas/request_type" }, + "requested_validity": { "$ref": "#/components/schemas/requested_validity" } + }, + "required": ["hostnames", "csr", "requested_validity", "request_type"], + "type": "object" + }, + "certificates-rM299pCu": { + "properties": { + "associated_hostnames": { "$ref": "#/components/schemas/associated_hostnames" }, + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "expires_on": { "$ref": "#/components/schemas/timestamp" }, + "fingerprint": { "$ref": "#/components/schemas/fingerprint" }, + "id": { "description": "The ID of the application that will use this certificate." }, + "name": { "$ref": "#/components/schemas/certificates_components-schemas-name" }, + "updated_at": { "$ref": "#/components/schemas/timestamp" } + }, + "type": "object" + }, + "certificates_components-schemas-expires_on": { + "description": "When the certificate will expire.", + "example": "2014-01-01T05:20:00.12345Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "certificates_components-schemas-id_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { "properties": { "id": { "$ref": "#/components/schemas/uuid-s0SXln0q" } }, "type": "object" } + } + } + ] + }, + "certificates_components-schemas-identifier": { + "description": "The x509 serial number of the Origin CA certificate.", + "example": "328578533902268680212849205732770752308931942346", + "readOnly": true, + "type": "string" + }, + "certificates_components-schemas-name": { + "description": "The name of the certificate.", + "example": "Allow devs", + "type": "string" + }, + "certificates_components-schemas-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/certificates-rM299pCu" }, "type": "array" } + } + } + ] + }, + "certificates_components-schemas-response_collection-DJiYywE0": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/components-schemas-certificates" }, "type": "array" } + } + } + ] + }, + "certificates_components-schemas-single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/certificates-rM299pCu" } } } + ] + }, + "certificates_components-schemas-single_response-XBeTLvbA": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/components-schemas-certificates" } } } + ] + }, + "cf_account_id": { + "description": "Cloudflare account ID", + "example": "699d98642c564d2e855e9661899b7252", + "maxLength": 32, + "type": "string" + }, + "challenge_ttl": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { "description": "ID of the zone setting.", "enum": ["challenge_ttl"], "example": "challenge_ttl" }, + "value": { "$ref": "#/components/schemas/challenge_ttl_value" } + } + } + ], + "description": "Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136).", + "title": "Challenge Page TTL" + }, + "challenge_ttl_value": { + "default": 1800, + "description": "Value of the zone setting.", + "enum": [300, 900, 1800, 2700, 3600, 7200, 10800, 14400, 28800, 57600, 86400, 604800, 2592000, 31536000], + "type": "number" + }, + "characteristics": { + "items": { + "properties": { + "name": { "$ref": "#/components/schemas/characteristics_components-schemas-name" }, + "type": { "$ref": "#/components/schemas/schemas-type" } + }, + "required": ["type", "name"], + "type": "object" + }, + "maxItems": 10, + "type": "array", + "uniqueItems": true + }, + "characteristics_components-schemas-name": { + "description": "The name of the characteristic field, i.e., the header or cookie name.", + "example": "authorization", + "maxLength": 128, + "type": "string" + }, + "checkDisks": { + "description": "List of volume names to be checked for encryption.", + "example": ["C", "D", "G"], + "items": { "type": "string" }, + "type": "array" + }, + "check_regions": { + "description": "A list of regions from which to run health checks. Null means Cloudflare will pick a default region.", + "example": ["WEU", "ENAM"], + "items": { + "description": "WNAM: Western North America, ENAM: Eastern North America, WEU: Western Europe, EEU: Eastern Europe, NSAM: Northern South America, SSAM: Southern South America, OC: Oceania, ME: Middle East, NAF: North Africa, SAF: South Africa, IN: India, SEAS: South East Asia, NEAS: North East Asia, ALL_REGIONS: all regions (BUSINESS and ENTERPRISE customers only).", + "enum": [ + "WNAM", + "ENAM", + "WEU", + "EEU", + "NSAM", + "SSAM", + "OC", + "ME", + "NAF", + "SAF", + "IN", + "SEAS", + "NEAS", + "ALL_REGIONS" + ], + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "check_regions-fqlLEr38": { + "description": "A list of regions from which to run health checks. Null means every Cloudflare data center.", + "example": ["WEU", "ENAM"], + "items": { + "description": "WNAM: Western North America, ENAM: Eastern North America, WEU: Western Europe, EEU: Eastern Europe, NSAM: Northern South America, SSAM: Southern South America, OC: Oceania, ME: Middle East, NAF: North Africa, SAF: South Africa, SAS: Southern Asia, SEAS: South East Asia, NEAS: North East Asia, ALL_REGIONS: all regions (ENTERPRISE customers only).", + "enum": [ + "WNAM", + "ENAM", + "WEU", + "EEU", + "NSAM", + "SSAM", + "OC", + "ME", + "NAF", + "SAF", + "SAS", + "SEAS", + "NEAS", + "ALL_REGIONS" + ], + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "check_regions-q46IR1gk": { + "description": "A list of regions from which to run health checks. Null means every Cloudflare data center.", + "example": ["WEU", "ENAM"], + "items": { + "description": "WNAM: Western North America, ENAM: Eastern North America, WEU: Western Europe, EEU: Eastern Europe, NSAM: Northern South America, SSAM: Southern South America, OC: Oceania, ME: Middle East, NAF: North Africa, SAF: South Africa, SAS: Southern Asia, SEAS: South East Asia, NEAS: North East Asia, ALL_REGIONS: all regions (ENTERPRISE customers only).", + "enum": [ + "WNAM", + "ENAM", + "WEU", + "EEU", + "NSAM", + "SSAM", + "OC", + "ME", + "NAF", + "SAF", + "SAS", + "SEAS", + "NEAS", + "ALL_REGIONS" + ], + "type": "string" + }, + "nullable": true, + "type": "array" + }, + "cidr": { + "description": "IP Prefix in Classless Inter-Domain Routing format.", + "example": "192.0.2.0/24", + "type": "string" + }, + "cidr_configuration": { + "properties": { + "target": { + "description": "The configuration target. You must set the target to `ip_range` when specifying an IP address range in the rule.", + "enum": ["ip_range"], + "example": "ip_range" + }, + "value": { + "description": "The IP address range to match. You can only use prefix lengths `/16` and `/24` for IPv4 ranges, and prefix lengths `/32`, `/48`, and `/64` for IPv6 ranges.", + "example": "198.51.100.4/16", + "type": "string" + } + }, + "title": "An IP address range configuration." + }, + "cidr_list": { + "description": "List of IPv4/IPv6 CIDR addresses.", + "example": ["199.27.128.0/21", "2400:cb00::/32"], + "items": { "description": "IPv4/IPv6 CIDR.", "example": "199.27.128.0/21", "type": "string" }, + "type": "array" + }, + "ciphers": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { "description": "ID of the zone setting.", "enum": ["ciphers"], "example": "ciphers" }, + "value": { "$ref": "#/components/schemas/ciphers_value" } + } + } + ], + "default": [], + "description": "An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format.", + "title": "Zone ciphers allowed for TLS termination" + }, + "ciphers_value": { + "default": [], + "description": "Value of the zone setting.", + "example": ["ECDHE-RSA-AES128-GCM-SHA256", "AES128-SHA"], + "items": { "type": "string" }, + "type": "array", + "uniqueItems": true + }, + "city": { "description": "City.", "example": "Austin", "type": "string" }, + "class": { + "description": "Which account types are allowed to create policies based on this categories. `blocked` categories are blocked unconditionally for all accounts. `removalPending` categories can be removed from policies but not added. `noBlock` categories cannot be blocked.", + "enum": ["free", "premium", "blocked", "removalPending", "noBlock"], + "example": "premium", + "type": "string" + }, + "client-certificates_components-schemas-certificate": { + "description": "The Client Certificate PEM", + "example": "-----BEGIN CERTIFICATE-----\\nMIIDmDCCAoC...dhDDE\\n-----END CERTIFICATE-----", + "readOnly": true, + "type": "string" + }, + "client-certificates_components-schemas-certificate_authority": { + "description": "Certificate Authority used to issue the Client Certificate", + "properties": { + "id": { "example": "568b6b74-7b0c-4755-8840-4e3b8c24adeb", "type": "string" }, + "name": { "example": "Cloudflare Managed CA for account", "type": "string" } + }, + "type": "object" + }, + "client-certificates_components-schemas-status": { + "description": "Client Certificates may be active or revoked, and the pending_reactivation or pending_revocation represent in-progress asynchronous transitions", + "enum": ["active", "pending_reactivation", "pending_revocation", "revoked"], + "example": "active" + }, + "client-default": { + "description": "Set if the location is the default one.", + "example": false, + "type": "boolean" + }, + "client_certificate": { + "properties": { + "certificate": { "$ref": "#/components/schemas/client-certificates_components-schemas-certificate" }, + "certificate_authority": { + "$ref": "#/components/schemas/client-certificates_components-schemas-certificate_authority" + }, + "common_name": { "$ref": "#/components/schemas/common_name" }, + "country": { "$ref": "#/components/schemas/country" }, + "csr": { "$ref": "#/components/schemas/schemas-csr" }, + "expires_on": { "$ref": "#/components/schemas/expired_on" }, + "fingerprint_sha256": { "$ref": "#/components/schemas/fingerprint_sha256" }, + "id": { "$ref": "#/components/schemas/identifier-tZwYoMuc" }, + "issued_on": { "$ref": "#/components/schemas/issued_on" }, + "location": { "$ref": "#/components/schemas/location" }, + "organization": { "$ref": "#/components/schemas/organization" }, + "organizational_unit": { "$ref": "#/components/schemas/organizational_unit" }, + "serial_number": { "$ref": "#/components/schemas/components-schemas-serial_number" }, + "signature": { "$ref": "#/components/schemas/components-schemas-signature" }, + "ski": { "$ref": "#/components/schemas/ski" }, + "state": { "$ref": "#/components/schemas/state" }, + "status": { "$ref": "#/components/schemas/client-certificates_components-schemas-status" }, + "validity_days": { "$ref": "#/components/schemas/components-schemas-validity_days" } + } + }, + "client_certificate_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/client_certificate" }, "type": "array" } + } + } + ] + }, + "client_certificate_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/client_certificate" } } } + ] + }, + "client_id": { + "description": "The Client ID for the service token. Access will check for this value in the `CF-Access-Client-ID` request header.", + "example": "88bf3b6d86161464f6509f7219099e57.access.example.com", + "type": "string" + }, + "client_secret": { + "description": "The Client Secret for the service token. Access will check for this value in the `CF-Access-Client-Secret` request header.", + "example": "bdd31cbc4dec990953e39163fbbb194c93313ca9f0a6e420346af9d326b1d2a5", + "type": "string" + }, + "clipResponseSingle": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "$ref": "#/components/schemas/clipping" } } } + ] + }, + "clipped_from_video_uid": { + "description": "The unique video identifier (UID).", + "example": "023e105f4ecef8ad9ca31a8372d0c353", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "clipping": { + "properties": { + "allowedOrigins": { "$ref": "#/components/schemas/allowedOrigins" }, + "clippedFromVideoUID": { "$ref": "#/components/schemas/clipped_from_video_uid" }, + "created": { "$ref": "#/components/schemas/clipping_created" }, + "creator": { "$ref": "#/components/schemas/creator" }, + "endTimeSeconds": { "$ref": "#/components/schemas/end_time_seconds" }, + "maxDurationSeconds": { "$ref": "#/components/schemas/maxDurationSeconds" }, + "meta": { "$ref": "#/components/schemas/media_metadata" }, + "modified": { "$ref": "#/components/schemas/live_input_modified" }, + "playback": { "$ref": "#/components/schemas/playback" }, + "preview": { "$ref": "#/components/schemas/preview" }, + "requireSignedURLs": { "$ref": "#/components/schemas/requireSignedURLs-9DKWYMwu" }, + "startTimeSeconds": { "$ref": "#/components/schemas/start_time_seconds" }, + "status": { "$ref": "#/components/schemas/media_state" }, + "thumbnailTimestampPct": { "$ref": "#/components/schemas/thumbnailTimestampPct" }, + "watermark": { "$ref": "#/components/schemas/watermarkAtUpload" } + } + }, + "clipping_created": { + "description": "The date and time the clip was created.", + "example": "2014-01-02T02:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "cloudflare-tunnel_components-schemas-connection": { + "properties": { + "client_id": { "description": "UUID of the cloudflared instance." }, + "client_version": { "$ref": "#/components/schemas/cloudflare-tunnel_components-schemas-version" }, + "colo_name": { "$ref": "#/components/schemas/schemas-colo_name" }, + "id": { "$ref": "#/components/schemas/connection_id" }, + "is_pending_reconnect": { "$ref": "#/components/schemas/is_pending_reconnect" }, + "opened_at": { + "description": "Timestamp of when the connection was established.", + "example": "2021-01-25T18:22:34.317854Z", + "format": "date-time", + "type": "string" + }, + "origin_ip": { + "description": "The public IP address of the host running cloudflared.", + "example": "85.12.78.6", + "type": "string" + }, + "uuid": { "$ref": "#/components/schemas/connection_id" } + } + }, + "cloudflare-tunnel_components-schemas-created_at": { + "description": "Timestamp of when the tunnel was created.", + "example": "2021-01-25T18:22:34.317854Z", + "format": "date-time", + "type": "string" + }, + "cloudflare-tunnel_components-schemas-metadata": { + "description": "Metadata associated with the tunnel.", + "example": {}, + "type": "object" + }, + "cloudflare-tunnel_components-schemas-status": { + "description": "The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).", + "example": "healthy", + "type": "string" + }, + "cloudflare-tunnel_components-schemas-version": { + "description": "The cloudflared version used to establish this connection.", + "example": "2022.7.1", + "type": "string" + }, + "cloudflare_branding": { + "description": "Whether or not to add Cloudflare Branding for the order. This will add sni.cloudflaressl.com as the Common Name if set true.", + "example": false, + "type": "boolean" + }, + "cloudflare_gre_endpoint": { + "description": "The IP address assigned to the Cloudflare side of the GRE tunnel.", + "example": "203.0.113.1", + "type": "string" + }, + "cloudflare_ipsec_endpoint": { + "description": "The IP address assigned to the Cloudflare side of the IPsec tunnel.", + "example": "203.0.113.1", + "type": "string" + }, + "cmb_config": { + "nullable": true, + "properties": { "regions": { "$ref": "#/components/schemas/regions" } }, + "type": "object" + }, + "cmb_config_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/cmb_config" } } } + ] + }, + "cname_flattening": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { + "description": "How to flatten the cname destination.", + "enum": ["cname_flattening"], + "example": "flatten_at_root" + }, + "value": { "$ref": "#/components/schemas/cname_flattening_value" } + } + } + ], + "description": "Whether or not cname flattening is on.", + "title": "Cloudflare CNAME Flattening" + }, + "cname_flattening_value": { + "default": "flatten_at_root", + "description": "Value of the cname flattening setting.", + "enum": ["flatten_at_root", "flatten_all"], + "type": "string" + }, + "code": { + "description": "The unique activation code for the account membership.", + "example": "05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0", + "maxLength": 64, + "readOnly": true, + "type": "string" + }, + "collection_invite_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { "result": { "items": { "$ref": "#/components/schemas/invite" }, "type": "array" } }, + "type": "object" + } + ] + }, + "collection_member_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/components-schemas-member" }, "type": "array" } + }, + "type": "object" + } + ] + }, + "collection_membership_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { "result": { "items": { "$ref": "#/components/schemas/membership" }, "type": "array" } }, + "type": "object" + } + ] + }, + "collection_organization_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/organization-8ZC4Qebn" }, "type": "array" } + }, + "type": "object" + } + ] + }, + "collection_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "items": { + "allOf": [{ "$ref": "#/components/schemas/api-shield" }, { "properties": { "features": {} } }] + }, + "type": "array" + } + } + } + ] + }, + "collection_response_paginated": { + "anyOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/collection_response" }, + { + "properties": { + "result_info": { + "properties": { + "count": { + "description": "Total results returned based on your search parameters.", + "example": 1, + "type": "number" + }, + "page": { + "description": "Current page within paginated list of results.", + "example": 1, + "type": "number" + }, + "per_page": { + "description": "Number of results per page of results.", + "example": 20, + "type": "number" + }, + "total_count": { + "description": "Total results available without any search parameters.", + "example": 500, + "type": "number" + } + }, + "type": "object" + } + } + }, + { + "properties": { "result": { "items": { "$ref": "#/components/schemas/api-shield" }, "type": "array" } } + } + ] + }, + { "$ref": "#/components/schemas/collection_response" } + ] + }, + "collection_role_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { "result": { "items": { "$ref": "#/components/schemas/schemas-role" }, "type": "array" } }, + "type": "object" + } + ] + }, + "colo": { + "properties": { + "city": { "$ref": "#/components/schemas/colo_city" }, + "name": { "$ref": "#/components/schemas/colo_name-SO9lmxhl" } + }, + "type": "object" + }, + "colo_city": { "description": "Source colo city.", "example": "Denver, CO, US", "type": "string" }, + "colo_name": { "description": "Scope colo name.", "example": "den01", "type": "string" }, + "colo_name-SO9lmxhl": { "description": "Source colo name.", "example": "den01", "type": "string" }, + "colo_names": { + "description": "List of colo names for the ECMP scope.", + "items": { "$ref": "#/components/schemas/colo_name" }, + "type": "array" + }, + "colo_region": { "description": "Scope colo region.", "example": "APAC", "type": "string" }, + "colo_regions": { + "description": "List of colo regions for the ECMP scope.", + "items": { "$ref": "#/components/schemas/colo_region" }, + "type": "array" + }, + "colo_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "query": { "$ref": "#/components/schemas/query_response" }, + "result": { "$ref": "#/components/schemas/datacenters" } + } + } + ] + }, + "colo_result": { + "properties": { + "colo": { "$ref": "#/components/schemas/colo" }, + "error": { "$ref": "#/components/schemas/error" }, + "hops": { "items": { "$ref": "#/components/schemas/hop_result" }, "type": "array" }, + "target_summary": { "$ref": "#/components/schemas/target_summary" }, + "traceroute_time_ms": { "$ref": "#/components/schemas/traceroute_time_ms" } + }, + "type": "object" + }, + "colos": { + "description": "If no source colo names specified, all colos will be used. China colos are unavailable for traceroutes.", + "example": ["den", "sin"], + "items": { "description": "Source colo name.", "type": "string" }, + "type": "array" + }, + "comment": { + "description": "Comments or notes about the DNS record. This field has no effect on DNS responses.", + "example": "Domain verification record", + "type": "string" + }, + "comment-ZBQ7qz21": { + "description": "Optional remark describing the route.", + "example": "Example comment for this route.", + "type": "string" + }, + "common_components-schemas-identifier": { + "description": "Identifier", + "example": "023e105f4ecef8ad9ca31a8372d0c353", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "common_components-schemas-ip": { + "anyOf": [{ "$ref": "#/components/schemas/ipv4" }, { "$ref": "#/components/schemas/ipv6-KrBmBy6R" }] + }, + "common_name": { + "description": "Common Name of the Client Certificate", + "example": "Cloudflare", + "readOnly": true, + "type": "string" + }, + "component-value": { + "properties": { + "default": { "$ref": "#/components/schemas/default" }, + "name": { "$ref": "#/components/schemas/component-value_components-schemas-name" }, + "unit_price": { "$ref": "#/components/schemas/unit_price" } + }, + "type": "object" + }, + "component-value_components-schemas-name": { + "description": "The unique component.", + "enum": ["zones", "page_rules", "dedicated_certificates", "dedicated_certificates_custom"], + "example": "page_rules" + }, + "component_value": { + "description": "A component value for a subscription.", + "properties": { + "default": { "description": "The default amount assigned.", "example": 5, "type": "number" }, + "name": { "description": "The name of the component value.", "example": "page_rules", "type": "string" }, + "price": { "description": "The unit price for the component value.", "example": 5, "type": "number" }, + "value": { "description": "The amount of the component value assigned.", "example": 20, "type": "number" } + }, + "type": "object" + }, + "component_values": { + "description": "The list of add-ons subscribed to.", + "items": { "$ref": "#/components/schemas/component_value" }, + "type": "array" + }, + "components-schemas-account": { "allOf": [{ "$ref": "#/components/schemas/account" }] }, + "components-schemas-account_identifier": { "example": "9a7806061c88ada191ed06f989cc3dac" }, + "components-schemas-action": { + "description": "The action to apply to a matched request. The `log` action is only available on an Enterprise plan.", + "enum": ["block", "challenge", "js_challenge", "managed_challenge", "allow", "log", "bypass"], + "example": "block", + "type": "string" + }, + "components-schemas-action_parameters": { + "description": "The parameters configuring the action.", + "oneOf": [{ "$ref": "#/components/schemas/action_parameters_redirect" }], + "type": "object" + }, + "components-schemas-asn": { "type": "integer" }, + "components-schemas-base": { + "properties": { + "created_on": { + "description": "When the Keyless SSL was created.", + "example": "2014-01-01T05:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "enabled": { "$ref": "#/components/schemas/enabled-mOUbjYfQ" }, + "host": { "$ref": "#/components/schemas/schemas-host" }, + "id": { "$ref": "#/components/schemas/keyless-certificate_components-schemas-identifier" }, + "modified_on": { + "description": "When the Keyless SSL was last modified.", + "example": "2014-01-01T05:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { "$ref": "#/components/schemas/keyless-certificate_components-schemas-name" }, + "permissions": { + "description": "Available permissions for the Keyless SSL for the current user requesting the item.", + "example": ["#ssl:read", "#ssl:edit"], + "items": {}, + "readOnly": true, + "type": "array" + }, + "port": { "$ref": "#/components/schemas/port-0Rcq4sy6" }, + "status": { "$ref": "#/components/schemas/keyless-certificate_components-schemas-status" } + }, + "required": ["id", "name", "host", "port", "status", "enabled", "permissions", "created_on", "modified_on"], + "type": "object" + }, + "components-schemas-certificate": { + "description": "The Origin CA certificate. Will be newline-encoded.", + "example": "-----BEGIN CERTIFICATE-----\nMIICvDCCAaQCAQAwdzELMAkGA1UEBhMCVVMxDTALBgNVBAgMBFV0YWgxDzANBgNV\nBAcMBkxpbmRvbjEWMBQGA1UECgwNRGlnaUNlcnQgSW5jLjERMA8GA1UECwwIRGln\naUNlcnQxHTAbBgNVBAMMFGV4YW1wbGUuZGlnaWNlcnQuY29tMIIBIjANBgkqhkiG\n9w0BAQEFAAOCAQ8AMIIBCgKCAQEA8+To7d+2kPWeBv/orU3LVbJwDrSQbeKamCmo\nwp5bqDxIwV20zqRb7APUOKYoVEFFOEQs6T6gImnIolhbiH6m4zgZ/CPvWBOkZc+c\n1Po2EmvBz+AD5sBdT5kzGQA6NbWyZGldxRthNLOs1efOhdnWFuhI162qmcflgpiI\nWDuwq4C9f+YkeJhNn9dF5+owm8cOQmDrV8NNdiTqin8q3qYAHHJRW28glJUCZkTZ\nwIaSR6crBQ8TbYNE0dc+Caa3DOIkz1EOsHWzTx+n0zKfqcbgXi4DJx+C1bjptYPR\nBPZL8DAeWuA8ebudVT44yEp82G96/Ggcf7F33xMxe0yc+Xa6owIDAQABoAAwDQYJ\nKoZIhvcNAQEFBQADggEBAB0kcrFccSmFDmxox0Ne01UIqSsDqHgL+XmHTXJwre6D\nhJSZwbvEtOK0G3+dr4Fs11WuUNt5qcLsx5a8uk4G6AKHMzuhLsJ7XZjgmQXGECpY\nQ4mC3yT3ZoCGpIXbw+iP3lmEEXgaQL0Tx5LFl/okKbKYwIqNiyKWOMj7ZR/wxWg/\nZDGRs55xuoeLDJ/ZRFf9bI+IaCUd1YrfYcHIl3G87Av+r49YVwqRDT0VDV7uLgqn\n29XI1PpVUNCPQGn9p/eX6Qo7vpDaPybRtA2R7XLKjQaF9oXWeCUqy1hvJac9QFO2\n97Ob1alpHPoZ7mWiEuJwjBPii6a9M9G30nUo39lBi1w=\n-----END CERTIFICATE-----", + "readOnly": true, + "type": "string" + }, + "components-schemas-certificateObject": { + "properties": { + "ca": { "$ref": "#/components/schemas/ca" }, + "certificates": { "$ref": "#/components/schemas/schemas-certificates" }, + "expires_on": { "$ref": "#/components/schemas/mtls-management_components-schemas-expires_on" }, + "id": { "$ref": "#/components/schemas/identifier-tZwYoMuc" }, + "issuer": { "$ref": "#/components/schemas/schemas-issuer" }, + "name": { "$ref": "#/components/schemas/schemas-name-F4rYvN2r" }, + "serial_number": { "$ref": "#/components/schemas/schemas-serial_number" }, + "signature": { "$ref": "#/components/schemas/signature" }, + "uploaded_on": { "$ref": "#/components/schemas/mtls-management_components-schemas-uploaded_on" } + } + }, + "components-schemas-certificateObject-Eyk3On6c": { + "properties": { + "ca": { "$ref": "#/components/schemas/ca" }, + "certificates": { "$ref": "#/components/schemas/schemas-certificates" }, + "expires_on": { "$ref": "#/components/schemas/mtls-management_components-schemas-expires_on" }, + "id": { "$ref": "#/components/schemas/mtls-management_components-schemas-identifier" }, + "issuer": { "$ref": "#/components/schemas/schemas-issuer" }, + "name": { "$ref": "#/components/schemas/mtls-management_components-schemas-name" }, + "serial_number": { "$ref": "#/components/schemas/schemas-serial_number" }, + "signature": { "$ref": "#/components/schemas/signature" }, + "uploaded_on": { "$ref": "#/components/schemas/mtls-management_components-schemas-uploaded_on" } + } + }, + "components-schemas-certificate_authority": { + "description": "The Certificate Authority that Total TLS certificates will be issued through.", + "enum": ["google", "lets_encrypt"], + "example": "google", + "type": "string" + }, + "components-schemas-certificate_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "items": { "$ref": "#/components/schemas/zone-authenticated-origin-pull-aLOWlDXy" }, + "type": "array" + } + } + } + ] + }, + "components-schemas-certificate_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/schemas-certificateObject-otmSOZma" } } } + ] + }, + "components-schemas-certificates": { + "properties": { + "associated_hostnames": { "$ref": "#/components/schemas/associated_hostnames" }, + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "expires_on": { "$ref": "#/components/schemas/timestamp" }, + "fingerprint": { "$ref": "#/components/schemas/fingerprint" }, + "id": { "description": "The ID of the application that will use this certificate." }, + "name": { "$ref": "#/components/schemas/certificates_components-schemas-name" }, + "updated_at": { "$ref": "#/components/schemas/timestamp" } + }, + "type": "object" + }, + "components-schemas-collection_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/web3-hostname" }, "type": "array" } } } + ] + }, + "components-schemas-config": { + "description": "The tunnel configuration and ingress rules in JSON format. For syntax and parameters, refer to the [configuration file documentation](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-and-setup/tunnel-guide/local/local-management/configuration-file/#file-structure).", + "type": "object" + }, + "components-schemas-configuration": { + "description": "The configuration object for the current rule.", + "properties": { + "target": { + "description": "The configuration target for this rule. You must set the target to `ua` for User Agent Blocking rules.", + "example": "ua", + "type": "string" + }, + "value": { + "description": "The exact user agent string to match. This value will be compared to the received `User-Agent` HTTP header value.", + "example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4", + "type": "string" + } + }, + "type": "object" + }, + "components-schemas-connection": { + "properties": { + "colo_name": { "$ref": "#/components/schemas/schemas-colo_name" }, + "is_pending_reconnect": { "$ref": "#/components/schemas/is_pending_reconnect" }, + "uuid": { "$ref": "#/components/schemas/connection_id" } + } + }, + "components-schemas-created_at": { + "description": "Shows time of creation.", + "example": "2018-08-28T17:26:26Z", + "format": "date-time", + "type": "string" + }, + "components-schemas-created_on": { + "description": "When the Railgun was created.", + "example": "2014-01-01T05:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "components-schemas-description": { + "description": "A short summary of domains in the category.", + "example": "Sites related to educational content that are not included in other categories like Science, Technology or Educational institutions.", + "type": "string" + }, + "components-schemas-description-EJnoLTyB": { + "description": "An optional description forthe IPsec tunnel.", + "example": "Tunnel for ISP X", + "type": "string" + }, + "components-schemas-description-Po1ZMHYz": { + "description": "An informative summary of the rate limit. This value is sanitized and any tags will be removed.", + "example": "Prevent multiple login failures to mitigate brute force attacks", + "maxLength": 1024, + "type": "string" + }, + "components-schemas-description-UH5FN4sh": { + "description": "Object description.", + "example": "Load Balancer for www.example.com", + "type": "string" + }, + "components-schemas-domain": { + "description": "The domain of the Bookmark application.", + "example": "example.com", + "type": "string" + }, + "components-schemas-email": { + "description": "The email of the user.", + "example": "jdoe@example.com", + "format": "email", + "type": "string" + }, + "components-schemas-empty_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { "properties": { "result": { "type": "object" } }, "type": "object" } + ] + }, + "components-schemas-enabled": { + "description": "If enabled, Total TLS will order a hostname specific TLS certificate for any proxied A, AAAA, or CNAME record in your zone.", + "example": true, + "type": "boolean" + }, + "components-schemas-enabled-tktxdyPy": { + "default": true, + "description": "Whether to enable (the default) this load balancer.", + "example": true, + "type": "boolean" + }, + "components-schemas-exclude": { "items": { "$ref": "#/components/schemas/split_tunnel" }, "type": "array" }, + "components-schemas-expires_on": { + "description": "When the certificate from the authority expires.", + "example": "2100-01-01T05:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "components-schemas-expires_on-KIWqadEQ": { + "description": "When the certificate from the authority expires.", + "example": "2016-01-01T05:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "components-schemas-filters": { + "additionalProperties": { + "description": "Optional filters that allow you to be alerted only on a subset of events for that alert type based on some criteria. This is only available for select alert types. See alert type documentation for more details.", + "items": {}, + "type": "array" + }, + "example": { "slo": ["99.9"] }, + "type": "object" + }, + "components-schemas-hostname": { + "description": "Hostname of the Worker Domain.", + "example": "foo.example.com", + "type": "string" + }, + "components-schemas-id": { + "description": "ID of the namespace.", + "example": "5fd1cafff895419c8bcc647fc64ab8f0", + "type": "string" + }, + "components-schemas-id_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { "id": { "$ref": "#/components/schemas/components-schemas-identifier" } }, + "type": "object" + } + } + } + ] + }, + "components-schemas-id_response-Ujz7iPfP": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { "id": { "$ref": "#/components/schemas/load-balancer_components-schemas-identifier" } }, + "type": "object" + } + } + } + ] + }, + "components-schemas-id_response-XcbFiwuE": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { "id": { "$ref": "#/components/schemas/load-balancer_components-schemas-identifier" } }, + "type": "object" + } + } + } + ] + }, + "components-schemas-id_response-th0exOPu": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { "properties": { "id": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" } }, "type": "object" } + } + } + ] + }, + "components-schemas-identifier": { "example": "23ff594956f20c2a721606e94745a8aa", "readOnly": true }, + "components-schemas-identifier-454QZaBH": { + "description": "Identifier", + "example": "023e105f4ecef8ad9ca31a8372d0c353", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "components-schemas-identifier-vS0Y8rdw": { + "description": "Token identifier tag.", + "example": "ed17574386854bf78a67040be0a770b0", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "components-schemas-ip": { "description": "IPv4 or IPv6 address.", "example": "1.1.1.1", "type": "string" }, + "components-schemas-kind": { + "description": "The type of the membership.", + "enum": ["zone", "account"], + "example": "zone", + "type": "string" + }, + "components-schemas-match": { + "description": "The wirefilter expression to match devices.", + "example": "user.identity == \"test@cloudflare.com\"", + "maxLength": 500, + "type": "string" + }, + "components-schemas-member": { + "properties": { + "email": { "$ref": "#/components/schemas/email-sNyq81Xd" }, + "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" }, + "name": { "$ref": "#/components/schemas/member_components-schemas-name" }, + "roles": { + "description": "Roles assigned to this Member.", + "items": { "$ref": "#/components/schemas/schemas-role" }, + "type": "array" + }, + "status": { + "description": "A member's status in the organization.", + "enum": ["accepted", "invited"], + "example": "accepted" + } + }, + "required": ["id", "name", "email", "status", "roles"], + "type": "object" + }, + "components-schemas-metadata": { + "description": "Arbitrary JSON to be associated with a key/value pair.", + "example": "{\"someMetadataKey\": \"someMetadataValue\"}", + "type": "string" + }, + "components-schemas-mode": { + "default": "on", + "description": "The state of the rules contained in the rule group. When `on`, the rules in the group are configurable/usable.", + "enum": ["on", "off"], + "type": "string" + }, + "components-schemas-modified_on": { + "description": "The timestamp of when the rule was last modified.", + "example": "2014-01-01T05:20:00.12345Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "components-schemas-modified_tunnels_collection_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "modified": { "example": true, "type": "boolean" }, + "modified_interconnects": { + "items": { "$ref": "#/components/schemas/interconnect" }, + "type": "array" + } + } + } + } + } + ] + }, + "components-schemas-monitor": { + "properties": { + "allow_insecure": { "$ref": "#/components/schemas/allow_insecure" }, + "consecutive_down": { "$ref": "#/components/schemas/consecutive_down" }, + "consecutive_up": { "$ref": "#/components/schemas/consecutive_up" }, + "created_on": { "$ref": "#/components/schemas/timestamp" }, + "description": { "$ref": "#/components/schemas/monitor_components-schemas-description" }, + "expected_body": { "$ref": "#/components/schemas/expected_body" }, + "expected_codes": { "$ref": "#/components/schemas/schemas-expected_codes" }, + "follow_redirects": { "$ref": "#/components/schemas/follow_redirects" }, + "header": { "$ref": "#/components/schemas/header" }, + "id": { "$ref": "#/components/schemas/monitor_components-schemas-identifier" }, + "interval": { "$ref": "#/components/schemas/interval-IFpdxmAf" }, + "method": { "$ref": "#/components/schemas/schemas-method" }, + "modified_on": { "$ref": "#/components/schemas/timestamp" }, + "path": { "$ref": "#/components/schemas/path-N56b8ntG" }, + "port": { "$ref": "#/components/schemas/components-schemas-port" }, + "probe_zone": { "$ref": "#/components/schemas/probe_zone" }, + "retries": { "$ref": "#/components/schemas/retries" }, + "timeout": { "$ref": "#/components/schemas/schemas-timeout" }, + "type": { "$ref": "#/components/schemas/monitor_components-schemas-type" } + }, + "type": "object" + }, + "components-schemas-monitor-vfiRsl5D": { + "properties": { + "allow_insecure": { "$ref": "#/components/schemas/allow_insecure" }, + "consecutive_down": { "$ref": "#/components/schemas/consecutive_down" }, + "consecutive_up": { "$ref": "#/components/schemas/consecutive_up" }, + "created_on": { "$ref": "#/components/schemas/timestamp" }, + "description": { "$ref": "#/components/schemas/description-Jd6AMFjR" }, + "expected_body": { "$ref": "#/components/schemas/expected_body" }, + "expected_codes": { "$ref": "#/components/schemas/schemas-expected_codes" }, + "follow_redirects": { "$ref": "#/components/schemas/follow_redirects" }, + "header": { "$ref": "#/components/schemas/header" }, + "id": { "$ref": "#/components/schemas/identifier-FZThz4k7" }, + "interval": { "$ref": "#/components/schemas/interval-hA6swy38" }, + "method": { "$ref": "#/components/schemas/method-guvmKTdR" }, + "modified_on": { "$ref": "#/components/schemas/timestamp" }, + "path": { "$ref": "#/components/schemas/path-I0p9X4oI" }, + "port": { "$ref": "#/components/schemas/schemas-port-uAxZ6zJW" }, + "probe_zone": { "$ref": "#/components/schemas/probe_zone" }, + "retries": { "$ref": "#/components/schemas/retries" }, + "timeout": { "$ref": "#/components/schemas/timeout" }, + "type": { "$ref": "#/components/schemas/type-gTI6cLgq" } + }, + "type": "object" + }, + "components-schemas-name": { + "description": "The name of the Rule.", + "example": "block bad websites", + "type": "string" + }, + "components-schemas-name-0v75iZSQ": { + "description": "The name of the peer.", + "example": "my-peer-1", + "type": "string" + }, + "components-schemas-name-4G3Rlgj8": { + "description": "The name of the Access group.", + "example": "Allow devs", + "type": "string" + }, + "components-schemas-name-4QGVxQIe": { + "description": "The name of the Device Posture Integration.", + "example": "My Workspace One Integration", + "type": "string" + }, + "components-schemas-name-MuyCBGYr": { + "description": "The name of the interconnect. The name cannot share a name with other tunnels.", + "example": "pni_ord", + "type": "string" + }, + "components-schemas-name-h5gI0ndx": { + "description": "The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will not be used.", + "example": "www.example.com", + "type": "string" + }, + "components-schemas-name-l3W5RvJP": { + "description": "Role Name.", + "example": "Organization Admin", + "maxLength": 120, + "readOnly": true, + "type": "string" + }, + "components-schemas-patch": { + "description": "Update enablement of Smart Tiered Cache", + "properties": { + "value": { "$ref": "#/components/schemas/tiered-cache-smart-topology-api_components-schemas-value" } + }, + "required": ["value"], + "type": "object" + }, + "components-schemas-pattern": { + "description": "A pattern that matches an entry", + "properties": { + "regex": { "description": "The regex pattern.", "example": "^4[0-9]{6,14}$", "type": "string" }, + "validation": { + "description": "Validation algorithm for the pattern. This algorithm will get run on potential matches, and if it returns false, the entry will not be matched.", + "enum": ["luhn"], + "example": "luhn", + "type": "string" + } + }, + "required": ["regex"], + "title": "Pattern", + "type": "object" + }, + "components-schemas-paused": { + "description": "When true, indicates that the firewall rule is currently paused.", + "example": false, + "type": "boolean" + }, + "components-schemas-per_page": { + "description": "Number of results per page of results.", + "example": 20, + "type": "number" + }, + "components-schemas-policies": { + "properties": { + "alert_type": { "$ref": "#/components/schemas/alert_type" }, + "created": { "$ref": "#/components/schemas/timestamp" }, + "description": { "$ref": "#/components/schemas/policies_components-schemas-description" }, + "enabled": { "$ref": "#/components/schemas/policies_components-schemas-enabled" }, + "filters": { "$ref": "#/components/schemas/components-schemas-filters" }, + "id": { "$ref": "#/components/schemas/uuid-s0SXln0q" }, + "mechanisms": { "$ref": "#/components/schemas/mechanisms" }, + "modified": { "$ref": "#/components/schemas/timestamp" }, + "name": { "$ref": "#/components/schemas/policies_components-schemas-name-2" } + }, + "type": "object" + }, + "components-schemas-port": { + "default": 0, + "description": "The port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).", + "type": "integer" + }, + "components-schemas-priority": { + "description": "The relative priority of the current URI-based WAF override when multiple overrides match a single URL. A lower number indicates higher priority. Higher priority overrides may overwrite values set by lower priority overrides.", + "example": 1, + "maximum": 1000000000, + "minimum": -1000000000, + "type": "number" + }, + "components-schemas-private_key": { + "description": "The private key for the certificate", + "example": "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDEXDkcICRU3XBv9hiiPnBWIjgTQyowmVFxDr11mONgZB/cMYjE/OvQjvnpwNcOaSK16MOpAjNbELKRx2lZiVJaLRDCccqCxXwP/CrdRChcqGzo7mbNksMlcidrErb0LlEBKLFC2QjRmRKqB+YOs4TD8WsZu2S667A2fZmjRlaqOxFi1h62ee0P+TLU628UC/nl41JifSt5Evt7hMDHakemdwZblNYr2p6T3NQjdhjYXTtP4UmOGJBhJ7i7Kicg3d3CIgdTMbggSeGWqjndr4ldVnD96FN3cVT5uDFsn2CJXTFgdeBWoUnMS4VnUZzPWGf4vSBXC8qV7Ls+w46yT7T1AgMBAAECggEAQZnp/oqCeNPOR6l5S2L+1tfx0gWjZ78hJVteUpZ0iHSK7F6kKeOxyOird7vUXV0kmo+cJq+0hp0Ke4eam640FCpwKfYoSQ4/R3vgujGWJnaihCN5tv5sMet0XeJPuz5qE7ALoKCvwI6aXLHs20aAeZIDTQJ9QbGSGnJVzOWn+JDTidIgZpN57RpXfSAwnJPTQK/PN8i5z108hsaDOdEgGmxYZ7kYqMqzX20KXmth58LDfPixs5JGtS60iiKC/wOcGzkB2/AdTSojR76oEU77cANP/3zO25NG//whUdYlW0t0d7PgXxIeJe+xgYnamDQJx3qonVyt4H77ha0ObRAj9QKBgQDicZr+VTwFMnELP3a+FXGnjehRiuS1i7MXGKxNweCD+dFlML0FplSQS8Ro2n+d8lu8BBXGx0qm6VXu8Rhn7TAUL6q+PCgfarzxfIhacb/TZCqfieIHsMlVBfhV5HCXnk+kis0tuC/PRArcWTwDHJUJXkBhvkUsNswvQzavDPI7KwKBgQDd/WgLkj7A3X5fgIHZH/GbDSBiXwzKb+rF4ZCT2XFgG/OAW7vapfcX/w+v+5lBLyrocmOAS3PGGAhM5T3HLnUCQfnK4qgps1Lqibkc9Tmnsn60LanUjuUMsYv/zSw70tozbzhJ0pioEpWfRxRZBztO2Rr8Ntm7h6Fk701EXGNAXwKBgQCD1xsjy2J3sCerIdcz0u5qXLAPkeuZW+34m4/ucdwTWwc0gEz9lhsULFj9p4G351zLuiEnq+7mAWLcDJlmIO3mQt6JhiLiL9Y0T4pgBmxmWqKKYtAsJB0EmMY+1BNN44mBRqMxZFTJu1cLdhT/xstrOeoIPqytknYNanfTMZlzIwKBgHrLXe5oq0XMP8dcMneEcAUwsaU4pr6kQd3L9EmUkl5zl7J9C+DaxWAEuwzBw/iGutlxzRB+rD/7szu14wJ29EqXbDGKRzMp+se5/yfBjm7xEZ1hVPw7PwBShfqt57X/4Ktq7lwHnmH6RcGhc+P7WBc5iO/S94YAdIp8xOT3pf9JAoGAE0QkqJUY+5Mgr+fBO0VNV72ZoPveGpW+De59uhKAOnu1zljQCUtk59m6+DXfm0tNYKtawa5n8iN71Zh+s62xXSt3pYi1Y5CCCmv8Y4BhwIcPwXKk3zEvLgSHVTpC0bayA9aSO4bbZgVXa5w+Z0w/vvfp9DWo1IS3EnQRrz6WMYA=\n-----END PRIVATE KEY-----", + "type": "string" + }, + "components-schemas-ref": { + "description": "The reference of the rule (the rule ID by default).", + "example": "my_ref", + "type": "string" + }, + "components-schemas-response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/ip-list" }, "type": "array" } } } + ] + }, + "components-schemas-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/rules" }, "type": "array" } } } + ] + }, + "components-schemas-response_collection-6gfWBAmq": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "items": { "$ref": "#/components/schemas/device-managed-networks-FH3V2phW" }, + "type": "array" + } + } + } + ] + }, + "components-schemas-response_collection-7Rg5C3fo": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "type": "object" }, "type": "array" } } } + ] + }, + "components-schemas-response_collection-Np6QDZ3m": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/acl" }, "type": "array" } } } + ] + }, + "components-schemas-response_collection-Qou49Scv": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { "result": { "items": { "$ref": "#/components/schemas/service-tokens" }, "type": "array" } } + } + ] + }, + "components-schemas-response_collection-Qwy7OnW5": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/analytics" }, "type": "array" } } } + ] + }, + "components-schemas-response_collection-R3Nbn4ml": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/address-maps" }, "type": "array" } } } + ] + }, + "components-schemas-result": { + "allOf": [ + { "$ref": "#/components/schemas/result-iSgQlUWZ" }, + { + "properties": { + "data": { + "example": [ + { + "metrics": [ + [2, 4], + [16, 32] + ] + } + ] + }, + "max": { "example": { "storedBytes": 32, "storedKeys": 4 } }, + "min": { "example": { "storedBytes": 16, "storedKeys": 2 } }, + "query": { "$ref": "#/components/schemas/query-ju6G02HL" }, + "totals": { "example": { "storedBytes": 48, "storedKeys": 6 } } + } + } + ] + }, + "components-schemas-rule": { + "oneOf": [ + { "$ref": "#/components/schemas/anomaly_rule" }, + { "$ref": "#/components/schemas/traditional_deny_rule" }, + { "$ref": "#/components/schemas/traditional_allow_rule" } + ], + "type": "object" + }, + "components-schemas-rules": { + "description": "BETA Field Not General Access: A list of rules for this load balancer to execute.", + "items": { + "additionalProperties": false, + "description": "A rule object containing conditions and overrides for this load balancer to evaluate.", + "properties": { + "condition": { + "description": "The condition expressions to evaluate. If the condition evaluates to true, the overrides or fixed_response in this rule will be applied. An empty condition is always true. For more details on condition expressions, please see https://developers.cloudflare.com/load-balancing/understand-basics/load-balancing-rules/expressions.", + "example": "http.request.uri.path contains \"/testing\"", + "type": "string" + }, + "disabled": { + "default": false, + "description": "Disable this specific rule. It will no longer be evaluated by this load balancer.", + "type": "boolean" + }, + "fixed_response": { + "description": "A collection of fields used to directly respond to the eyeball instead of routing to a pool. If a fixed_response is supplied the rule will be marked as terminates.", + "properties": { + "content_type": { + "description": "The http 'Content-Type' header to include in the response.", + "example": "application/json", + "maxLength": 32, + "type": "string" + }, + "location": { + "description": "The http 'Location' header to include in the response.", + "example": "www.example.com", + "maxLength": 2048, + "type": "string" + }, + "message_body": { + "description": "Text to include as the http body.", + "example": "Testing Hello", + "maxLength": 1024, + "type": "string" + }, + "status_code": { "description": "The http status code to respond with.", "type": "integer" } + }, + "type": "object" + }, + "name": { + "description": "Name of this rule. Only used for human readability.", + "example": "route the path /testing to testing datacenter.", + "maxLength": 200, + "type": "string" + }, + "overrides": { + "description": "A collection of overrides to apply to the load balancer when this rule's condition is true. All fields are optional.", + "properties": { + "adaptive_routing": { "$ref": "#/components/schemas/adaptive_routing" }, + "country_pools": { "$ref": "#/components/schemas/country_pools" }, + "default_pools": { "$ref": "#/components/schemas/default_pools" }, + "fallback_pool": { "$ref": "#/components/schemas/fallback_pool" }, + "location_strategy": { "$ref": "#/components/schemas/location_strategy" }, + "pop_pools": { "$ref": "#/components/schemas/pop_pools" }, + "random_steering": { "$ref": "#/components/schemas/random_steering" }, + "region_pools": { "$ref": "#/components/schemas/region_pools" }, + "session_affinity": { "$ref": "#/components/schemas/session_affinity" }, + "session_affinity_attributes": { "$ref": "#/components/schemas/session_affinity_attributes" }, + "session_affinity_ttl": { "$ref": "#/components/schemas/session_affinity_ttl" }, + "steering_policy": { "$ref": "#/components/schemas/steering_policy" }, + "ttl": { "$ref": "#/components/schemas/ttl-vFKh1wOV" } + }, + "type": "object" + }, + "priority": { + "default": 0, + "description": "The order in which rules should be executed in relation to each other. Lower values are executed first. Values do not need to be sequential. If no value is provided for any rule the array order of the rules field will be used to assign a priority.", + "type": "integer" + }, + "terminates": { + "default": false, + "description": "If this rule's condition is true, this causes rule evaluation to stop after processing this rule.", + "type": "boolean" + } + }, + "type": "object" + }, + "type": "array" + }, + "components-schemas-ruleset": { + "properties": { + "description": { "example": "" }, + "id": { "example": "2f2feab2026849078ba485f918791bdc" }, + "kind": { "example": "zone" }, + "name": { "example": "default" }, + "phase": { "example": "http_request_dynamic_redirect" }, + "rules": { + "description": "The rules in the ruleset.", + "items": { "$ref": "#/components/schemas/dynamic-redirect-rules_components-schemas-rule" }, + "type": "array" + } + } + }, + "components-schemas-serial_number": { + "description": "The serial number on the created Client Certificate.", + "example": "3bb94ff144ac567b9f75ad664b6c55f8d5e48182", + "readOnly": true, + "type": "string" + }, + "components-schemas-serial_number-AUVcZzty": { + "description": "The device serial number.", + "example": "EXAMPLEHMD6R", + "type": "string" + }, + "components-schemas-signature": { + "description": "The type of hash used for the Client Certificate..", + "example": "SHA256WithRSA", + "readOnly": true, + "type": "string" + }, + "components-schemas-single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/rules" } } } + ] + }, + "components-schemas-single_response-1u3sjtw5": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/monitor" } } } + ] + }, + "components-schemas-single_response-AhobaCUU": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "description": "A list of countries and subdivisions mapped to a region.", + "example": { + "iso_standard": "Country and subdivision codes follow ISO 3166-1 alpha-2 and ISO 3166-2", + "regions": [ + { + "countries": [ + { + "country_code_a2": "CA", + "country_name": "Canada", + "country_subdivisions": [ + { "subdivision_code_a2": "AB", "subdivision_name": "Alberta" }, + { "subdivision_code_a2": "BC", "subdivision_name": "British Columbia" } + ] + }, + { "country_code_a2": "HT", "country_name": "Haiti" }, + { "country_code_a2": "MX", "country_name": "Mexico" }, + { + "country_code_a2": "US", + "country_name": "United States", + "country_subdivisions": [ + { "subdivision_code_a2": "AZ", "subdivision_name": "Arizona" }, + { "subdivision_code_a2": "CA", "subdivision_name": "California" }, + { "subdivision_code_a2": "CO", "subdivision_name": "Colorado" }, + { "subdivision_code_a2": "HI", "subdivision_name": "Hawaii" }, + { "subdivision_code_a2": "MN", "subdivision_name": "Minnesota" }, + { "subdivision_code_a2": "MO", "subdivision_name": "Missouri" }, + { "subdivision_code_a2": "NV", "subdivision_name": "Nevada" }, + { "subdivision_code_a2": "OR", "subdivision_name": "Oregon" }, + { "subdivision_code_a2": "TX", "subdivision_name": "Texas" }, + { "subdivision_code_a2": "UT", "subdivision_name": "Utah" }, + { "subdivision_code_a2": "WA", "subdivision_name": "Washington" } + ] + } + ], + "region_code": "WNAM" + } + ] + }, + "type": "object" + } + } + } + ] + }, + "components-schemas-single_response-UrWzkhyF": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/acl" } } } + ] + }, + "components-schemas-single_response-ar7Y7q7I": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/device-managed-networks-FH3V2phW" } } } + ] + }, + "components-schemas-single_response-gP2O4PI2": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/groups" } } } + ] + }, + "components-schemas-single_response-plUIZwft": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/address-maps" } } } + ] + }, + "components-schemas-state": { + "description": "The custom page state.", + "enum": ["default", "customized"], + "example": "default" + }, + "components-schemas-status": { + "description": "Status of the hostname's activation.", + "enum": [ + "active", + "pending", + "active_redeploying", + "moved", + "pending_deletion", + "deleted", + "pending_blocked", + "pending_migration", + "pending_provisioned", + "test_pending", + "test_active", + "test_active_apex", + "test_blocked", + "test_failed", + "provisioned", + "blocked" + ], + "example": "pending" + }, + "components-schemas-status-bVKpIIc1": { + "description": "Whether the user is a member of the organization or has an inivitation pending.", + "enum": ["member", "invited"], + "example": "member", + "type": "string" + }, + "components-schemas-tunnel_modified_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "modified": { "example": true, "type": "boolean" }, + "modified_interconnect": { "type": "object" } + } + } + } + } + ] + }, + "components-schemas-tunnel_single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "properties": { "interconnect": { "type": "object" } } } } } + ] + }, + "components-schemas-tunnel_update_request": { + "properties": { + "description": { "$ref": "#/components/schemas/interconnect_components-schemas-description" }, + "gre": { "$ref": "#/components/schemas/gre" }, + "health_check": { "$ref": "#/components/schemas/schemas-health_check" }, + "interface_address": { "$ref": "#/components/schemas/interface_address" }, + "mtu": { "$ref": "#/components/schemas/schemas-mtu" } + }, + "type": "object" + }, + "components-schemas-tunnels_collection_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "interconnects": { "items": { "$ref": "#/components/schemas/interconnect" }, "type": "array" } + } + } + } + } + ] + }, + "components-schemas-type": { + "default": "legacy_custom", + "description": "The type 'legacy_custom' enables support for legacy clients which do not include SNI in the TLS handshake.", + "enum": ["legacy_custom", "sni_custom"], + "example": "sni_custom", + "type": "string" + }, + "components-schemas-type-KlrF1JPW": { + "description": "The type of Device Managed Network.", + "enum": ["tls"], + "example": "tls", + "type": "string" + }, + "components-schemas-until": { + "description": "End date and time of requesting data period in the ISO8601 format.", + "example": "2016-11-11T13:00:00Z", + "format": "date-time", + "type": "string" + }, + "components-schemas-updated_at": { + "description": "Last updated.", + "example": "2018-08-28T17:26:26Z", + "format": "date-time", + "type": "string" + }, + "components-schemas-uploaded_on": { + "description": "The time when the certificate was uploaded.", + "example": "2019-10-28T18:11:23.37411Z", + "format": "date-time", + "type": "string" + }, + "components-schemas-url": { + "description": "URL(s) to filter submissions results by", + "example": "https://www.cloudflare.com", + "format": "uri", + "type": "string" + }, + "components-schemas-uuid": { + "description": "The policy ID.", + "example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", + "maxLength": 36, + "type": "string" + }, + "components-schemas-uuid-nWj9wBDf": { + "description": "UUID", + "example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", + "maxLength": 36, + "readOnly": true, + "type": "string" + }, + "components-schemas-validation_method": { + "properties": { "validation_method": { "$ref": "#/components/schemas/validation_method_definition" } }, + "required": ["validation_method"], + "type": "object" + }, + "components-schemas-validity_days": { + "description": "The number of days the Client Certificate will be valid after the issued_on date", + "example": 3650, + "type": "integer" + }, + "components-schemas-value": { + "description": "Enables Tiered Caching.", + "enum": ["on", "off"], + "example": "on", + "type": "string" + }, + "components-schemas-version": { + "description": "The version of the Railgun receiver.", + "example": "2.1", + "readOnly": true, + "type": "string" + }, + "components-schemas-zone": { + "properties": { + "activated_on": { + "description": "The last time proof of ownership was detected and the zone was made\nactive", + "example": "2014-01-02T00:01:00.12345Z", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "created_on": { + "description": "When the zone was created", + "example": "2014-01-01T05:20:00.12345Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "development_mode": { + "description": "The interval (in seconds) from when development mode expires\n(positive integer) or last expired (negative integer) for the\ndomain. If development mode has never been enabled, this value is 0.", + "example": 7200, + "readOnly": true, + "type": "number" + }, + "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" }, + "modified_on": { + "description": "When the zone was last modified", + "example": "2014-01-01T05:20:00.12345Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The domain name", + "example": "example.com", + "maxLength": 253, + "pattern": "^([a-zA-Z0-9][\\-a-zA-Z0-9]*\\.)+[\\-a-zA-Z0-9]{2,20}$", + "readOnly": true, + "type": "string" + }, + "original_dnshost": { + "description": "DNS host at the time of switching to Cloudflare", + "example": "NameCheap", + "maxLength": 50, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "original_name_servers": { + "description": "Original name servers before moving to Cloudflare\nNotes: Is this only available for full zones?", + "example": ["ns1.originaldnshost.com", "ns2.originaldnshost.com"], + "items": { "format": "hostname", "type": "string" }, + "nullable": true, + "readOnly": true, + "type": "array" + }, + "original_registrar": { + "description": "Registrar for the domain at the time of switching to Cloudflare", + "example": "GoDaddy", + "nullable": true, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "id", + "name", + "development_mode", + "owner", + "account", + "meta", + "original_name_servers", + "original_registrar", + "original_dnshost", + "created_on", + "modified_on", + "activated_on" + ], + "type": "object" + }, + "condition": { "properties": { "request.ip": { "$ref": "#/components/schemas/request.ip" } }, "type": "object" }, + "config": { "items": { "$ref": "#/components/schemas/hostname_certid_input-CNETqmIk" }, "type": "array" }, + "config-rules_components-schemas-action_parameters": { + "description": "The parameters configuring the action.", + "oneOf": [{ "$ref": "#/components/schemas/action_parameters_set_config" }], + "type": "object" + }, + "config-rules_components-schemas-rule": { + "properties": { + "action": { "example": "set_config" }, + "action_parameters": { "$ref": "#/components/schemas/config-rules_components-schemas-action_parameters" }, + "description": { "example": "enable Email Obfuscation" }, + "expression": { "example": "http.cookie contains \"something\"" }, + "id": { "example": "3a03d665bac047339bb530ecb439a90d" }, + "version": { "example": "1" } + } + }, + "config-rules_components-schemas-ruleset": { + "properties": { + "description": { "example": "" }, + "id": { "example": "2f2feab2026849078ba485f918791bdc" }, + "kind": { "example": "zone" }, + "name": { "example": "default" }, + "phase": { "example": "http_config_settings" }, + "rules": { + "description": "The rules in the ruleset.", + "items": { "$ref": "#/components/schemas/config-rules_components-schemas-rule" }, + "type": "array" + } + } + }, + "config_components-schemas-account_identifier": { "example": "6f91088a406011ed95aed352566e8d4c" }, + "config_request": { + "description": "The configuration object containing third party integration information.", + "example": { + "api_url": "https://as123.awmdm.com/API", + "auth_url": "https://na.uemauth.vmwservices.com/connect/token", + "client_id": "example client id", + "client_secret": "example client secret" + }, + "oneOf": [ + { "$ref": "#/components/schemas/workspace_one_config_request" }, + { "$ref": "#/components/schemas/crowdstrike_config_request" }, + { "$ref": "#/components/schemas/uptycs_config_request" }, + { "$ref": "#/components/schemas/intune_config_request" } + ], + "type": "object" + }, + "config_request-dR6XwB2B": { + "description": "The configuration object containing third party integration information.", + "example": { + "api_url": "https://as123.awmdm.com/API", + "auth_url": "https://na.uemauth.vmwservices.com/connect/token", + "client_id": "example client id", + "client_secret": "example client secret" + }, + "oneOf": [ + { "$ref": "#/components/schemas/workspace_one_config_request" }, + { "$ref": "#/components/schemas/crowdstrike_config_request" }, + { "$ref": "#/components/schemas/uptycs_config_request" }, + { "$ref": "#/components/schemas/intune_config_request" }, + { "$ref": "#/components/schemas/kolide_config_request" } + ], + "type": "object" + }, + "config_response": { + "description": "The configuration object containing third party integration information.", + "example": { + "api_url": "https://as123.awmdm.com/API", + "auth_url": "https://na.uemauth.vmwservices.com/connect/token", + "client_id": "example client id" + }, + "oneOf": [{ "$ref": "#/components/schemas/workspace_one_config_response" }], + "type": "object" + }, + "config_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } }, "type": "object" } + ] + }, + "config_src": { + "default": "local", + "description": "Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel on the Zero Trust dashboard or using the [Cloudflare Tunnel configuration](https://api.cloudflare.com/#cloudflare-tunnel-configuration-properties) endpoint.", + "enum": ["local", "cloudflare"], + "example": "cloudflare", + "type": "string" + }, + "config_version": { + "description": "The version of the remote tunnel configuration. Used internally to sync cloudflared with the Zero Trust dashboard.", + "type": "integer" + }, + "configuration": { + "properties": { "auth_id_characteristics": { "$ref": "#/components/schemas/characteristics" } }, + "type": "object" + }, + "configurations": { + "anyOf": [ + { "$ref": "#/components/schemas/schemas-ip_configuration" }, + { "$ref": "#/components/schemas/schemas-cidr_configuration" } + ], + "description": "A list of IP addresses or CIDR ranges that will be allowed to access the URLs specified in the Zone Lockdown rule. You can include any number of `ip` or `ip_range` configurations.", + "items": { + "anyOf": [ + { "$ref": "#/components/schemas/schemas-ip_configuration" }, + { "$ref": "#/components/schemas/schemas-cidr_configuration" } + ] + }, + "type": "array" + }, + "connected": { + "default": false, + "description": "A flag indicating whether the given zone is connected to the Railgun.", + "example": true, + "type": "boolean" + }, + "connection": { + "properties": { + "added_at": { "example": "2021-08-18T10:51:10.09615Z" }, + "domain_reported_malicious": { "example": false }, + "first_page_url": { "example": "blog.cloudflare.com/page" }, + "first_seen_at": { "example": "2021-08-18T10:51:08Z" }, + "host": { "example": "blog.cloudflare.com" }, + "id": { "example": "c9ef84a6bf5e47138c75d95e2f933e8f" }, + "last_seen_at": { "example": "2021-09-02T09:57:54Z" }, + "page_urls": { "example": ["blog.cloudflare.com/page1", "blog.cloudflare.com/page2"] }, + "url": { "example": "https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.0/js/bootstrap.min.js" }, + "url_contains_cdn_cgi_path": { "example": false } + } + }, + "connection-CprJdVPV": { "description": "The IdP used to authenticate.", "example": "saml", "type": "string" }, + "connection-Xm0br0wV": { + "properties": { + "created_on": { "$ref": "#/components/schemas/connection_components-schemas-created_on" }, + "enabled": { "$ref": "#/components/schemas/connection_components-schemas-enabled" }, + "id": { "$ref": "#/components/schemas/connection_components-schemas-identifier" }, + "modified_on": { "$ref": "#/components/schemas/connection_components-schemas-modified_on" }, + "zone": { "$ref": "#/components/schemas/connection_components-schemas-zone" } + }, + "required": ["id", "zone", "enabled"], + "type": "object" + }, + "connection_collection_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/connection-Xm0br0wV" }, "type": "array" } + } + } + ] + }, + "connection_components-schemas-created_on": { + "description": "When the connection was created.", + "example": "2017-06-14T00:00:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "connection_components-schemas-enabled": { + "default": false, + "description": "A value indicating whether the connection is enabled or not.", + "example": true, + "type": "boolean" + }, + "connection_components-schemas-identifier": { + "description": "Connection identifier tag.", + "example": "c4a7362d577a6c3019a474fd6f485821", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "connection_components-schemas-modified_on": { + "description": "When the connection was last modified.", + "example": "2017-06-14T05:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "connection_components-schemas-zone": { + "properties": { + "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" }, + "name": { "$ref": "#/components/schemas/zone-properties-name" } + }, + "type": "object" + }, + "connection_id": { + "description": "UUID of the Cloudflare Tunnel connection.", + "example": "1bedc50d-42b3-473c-b108-ff3d10c0d925", + "maxLength": 36, + "readOnly": true, + "type": "string" + }, + "connection_single_id_response": { + "allOf": [ + { "$ref": "#/components/schemas/connection_single_response" }, + { + "properties": { + "result": { + "properties": { "id": { "$ref": "#/components/schemas/connection_components-schemas-identifier" } } + } + } + } + ] + }, + "connection_single_request": { + "properties": { + "enabled": { "$ref": "#/components/schemas/connection_components-schemas-enabled" }, + "zone": { "properties": { "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" } } } + }, + "required": ["zone"], + "type": "object" + }, + "connection_single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } } } + ] + }, + "connections": { + "description": "The Cloudflare Tunnel connections between your origin and Cloudflare's edge.", + "items": { "$ref": "#/components/schemas/cloudflare-tunnel_components-schemas-connection" }, + "type": "array" + }, + "conns_active_at": { + "description": "Timestamp of when the tunnel established at least one connection to Cloudflare's edge. If `null`, the tunnel is inactive.", + "example": "2009-11-10T23:00:00Z", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "conns_inactive_at": { + "description": "Timestamp of when the tunnel became inactive (no connections to Cloudflare's edge). If `null`, the tunnel is active.", + "example": "2009-11-10T23:00:00Z", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "consecutive_down": { + "default": 0, + "description": "To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times.", + "type": "integer" + }, + "consecutive_fails": { + "default": 1, + "description": "The number of consecutive fails required from a health check before changing the health to unhealthy.", + "type": "integer" + }, + "consecutive_successes": { + "default": 1, + "description": "The number of consecutive successes required from a health check before changing the health to healthy.", + "type": "integer" + }, + "consecutive_up": { + "default": 0, + "description": "To be marked healthy the monitored origin must pass this healthcheck N consecutive times.", + "type": "integer" + }, + "consumer": { + "properties": { + "created_on": { "readOnly": true }, + "environment": { "readOnly": true }, + "queue_name": { "readOnly": true }, + "service": { "readOnly": true }, + "settings": { + "properties": { + "batch_size": { "$ref": "#/components/schemas/batch_size" }, + "max_retries": { "$ref": "#/components/schemas/max_retries" }, + "max_wait_time_ms": { "$ref": "#/components/schemas/max_wait_time_ms" } + }, + "type": "object" + } + }, + "type": "object" + }, + "consumer_created": { + "properties": { + "created_on": { "readOnly": true }, + "dead_letter_queue": { "$ref": "#/components/schemas/dlq_name" }, + "environment": { "readOnly": true }, + "queue_name": { "readOnly": true }, + "script_name": { "readOnly": true }, + "settings": { + "properties": { + "batch_size": { "$ref": "#/components/schemas/batch_size" }, + "max_retries": { "$ref": "#/components/schemas/max_retries" }, + "max_wait_time_ms": { "$ref": "#/components/schemas/max_wait_time_ms" } + }, + "type": "object" + } + }, + "type": "object" + }, + "consumer_name": { "example": "example-consumer", "type": "string" }, + "consumer_updated": { + "properties": { + "created_on": { "readOnly": true }, + "dead_letter_queue": { "example": "updated-example-dlq" }, + "environment": { "readOnly": true }, + "queue_name": { "readOnly": true }, + "script_name": { "readOnly": true }, + "settings": { + "properties": { + "batch_size": { "example": 100, "type": "number" }, + "max_retries": { "$ref": "#/components/schemas/max_retries" }, + "max_wait_time_ms": { "$ref": "#/components/schemas/max_wait_time_ms" } + }, + "type": "object" + } + }, + "type": "object" + }, + "contact_identifier": { + "description": "Contact Identifier.", + "example": "ea95132c15732412d22c1476fa83f27a", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "contact_properties": { + "properties": { + "address": { "$ref": "#/components/schemas/schemas-address" }, + "address2": { "$ref": "#/components/schemas/address2" }, + "city": { "$ref": "#/components/schemas/city" }, + "country": { "$ref": "#/components/schemas/country-DyJUDEcJ" }, + "email": { "$ref": "#/components/schemas/email-sNyq81Xd" }, + "fax": { "$ref": "#/components/schemas/fax" }, + "first_name": { "$ref": "#/components/schemas/first_name" }, + "id": { "$ref": "#/components/schemas/contact_identifier" }, + "last_name": { "$ref": "#/components/schemas/last_name" }, + "organization": { "$ref": "#/components/schemas/schemas-organization" }, + "phone": { "$ref": "#/components/schemas/telephone" }, + "state": { "$ref": "#/components/schemas/contacts_components-schemas-state" }, + "zip": { "$ref": "#/components/schemas/zipcode" } + }, + "required": ["first_name", "last_name", "address", "city", "state", "zip", "country", "phone", "organization"], + "type": "object" + }, + "contacts": { "allOf": [{ "$ref": "#/components/schemas/contact_properties" }], "type": "object" }, + "contacts_components-schemas-state": { "description": "State.", "example": "TX", "type": "string" }, + "content_categories": { + "description": "Current content categories.", + "example": [{ "id": 155, "name": "Technology", "super_category_id": 26 }] + }, + "content_list_action": { + "description": "Behavior of the content list.", + "enum": ["block"], + "example": "block", + "type": "string" + }, + "content_list_details": { + "properties": { "action": { "$ref": "#/components/schemas/content_list_action" } }, + "type": "object" + }, + "content_list_details_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/content_list_details" } } } + ] + }, + "content_list_entries": { + "description": "Content list entries.", + "items": { "$ref": "#/components/schemas/content_list_entry" }, + "type": "array" + }, + "content_list_entry": { + "description": "Content list entry to be blocked.", + "properties": { + "content": { "$ref": "#/components/schemas/content_list_entry_content" }, + "created_on": { "$ref": "#/components/schemas/timestamp" }, + "description": { "$ref": "#/components/schemas/content_list_entry_description" }, + "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" }, + "modified_on": { "$ref": "#/components/schemas/timestamp" }, + "type": { "$ref": "#/components/schemas/content_list_entry_type" } + }, + "type": "object" + }, + "content_list_entry_collection_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "properties": { "entries": { "$ref": "#/components/schemas/content_list_entries" } }, + "type": "object" + } + } + } + ] + }, + "content_list_entry_content": { + "description": "CID or content path of content to block.", + "example": "QmPZ9gcCEpqKTo6aq61g2nXGUhM4iCL3ewB6LDXZCtioEB", + "maxLength": 500, + "type": "string" + }, + "content_list_entry_create_request": { + "properties": { + "content": { "$ref": "#/components/schemas/content_list_entry_content" }, + "description": { "$ref": "#/components/schemas/content_list_entry_description" }, + "type": { "$ref": "#/components/schemas/content_list_entry_type" } + }, + "required": ["type", "content"], + "type": "object" + }, + "content_list_entry_description": { + "description": "An optional description of the content list entry.", + "example": "this is my content list entry", + "maxLength": 500, + "type": "string" + }, + "content_list_entry_single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/content_list_entry" } } } + ] + }, + "content_list_entry_type": { + "description": "Type of content list entry to block.", + "enum": ["cid", "content_path"], + "example": "cid", + "type": "string" + }, + "content_list_update_request": { + "properties": { + "action": { "$ref": "#/components/schemas/content_list_action" }, + "entries": { "$ref": "#/components/schemas/content_list_entries" } + }, + "required": ["action", "entries"], + "type": "object" + }, + "content_type": { + "description": "The content type of the body. Must be one of the following: `text/plain`, `text/xml`, or `application/json`.", + "example": "text/xml", + "maxLength": 50, + "type": "string" + }, + "cookie_attributes": { + "description": "Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user's status in the waiting room, such as queue position.", + "properties": { + "samesite": { + "default": "auto", + "description": "Configures the SameSite attribute on the waiting room cookie. Value `auto` will be translated to `lax` or `none` depending if **Always Use HTTPS** is enabled. Note that when using value `none`, the secure attribute cannot be set to `never`.", + "enum": ["auto", "lax", "none", "strict"], + "example": "auto", + "type": "string" + }, + "secure": { + "default": "auto", + "description": "Configures the Secure attribute on the waiting room cookie. Value `always` indicates that the Secure attribute will be set in the Set-Cookie header, `never` indicates that the Secure attribute will not be set, and `auto` will set the Secure attribute depending if **Always Use HTTPS** is enabled.", + "enum": ["auto", "always", "never"], + "example": "auto", + "type": "string" + } + }, + "type": "object" + }, + "cors_headers": { + "properties": { + "allow_all_headers": { "$ref": "#/components/schemas/allow_all_headers" }, + "allow_all_methods": { "$ref": "#/components/schemas/allow_all_methods" }, + "allow_all_origins": { "$ref": "#/components/schemas/allow_all_origins" }, + "allow_credentials": { "$ref": "#/components/schemas/allow_credentials" }, + "allowed_headers": { "$ref": "#/components/schemas/allowed_headers" }, + "allowed_methods": { "$ref": "#/components/schemas/allowed_methods" }, + "allowed_origins": { "$ref": "#/components/schemas/allowed_origins" }, + "max_age": { "$ref": "#/components/schemas/max_age" } + }, + "type": "object" + }, + "count": { "description": "The number of items in the List.", "example": 20, "readOnly": true, "type": "number" }, + "count-IxGc2iY9": { + "description": "Total results returned based on your search parameters.", + "example": 1, + "type": "number" + }, + "country": { "description": "Country, provided by the CSR", "example": "US", "readOnly": true, "type": "string" }, + "country-DyJUDEcJ": { + "description": "The country in which the user lives.", + "example": "US", + "maxLength": 30, + "nullable": true, + "type": "string" + }, + "country_configuration": { + "properties": { + "target": { + "description": "The configuration target. You must set the target to `country` when specifying a country code in the rule.", + "enum": ["country"], + "example": "country" + }, + "value": { + "description": "The two-letter ISO-3166-1 alpha-2 code to match. For more information, refer to [IP Access rules: Parameters](https://developers.cloudflare.com/waf/tools/ip-access-rules/parameters/#country).", + "example": "US", + "type": "string" + } + }, + "title": "A country configuration." + }, + "country_pools": { + "description": "A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding region_pool mapping if it exists else to default_pools.", + "example": { + "GB": ["abd90f38ced07c2e2f4df50b1f61d4194"], + "US": ["de90f38ced07c2e2f4df50b1f61d4194", "00920f38ce07c2e2f4df50b1f61d4194"] + }, + "type": "object" + }, + "create": { + "properties": { + "email": { "$ref": "#/components/schemas/email-sNyq81Xd" }, + "roles": { + "description": "Array of roles associated with this member.", + "items": { "$ref": "#/components/schemas/role_components-schemas-identifier" }, + "type": "array" + }, + "status": { "default": "pending", "enum": ["accepted", "pending"] } + }, + "required": ["email", "roles"], + "type": "object" + }, + "create_custom_profile_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { "result": { "items": { "$ref": "#/components/schemas/custom_profile" }, "type": "array" } } + } + ] + }, + "create_custom_profiles": { + "properties": { + "profiles": { + "items": { "$ref": "#/components/schemas/new_custom_profile" }, + "required": ["name", "entries"], + "type": "array" + } + }, + "required": ["profiles"] + }, + "create_destination_address_properties": { + "properties": { "email": { "$ref": "#/components/schemas/email-xwlVNguu" } }, + "required": ["email"], + "type": "object" + }, + "create_input_request": { + "properties": { + "defaultCreator": { "$ref": "#/components/schemas/live_input_default_creator" }, + "meta": { "$ref": "#/components/schemas/live_input_metadata" }, + "recording": { "$ref": "#/components/schemas/live_input_recording_settings" } + } + }, + "create_output_request": { + "properties": { + "enabled": { "$ref": "#/components/schemas/output_enabled" }, + "streamKey": { "$ref": "#/components/schemas/output_streamKey" }, + "url": { "$ref": "#/components/schemas/output_url" } + }, + "required": ["url", "streamKey"] + }, + "create_payload": { + "properties": { + "condition": { "$ref": "#/components/schemas/condition" }, + "expires_on": { "$ref": "#/components/schemas/expires_on-dkbMDCaD" }, + "name": { "$ref": "#/components/schemas/name-pG4STmz5" }, + "not_before": { "$ref": "#/components/schemas/not_before" }, + "policies": { "$ref": "#/components/schemas/policies-iecjppBc" } + }, + "required": ["name", "policies"], + "type": "object" + }, + "create_rename_namespace_body": { + "properties": { "title": { "$ref": "#/components/schemas/namespace_title" } }, + "required": ["title"], + "type": "object" + }, + "create_request": { + "properties": { + "description": { "$ref": "#/components/schemas/web3-hostname_components-schemas-description" }, + "dnslink": { "$ref": "#/components/schemas/dnslink" }, + "name": { "$ref": "#/components/schemas/web3-hostname_components-schemas-name" }, + "target": { "$ref": "#/components/schemas/schemas-target" } + }, + "required": ["name", "target"], + "type": "object" + }, + "create_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "client_id": { "$ref": "#/components/schemas/client_id" }, + "client_secret": { "$ref": "#/components/schemas/client_secret" }, + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "id": { "description": "The ID of the service token." }, + "name": { "$ref": "#/components/schemas/service-tokens_components-schemas-name" }, + "updated_at": { "$ref": "#/components/schemas/timestamp" } + } + } + } + } + ] + }, + "create_rule": { + "properties": { + "action": { "$ref": "#/components/schemas/rule_action" }, + "description": { "$ref": "#/components/schemas/rule_description" }, + "enabled": { "$ref": "#/components/schemas/rule_enabled" }, + "expression": { "$ref": "#/components/schemas/rule_expression" } + }, + "required": ["action", "expression"] + }, + "create_rule_properties": { + "properties": { + "actions": { "$ref": "#/components/schemas/rule_actions" }, + "enabled": { "$ref": "#/components/schemas/rule_enabled-VMnvyEOL" }, + "matchers": { "$ref": "#/components/schemas/rule_matchers" }, + "name": { "$ref": "#/components/schemas/rule_name" }, + "priority": { "$ref": "#/components/schemas/rule_priority" } + }, + "required": ["actions", "matchers"], + "type": "object" + }, + "create_ruleset": { + "description": "A ruleset object.", + "properties": { + "description": { "$ref": "#/components/schemas/rulesets_components-schemas-description" }, + "kind": { "$ref": "#/components/schemas/schemas-kind" }, + "name": { "$ref": "#/components/schemas/rulesets_components-schemas-name" }, + "phase": { "$ref": "#/components/schemas/phase" }, + "rules": { "$ref": "#/components/schemas/create_update_rules" } + }, + "required": ["name", "kind", "phase", "rules"], + "type": "object" + }, + "create_update_rule": { + "description": "A rule object.", + "properties": { + "action": { "$ref": "#/components/schemas/rules_components-schemas-action" }, + "action_parameters": { "$ref": "#/components/schemas/action_parameters" }, + "description": { "$ref": "#/components/schemas/rules_components-schemas-description" }, + "enabled": { "$ref": "#/components/schemas/rules_components-schemas-enabled" }, + "expression": { "$ref": "#/components/schemas/schemas-expression" }, + "logging": { "$ref": "#/components/schemas/logging" }, + "ref": { "$ref": "#/components/schemas/components-schemas-ref" } + }, + "required": ["expression", "action"], + "type": "object" + }, + "create_update_rules": { + "description": "The list of rules in the ruleset.", + "items": { + "anyOf": [ + { "$ref": "#/components/schemas/create_update_rule" }, + { "description": "The unique ID of a rule." } + ] + }, + "type": "array" + }, + "created": { + "description": "When the Application was created.", + "example": "2014-01-02T02:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "created-GBc463rN": { + "description": "The date and time the media item was created.", + "example": "2014-01-02T02:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "created-UVGJEhhU": { + "description": "The date and time the destination address has been created.", + "example": "2014-01-02T02:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "created-lduEKfk7": { + "description": "When the device was created.", + "example": "2017-06-14T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "created-on": { + "example": "2014-01-01T05:20:00.12345Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "created_at": { + "description": "This is the time the hostname was created.", + "example": "2020-02-06T18:11:23.531995Z", + "format": "date-time", + "type": "string" + }, + "created_on": { + "description": "When the route was created.", + "example": "2017-06-14T00:00:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "created_on-k2n1y7eG": { + "description": "The timestamp of when the rule was created.", + "example": "2014-01-01T05:20:00.12345Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "created_on-kB9fypz8": { + "description": "The timestamp of when the Page Rule was created.", + "example": "2014-01-01T05:20:00.12345Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "created_on-tz4RTlxL": { + "description": "When the script was created.", + "example": "2017-01-01T00:00:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "creator": { + "description": "A user-defined identifier for the media creator.", + "example": "creator-id_abcde12345", + "maxLength": 64, + "type": "string" + }, + "cron-trigger-response-collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { + "properties": { + "result": { + "properties": { + "schedules": { + "items": { + "properties": { + "created_on": { "readOnly": true }, + "cron": { "readOnly": true }, + "modified_on": { "readOnly": true } + } + }, + "type": "array" + } + }, + "type": "object" + } + } + } + ] + }, + "crowdstrike_config_request": { + "properties": { + "api_url": { + "description": "The Crowdstrike API URL.", + "example": "https://api.us-2.crowdstrike.com", + "type": "string" + }, + "client_id": { + "description": "The Crowdstrike client ID.", + "example": "example client id", + "type": "string" + }, + "client_secret": { + "description": "The Crowdstrike client secret.", + "example": "example client secret", + "type": "string" + }, + "customer_id": { + "description": "The Crowdstrike customer ID.", + "example": "example customer id", + "type": "string" + } + }, + "required": ["api_url", "customer_id", "client_id", "client_secret"], + "type": "object" + }, + "csr": { + "description": "The Certificate Signing Request (CSR). Must be newline-encoded.", + "example": "-----BEGIN CERTIFICATE REQUEST-----\nMIICxzCCAa8CAQAwSDELMAkGA1UEBhMCVVMxFjAUBgNVBAgTDVNhbiBGcmFuY2lz\nY28xCzAJBgNVBAcTAkNBMRQwEgYDVQQDEwtleGFtcGxlLm5ldDCCASIwDQYJKoZI\nhvcNAQEBBQADggEPADCCAQoCggEBALxejtu4b+jPdFeFi6OUsye8TYJQBm3WfCvL\nHu5EvijMO/4Z2TImwASbwUF7Ir8OLgH+mGlQZeqyNvGoSOMEaZVXcYfpR1hlVak8\n4GGVr+04IGfOCqaBokaBFIwzclGZbzKmLGwIQioNxGfqFm6RGYGA3be2Je2iseBc\nN8GV1wYmvYE0RR+yWweJCTJ157exyRzu7sVxaEW9F87zBQLyOnwXc64rflXslRqi\ng7F7w5IaQYOl8yvmk/jEPCAha7fkiUfEpj4N12+oPRiMvleJF98chxjD4MH39c5I\nuOslULhrWunfh7GB1jwWNA9y44H0snrf+xvoy2TcHmxvma9Eln8CAwEAAaA6MDgG\nCSqGSIb3DQEJDjErMCkwJwYDVR0RBCAwHoILZXhhbXBsZS5uZXSCD3d3dy5leGFt\ncGxlLm5ldDANBgkqhkiG9w0BAQsFAAOCAQEAcBaX6dOnI8ncARrI9ZSF2AJX+8mx\npTHY2+Y2C0VvrVDGMtbBRH8R9yMbqWtlxeeNGf//LeMkSKSFa4kbpdx226lfui8/\nauRDBTJGx2R1ccUxmLZXx4my0W5iIMxunu+kez+BDlu7bTT2io0uXMRHue4i6quH\nyc5ibxvbJMjR7dqbcanVE10/34oprzXQsJ/VmSuZNXtjbtSKDlmcpw6To/eeAJ+J\nhXykcUihvHyG4A1m2R6qpANBjnA0pHexfwM/SgfzvpbvUg0T1ubmer8BgTwCKIWs\ndcWYTthM51JIqRBfNqy4QcBnX+GY05yltEEswQI55wdiS3CjTTA67sdbcQ==\n-----END CERTIFICATE REQUEST-----", + "type": "string" + }, + "currency": { + "description": "The monetary unit in which pricing information is displayed.", + "example": "USD", + "readOnly": true, + "type": "string" + }, + "current": { + "description": "Cloudflare Images current usage.", + "example": 1000, + "readOnly": true, + "type": "number" + }, + "current_period_end": { + "description": "The end of the current period and also when the next billing is due.", + "example": "2014-03-31T12:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "current_period_start": { + "description": "When the current billing period started. May match initial_period_start if this is the first period.", + "example": "2014-05-11T12:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "current_registrar": { + "description": "Shows name of current registrar.", + "example": "Cloudflare", + "type": "string" + }, + "cursor": { + "description": "Opaque token indicating the position from which to continue when requesting the next set of records if the amount of list results was limited by the limit parameter. A valid value for the cursor can be obtained from the cursors object in the result_info structure.", + "example": "6Ck1la0VxJ0djhidm1MdX2FyDGxLKVeeHZZmORS_8XeSuhz9SjIJRaSa2lnsF01tQOHrfTGAP3R5X1Kv5iVUuMbNKhWNAXHOl6ePB0TUL8nw", + "type": "string" + }, + "custom-certificate": { + "properties": { + "bundle_method": { "$ref": "#/components/schemas/bundle_method" }, + "expires_on": { "$ref": "#/components/schemas/expires_on" }, + "geo_restrictions": { "$ref": "#/components/schemas/geo_restrictions" }, + "hosts": { "$ref": "#/components/schemas/hosts" }, + "id": { "$ref": "#/components/schemas/identifier-tZwYoMuc" }, + "issuer": { "$ref": "#/components/schemas/issuer" }, + "keyless_server": { "$ref": "#/components/schemas/keyless-certificate" }, + "modified_on": { "$ref": "#/components/schemas/modified_on-t5RPC3jV" }, + "policy": { "$ref": "#/components/schemas/policy" }, + "priority": { "$ref": "#/components/schemas/priority-Cl6RAKfI" }, + "signature": { "$ref": "#/components/schemas/signature" }, + "status": { "$ref": "#/components/schemas/status-dMauZcAv" }, + "uploaded_on": { "$ref": "#/components/schemas/uploaded_on" }, + "zone_id": { "$ref": "#/components/schemas/identifier-tZwYoMuc" } + }, + "required": [ + "id", + "hosts", + "issuer", + "signature", + "status", + "bundle_method", + "zone_id", + "uploaded_on", + "modified_on", + "expires_on", + "priority" + ], + "type": "object" + }, + "custom-certificate-CaAadyYf": { + "properties": { + "bundle_method": { "$ref": "#/components/schemas/bundle_method" }, + "expires_on": { "$ref": "#/components/schemas/components-schemas-expires_on-KIWqadEQ" }, + "geo_restrictions": { "$ref": "#/components/schemas/geo_restrictions" }, + "hosts": { "$ref": "#/components/schemas/hosts" }, + "id": { "$ref": "#/components/schemas/custom-certificate_components-schemas-identifier" }, + "issuer": { "$ref": "#/components/schemas/issuer" }, + "keyless_server": { "$ref": "#/components/schemas/keyless-certificate-1A90AEZs" }, + "modified_on": { "$ref": "#/components/schemas/schemas-modified_on-lfwlFlJl" }, + "policy": { "$ref": "#/components/schemas/policy" }, + "priority": { "$ref": "#/components/schemas/priority-eLZLlpCp" }, + "signature": { "$ref": "#/components/schemas/signature" }, + "status": { "$ref": "#/components/schemas/custom-certificate_components-schemas-status" }, + "uploaded_on": { "$ref": "#/components/schemas/uploaded_on" }, + "zone_id": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + "required": [ + "id", + "hosts", + "issuer", + "signature", + "status", + "bundle_method", + "zone_id", + "uploaded_on", + "modified_on", + "expires_on", + "priority" + ], + "type": "object" + }, + "custom-certificate-settings": { + "description": "Custom certificate settings for BYO-PKI.", + "properties": { + "binding_status": { + "description": "Certificate status (internal)", + "example": "pending_deployment", + "readOnly": true, + "type": "string" + }, + "enabled": { + "description": "Enable use of custom certificate authority for signing Gateway traffic", + "example": true, + "type": "boolean" + }, + "id": { + "description": "UUID of certificate (ID from MTLS certificate store)", + "example": "d1b364c5-1311-466e-a194-f0e943e0799f", + "type": "string" + }, + "updated_at": { "format": "date-time", "readOnly": true, "type": "string" } + }, + "required": ["enabled"], + "type": "object" + }, + "custom-certificate_components-schemas-identifier": { + "description": "Custom certificate identifier tag.", + "example": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60", + "maxLength": 36, + "readOnly": true, + "type": "string" + }, + "custom-certificate_components-schemas-status": { + "description": "Status of the zone's custom SSL.", + "enum": ["active", "expired", "deleted", "pending", "initializing"], + "example": "active", + "readOnly": true + }, + "custom-error-responses_components-schemas-rule": { + "properties": { + "action": { "example": "serve_error" }, + "action_parameters": { "$ref": "#/components/schemas/action_parameters_serve_error" }, + "description": { "example": "Change error response based on geolocation" }, + "expression": { "example": "ip.geoip.country eq \"AL\"" }, + "id": { "example": "3a03d665bac047339bb530ecb439a90d" }, + "version": { "example": "1" } + } + }, + "custom-error-responses_components-schemas-ruleset": { + "properties": { + "description": { "example": "" }, + "id": { "example": "2f2feab2026849078ba485f918791bdc" }, + "kind": { "example": "zone" }, + "name": { "example": "default" }, + "phase": { "example": "http_custom_errors" }, + "rules": { + "description": "The rules in the ruleset.", + "items": { "$ref": "#/components/schemas/custom-error-responses_components-schemas-rule" }, + "type": "array" + } + } + }, + "custom-hostname": { + "allOf": [{ "$ref": "#/components/schemas/customhostname" }], + "properties": { + "hostname": { "$ref": "#/components/schemas/hostname" }, + "id": { "$ref": "#/components/schemas/identifier-tZwYoMuc" }, + "ssl": { "$ref": "#/components/schemas/ssl-EYx9hEKp" } + }, + "required": ["id", "hostname", "ssl"], + "type": "object" + }, + "custom-hostname-uOayu9cz": { + "allOf": [{ "$ref": "#/components/schemas/customhostname-lyk2K3mE" }], + "properties": { + "hostname": { "$ref": "#/components/schemas/hostname" }, + "id": { "$ref": "#/components/schemas/custom-hostname_components-schemas-identifier" }, + "ssl": { "$ref": "#/components/schemas/ssl-UwTUGHGu" } + }, + "required": ["id", "hostname", "ssl"], + "type": "object" + }, + "custom-hostname_components-schemas-identifier": { + "description": "Custom hostname identifier tag.", + "example": "0d89c70d-ad9f-4843-b99f-6cc0252067e9", + "maxLength": 36, + "minLength": 36, + "readOnly": true, + "type": "string" + }, + "custom-hostname_components-schemas-status": { + "description": "Status of the hostname's activation.", + "enum": [ + "active", + "pending", + "active_redeploying", + "moved", + "pending_deletion", + "deleted", + "pending_blocked", + "pending_migration", + "pending_provisioned", + "test_pending", + "test_active", + "test_active_apex", + "test_blocked", + "test_failed", + "provisioned", + "blocked" + ], + "example": "pending" + }, + "custom-pages_components-schemas-identifier": { + "description": "The name of the custom page type.", + "enum": [ + "basic_challenge", + "managed_challenge", + "waf_block", + "ratelimit_block", + "country_challenge", + "ip_block", + "under_attack", + "500_errors", + "1000_errors" + ], + "example": "basic_challenge", + "readOnly": true + }, + "custom-pages_components-schemas-identifier-2": { + "description": "The name of the custom page type.", + "enum": [ + "basic_challenge", + "managed_challenge", + "waf_block", + "country_challenge", + "ip_block", + "under_attack", + "ratelimit_block", + "500_errors", + "1000_errors" + ], + "example": "basic_challenge", + "readOnly": true + }, + "custom_deny_message": { + "description": "The custom error message shown to a user when they are denied access to the application.", + "type": "string" + }, + "custom_deny_url": { + "description": "The custom URL a user is redirected to when they are denied access to the application.", + "type": "string" + }, + "custom_entry": { + "description": "A custom entry that matches a profile", + "properties": { + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "enabled": { "description": "Whether the entry is enabled or not.", "example": true, "type": "boolean" }, + "id": { "$ref": "#/components/schemas/entry_id" }, + "name": { "description": "The name of the entry.", "example": "Credit card (Visa)", "type": "string" }, + "pattern": { "$ref": "#/components/schemas/pattern" }, + "profile_id": { "description": "ID of the parent profile" }, + "updated_at": { "$ref": "#/components/schemas/timestamp" } + }, + "title": "Custom entry", + "type": "object" + }, + "custom_entry-jOfsrCYH": { + "description": "A custom entry that matches a profile", + "properties": { + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "enabled": { "description": "Whether the entry is enabled or not.", "example": true, "type": "boolean" }, + "id": { "$ref": "#/components/schemas/entry_id-A2p6ZYit" }, + "name": { "description": "The name of the entry.", "example": "Credit card (Visa)", "type": "string" }, + "pattern": { "$ref": "#/components/schemas/components-schemas-pattern" }, + "profile_id": { "description": "ID of the parent profile" }, + "updated_at": { "$ref": "#/components/schemas/timestamp" } + }, + "title": "Custom entry", + "type": "object" + }, + "custom_hostname_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/custom-hostname-uOayu9cz" }, "type": "array" } + } + } + ] + }, + "custom_hostname_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { "allOf": [{ "$ref": "#/components/schemas/custom-hostname" }], "type": "object" } + } + } + ] + }, + "custom_hostname_response_single-sVpYaC2x": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } } } + ] + }, + "custom_metadata": { + "anyOf": [ + { + "properties": { + "key": { "description": "Unique metadata for this hostname.", "example": "value", "type": "string" } + }, + "type": "object" + } + ], + "description": "These are per-hostname (customer) settings.", + "type": "object" + }, + "custom_origin_server": { + "description": "a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME record.", + "example": "origin2.example.com", + "type": "string" + }, + "custom_origin_sni": { + "description": "A hostname that will be sent to your custom origin server as SNI for TLS handshake. This can be a valid subdomain of the zone or custom origin server name or the string ':request_host_header:' which will cause the host header in the request to be used as SNI. Not configurable with default/fallback origin server.", + "example": "sni.example.com", + "type": "string" + }, + "custom_page_html": { + "default": "", + "description": "Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custom_page_html is provided, the default waiting room will be used. The template is based on mustache ( https://mustache.github.io/ ). There are several variables that are evaluated by the Cloudflare edge:\n1. {{`waitTimeKnown`}} Acts like a boolean value that indicates the behavior to take when wait time is not available, for instance when queue_all is **true**. \n2. {{`waitTimeFormatted`}} Estimated wait time for the user. For example, five minutes. Alternatively, you can use: \n3. {{`waitTime`}} Number of minutes of estimated wait for a user.\n4. {{`waitTimeHours`}} Number of hours of estimated wait for a user (`Math.floor(waitTime/60)`). \n5. {{`waitTimeHourMinutes`}} Number of minutes above the `waitTimeHours` value (`waitTime%60`). \n6. {{`queueIsFull`}} Changes to **true** when no more people can be added to the queue.\n\nTo view the full list of variables, look at the `cfWaitingRoom` object described under the `json_response_enabled` property in other Waiting Room API calls.", + "example": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Queue all enabled {{/waitTimeKnown}}", + "type": "string" + }, + "custom_pages_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "type": "object" }, "type": "array" } } } + ] + }, + "custom_pages_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } } } + ] + }, + "custom_profile": { + "properties": { + "allowed_match_count": { "$ref": "#/components/schemas/allowed_match_count" }, + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "description": { + "description": "The description of the profile.", + "example": "A standard CVV card number", + "type": "string" + }, + "entries": { + "description": "The entries for this profile.", + "items": { "$ref": "#/components/schemas/custom_entry-jOfsrCYH" }, + "type": "array" + }, + "id": { "$ref": "#/components/schemas/profile_id-JwqwymCp" }, + "name": { "description": "The name of the profile.", "example": "Generic CVV Card Number", "type": "string" }, + "type": { + "description": "The type of the profile.", + "enum": ["custom"], + "example": "custom", + "type": "string" + }, + "updated_at": { "$ref": "#/components/schemas/timestamp" } + }, + "title": "Custom profile", + "type": "object" + }, + "custom_profile_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "allOf": [{ "$ref": "#/components/schemas/custom_profile" }] } } } + ] + }, + "custom_response": { + "anyOf": [ + { + "properties": { + "body": { "$ref": "#/components/schemas/body" }, + "content_type": { "$ref": "#/components/schemas/content_type" } + }, + "type": "object" + } + ], + "description": "A custom content type and reponse to return when the threshold is exceeded. The custom response configured in this object will override the custom error for the zone. This object is optional.\nNotes: If you omit this object, Cloudflare will use the default HTML error page. If \"mode\" is \"challenge\", \"managed_challenge\", or \"js_challenge\", Cloudflare will use the zone challenge pages and you should not provide the \"response\" object.", + "type": "object" + }, + "customer_gre_endpoint": { + "description": "The IP address assigned to the customer side of the GRE tunnel.", + "example": "203.0.113.1", + "type": "string" + }, + "customer_ipsec_endpoint": { + "description": "The IP address assigned to the customer side of the IPsec tunnel.", + "example": "203.0.113.1", + "type": "string" + }, + "customhostname": { + "properties": { + "created_at": { "$ref": "#/components/schemas/created_at" }, + "custom_metadata": { "$ref": "#/components/schemas/custom_metadata" }, + "custom_origin_server": { "$ref": "#/components/schemas/custom_origin_server" }, + "custom_origin_sni": { "$ref": "#/components/schemas/custom_origin_sni" }, + "hostname": { "$ref": "#/components/schemas/hostname" }, + "id": { "$ref": "#/components/schemas/identifier-tZwYoMuc" }, + "ownership_verification": { "$ref": "#/components/schemas/ownership_verification" }, + "ownership_verification_http": { "$ref": "#/components/schemas/ownership_verification_http" }, + "ssl": { "$ref": "#/components/schemas/ssl-EYx9hEKp" }, + "status": { "$ref": "#/components/schemas/components-schemas-status" }, + "verification_errors": { "$ref": "#/components/schemas/verification_errors" } + } + }, + "customhostname-lyk2K3mE": { + "properties": { + "created_at": { "$ref": "#/components/schemas/created_at" }, + "custom_metadata": { "$ref": "#/components/schemas/custom_metadata" }, + "custom_origin_server": { "$ref": "#/components/schemas/custom_origin_server" }, + "custom_origin_sni": { "$ref": "#/components/schemas/custom_origin_sni" }, + "hostname": { "$ref": "#/components/schemas/hostname" }, + "id": { "$ref": "#/components/schemas/custom-hostname_components-schemas-identifier" }, + "ownership_verification": { "$ref": "#/components/schemas/ownership_verification" }, + "ownership_verification_http": { "$ref": "#/components/schemas/ownership_verification_http" }, + "ssl": { "$ref": "#/components/schemas/ssl-UwTUGHGu" }, + "status": { "$ref": "#/components/schemas/custom-hostname_components-schemas-status" }, + "verification_errors": { "$ref": "#/components/schemas/verification_errors" } + } + }, + "dashboard": { + "description": "Totals and timeseries data.", + "properties": { + "timeseries": { "$ref": "#/components/schemas/timeseries" }, + "totals": { "$ref": "#/components/schemas/totals" } + }, + "title": "Dashboard response", + "type": "object" + }, + "dashboard_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "query": { "$ref": "#/components/schemas/query_response" }, + "result": { "$ref": "#/components/schemas/dashboard" } + } + } + ] + }, + "data": { + "description": "Array with one row per combination of dimension values.", + "items": { + "properties": { + "dimensions": { + "description": "Array of dimension values, representing the combination of dimension values corresponding to this row.", + "items": { "description": "Dimension value.", "example": "NODATA", "type": "string" }, + "type": "array" + } + }, + "required": ["dimensions"], + "type": "object" + }, + "type": "array" + }, + "data_points": { + "description": "The number of data points used for the threshold suggestion calculation.", + "readOnly": true, + "type": "integer" + }, + "datacenters": { + "description": "A breakdown of all dashboard analytics data by co-locations. This is limited to Enterprise zones only.", + "items": { + "properties": { + "colo_id": { + "description": "The airport code identifer for the co-location.", + "example": "SFO", + "type": "string" + }, + "timeseries": { "$ref": "#/components/schemas/timeseries_by_colo" }, + "totals": { "$ref": "#/components/schemas/totals_by_colo" } + }, + "type": "object" + }, + "title": "Analytics data by datacenter", + "type": "array" + }, + "dataset": { + "description": "Name of the dataset.", + "example": "http_requests", + "maxLength": 256, + "nullable": true, + "pattern": "^[a-zA-Z0-9_\\-]*$", + "type": "string" + }, + "days_until_next_rotation": { + "description": "The number of days until the next key rotation.", + "example": 1, + "readOnly": true, + "type": "number" + }, + "decision": { + "description": "The action Access will take if a user matches this policy.", + "enum": ["allow", "deny", "non_identity", "bypass"], + "example": "allow", + "type": "string" + }, + "default": { "description": "The default amount allocated.", "example": 5, "type": "number" }, + "default-VASQNGRU": { + "description": "Whether the policy is the default policy for an account.", + "example": false, + "type": "boolean" + }, + "default_device_settings_policy": { + "properties": { + "allow_mode_switch": { "$ref": "#/components/schemas/allow_mode_switch" }, + "allow_updates": { "$ref": "#/components/schemas/allow_updates" }, + "allowed_to_leave": { "$ref": "#/components/schemas/allowed_to_leave" }, + "auto_connect": { "$ref": "#/components/schemas/auto_connect" }, + "captive_portal": { "$ref": "#/components/schemas/captive_portal" }, + "default": { + "description": "Whether the policy will be applied to matching devices.", + "example": true, + "type": "boolean" + }, + "disable_auto_fallback": { "$ref": "#/components/schemas/disable_auto_fallback" }, + "enabled": { + "description": "Whether the policy will be applied to matching devices.", + "example": true, + "type": "boolean" + }, + "exclude": { "$ref": "#/components/schemas/components-schemas-exclude" }, + "exclude_office_ips": { "$ref": "#/components/schemas/exclude_office_ips" }, + "fallback_domains": { "$ref": "#/components/schemas/fallback_domains" }, + "gateway_unique_id": { "$ref": "#/components/schemas/gateway_unique_id" }, + "include": { "$ref": "#/components/schemas/schemas-include" }, + "service_mode_v2": { "$ref": "#/components/schemas/service_mode_v2" }, + "support_url": { "$ref": "#/components/schemas/support_url" }, + "switch_locked": { "$ref": "#/components/schemas/switch_locked" } + }, + "type": "object" + }, + "default_device_settings_policy-kZzKyPpc": { + "properties": { + "allow_mode_switch": { "$ref": "#/components/schemas/allow_mode_switch" }, + "allow_updates": { "$ref": "#/components/schemas/allow_updates" }, + "allowed_to_leave": { "$ref": "#/components/schemas/allowed_to_leave" }, + "auto_connect": { "$ref": "#/components/schemas/auto_connect" }, + "captive_portal": { "$ref": "#/components/schemas/captive_portal" }, + "default": { + "description": "Whether the policy will be applied to matching devices.", + "example": true, + "type": "boolean" + }, + "disable_auto_fallback": { "$ref": "#/components/schemas/disable_auto_fallback" }, + "enabled": { + "description": "Whether the policy will be applied to matching devices.", + "example": true, + "type": "boolean" + }, + "exclude": { "$ref": "#/components/schemas/exclude-tYW3UmZW" }, + "exclude_office_ips": { "$ref": "#/components/schemas/exclude_office_ips" }, + "fallback_domains": { "$ref": "#/components/schemas/fallback_domains" }, + "gateway_unique_id": { "$ref": "#/components/schemas/gateway_unique_id" }, + "include": { "$ref": "#/components/schemas/include-9GPmbbUN" }, + "service_mode_v2": { "$ref": "#/components/schemas/service_mode_v2" }, + "support_url": { "$ref": "#/components/schemas/support_url" }, + "switch_locked": { "$ref": "#/components/schemas/switch_locked" } + }, + "type": "object" + }, + "default_device_settings_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "$ref": "#/components/schemas/default_device_settings_policy-kZzKyPpc" } } } + ] + }, + "default_mode": { + "description": "The default action/mode of a rule.", + "enum": ["disable", "simulate", "block", "challenge"], + "example": "block", + "readOnly": true + }, + "default_pools": { + "description": "A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.", + "example": [ + "17b5962d775c646f3f9725cbc7a53df4", + "9290f38c5d07c2e2f4df57b1f61d4196", + "00920f38ce07c2e2f4df50b1f61d4194" + ], + "items": { "description": "A pool ID.", "type": "string" }, + "type": "array" + }, + "default_response": { "allOf": [{ "$ref": "#/components/schemas/api-response-single" }] }, + "default_sni": { + "description": "If you have legacy TLS clients which do not send the TLS server name indicator, then you can specify one default SNI on the map. If Cloudflare receives a TLS handshake from a client without an SNI, it will respond with the default SNI on those IPs. The default SNI can be any valid zone or subdomain owned by the account.", + "example": "*.example.com", + "nullable": true, + "type": "string" + }, + "default_template_language": { + "default": "en-US", + "description": "The language of the default page template. If no default_template_language is provided, then `en-US` (English) will be used.", + "enum": [ + "en-US", + "es-ES", + "de-DE", + "fr-FR", + "it-IT", + "ja-JP", + "ko-KR", + "pt-BR", + "zh-CN", + "zh-TW", + "nl-NL", + "pl-PL", + "id-ID", + "tr-TR", + "ar-EG", + "ru-RU", + "fa-IR" + ], + "example": "es-ES", + "type": "string" + }, + "delegated_account_identifier": { + "description": "Account identifier for the account to which prefix is being delegated.", + "example": "b1946ac92492d2347c6235b4d2611184", + "maxLength": 32, + "type": "string" + }, + "delegated_account_identifier-hmTz3KXe": { + "description": "Account identifier for the account to which prefix is being delegated.", + "example": "b1946ac92492d2347c6235b4d2611184", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "delegation_identifier": { + "description": "Delegation identifier tag.", + "example": "d933b1530bc56c9953cf8ce166da8004", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "delete_advanced_certificate_pack_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { "id": { "$ref": "#/components/schemas/identifier-tZwYoMuc" } }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "delete_advanced_certificate_pack_response_single-AepvbdfN": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "id": { "$ref": "#/components/schemas/certificate-packs_components-schemas-identifier" } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "delete_dnssec_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "example": "", "type": "string" } } } + ] + }, + "delete_filter_if_unused": { + "description": "When true, indicates that Cloudflare should also delete the associated filter if there are no other firewall rules referencing the filter.", + "type": "boolean" + }, + "deleted": { + "description": "When true, indicates that the firewall rule was deleted.", + "example": true, + "type": "boolean" + }, + "deleted-filter": { + "additionalProperties": false, + "properties": { + "deleted": { "$ref": "#/components/schemas/deleted" }, + "id": { "$ref": "#/components/schemas/filters_components-schemas-id" } + }, + "required": ["id", "deleted"] + }, + "deleted-gN7SICJB": { "description": "True if the device was deleted.", "example": true, "type": "boolean" }, + "deleted_at": { + "description": "Date of deletion, if any.", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "deleted_at-5nLnuPfs": { + "description": "Timestamp of when the tunnel was deleted. If `null`, the tunnel has not been deleted.", + "example": "2009-11-10T23:00:00Z", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "deleted_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "example": {}, "type": "object" } } } + ] + }, + "deleted_response-7kko7sFR": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "example": "ok", "type": "string" } } } + ] + }, + "deployment-list-response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { + "properties": { + "result_info": { + "properties": { + "count": { "example": 1 }, + "page": { "example": 1 }, + "per_page": { "example": 100 }, + "total_count": { "example": 1 } + }, + "type": "object" + } + } + }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/deployments" }, "type": "array" } } } + ] + }, + "deployment-new-deployment": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { "properties": { "result": { "$ref": "#/components/schemas/deployments" } } } + ] + }, + "deployment-response-details": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { "properties": { "result": { "$ref": "#/components/schemas/deployments" } } } + ] + }, + "deployment-response-logs": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { + "properties": { + "result": { + "example": { + "data": [ + { "line": "Cloning repository...", "ts": "2021-04-20T19:35:29.0749819Z" }, + { "line": "From https://github.com/cloudflare/example", "ts": "2021-04-20T19:35:30.0749819Z" }, + { + "line": " * branch 209c5bb11d89533f426b2f8469bcae12fdccf71b -\u003e FETCH_HEAD", + "ts": "2021-04-20T19:35:30.0749819Z" + }, + { "line": "", "ts": "2021-04-20T19:35:30.0749819Z" }, + { "line": "HEAD is now at 209c5bb Update index.html", "ts": "2021-04-20T19:35:30.0749819Z" }, + { "line": "", "ts": "2021-04-20T19:35:30.0749819Z" }, + { "line": "", "ts": "2021-04-20T19:35:30.0749819Z" }, + { "line": "Success: Finished cloning repository files", "ts": "2021-04-20T19:35:30.0749819Z" }, + { "line": "Installing dependencies", "ts": "2021-04-20T19:35:59.0749819Z" }, + { "line": "Python version set to 2.7", "ts": "2021-04-20T19:35:59.0931208Z" }, + { "line": "v12.18.0 is already installed.", "ts": "2021-04-20T19:36:02.2369501Z" }, + { "line": "Now using node v12.18.0 (npm v6.14.4)", "ts": "2021-04-20T19:36:02.6028886Z" }, + { "line": "Started restoring cached build plugins", "ts": "2021-04-20T19:36:02.624555Z" }, + { "line": "Finished restoring cached build plugins", "ts": "2021-04-20T19:36:02.6340688Z" }, + { + "line": "Attempting ruby version 2.7.1, read from environment", + "ts": "2021-04-20T19:36:02.963095Z" + }, + { "line": "Using ruby version 2.7.1", "ts": "2021-04-20T19:36:04.2236084Z" }, + { "line": "Using PHP version 5.6", "ts": "2021-04-20T19:36:04.5450152Z" }, + { "line": "5.2 is already installed.", "ts": "2021-04-20T19:36:04.5740509Z" }, + { "line": "Using Swift version 5.2", "ts": "2021-04-20T19:36:04.577035Z" }, + { "line": "Installing Hugo 0.54.0", "ts": "2021-04-20T19:36:04.5771615Z" }, + { + "line": "Hugo Static Site Generator v0.54.0-B1A82C61A/extended linux/amd64 BuildDate: 2019-02-01T10:04:38Z", + "ts": "2021-04-20T19:36:05.4786868Z" + }, + { "line": "Started restoring cached go cache", "ts": "2021-04-20T19:36:05.4794366Z" }, + { "line": "Finished restoring cached go cache", "ts": "2021-04-20T19:36:05.481977Z" }, + { "line": "go version go1.14.4 linux/amd64", "ts": "2021-04-20T19:36:05.9049776Z" }, + { "line": "go version go1.14.4 linux/amd64", "ts": "2021-04-20T19:36:05.9086053Z" }, + { "line": "Installing missing commands", "ts": "2021-04-20T19:36:05.9163568Z" }, + { "line": "Verify run directory", "ts": "2021-04-20T19:36:05.9163934Z" }, + { + "line": "Executing user command: echo \"skipping build step: no build command specified\"", + "ts": "2021-04-20T19:36:05.9164636Z" + }, + { "line": "skipping build step: no build command specified", "ts": "2021-04-20T19:36:05.9165087Z" }, + { "line": "Finished", "ts": "2021-04-20T19:36:05.917412Z" } + ], + "includes_container_logs": true, + "total": 30 + }, + "type": "object" + } + } + } + ] + }, + "deployment-response-stage-logs": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { + "properties": { + "result": { + "example": { + "data": [ + { "id": 15, "message": "Installing dependencies", "timestamp": "2021-04-20T19:35:59.0749819Z" }, + { "id": 16, "message": "Python version set to 2.7", "timestamp": "2021-04-20T19:35:59.0931208Z" }, + { + "id": 17, + "message": "v12.18.0 is already installed.", + "timestamp": "2021-04-20T19:36:02.2369501Z" + }, + { + "id": 18, + "message": "Now using node v12.18.0 (npm v6.14.4)", + "timestamp": "2021-04-20T19:36:02.6028886Z" + }, + { + "id": 19, + "message": "Started restoring cached build plugins", + "timestamp": "2021-04-20T19:36:02.624555Z" + }, + { + "id": 20, + "message": "Finished restoring cached build plugins", + "timestamp": "2021-04-20T19:36:02.6340688Z" + }, + { + "id": 21, + "message": "Attempting ruby version 2.7.1, read from environment", + "timestamp": "2021-04-20T19:36:02.963095Z" + }, + { "id": 22, "message": "Using ruby version 2.7.1", "timestamp": "2021-04-20T19:36:04.2236084Z" }, + { "id": 23, "message": "Using PHP version 5.6", "timestamp": "2021-04-20T19:36:04.5450152Z" }, + { "id": 24, "message": "5.2 is already installed.", "timestamp": "2021-04-20T19:36:04.5740509Z" }, + { "id": 25, "message": "Using Swift version 5.2", "timestamp": "2021-04-20T19:36:04.577035Z" }, + { "id": 26, "message": "Installing Hugo 0.54.0", "timestamp": "2021-04-20T19:36:04.5771615Z" }, + { + "id": 27, + "message": "Hugo Static Site Generator v0.54.0-B1A82C61A/extended linux/amd64 BuildDate: 2019-02-01T10:04:38Z", + "timestamp": "2021-04-20T19:36:05.4786868Z" + }, + { + "id": 28, + "message": "Started restoring cached go cache", + "timestamp": "2021-04-20T19:36:05.4794366Z" + }, + { + "id": 29, + "message": "Finished restoring cached go cache", + "timestamp": "2021-04-20T19:36:05.481977Z" + }, + { + "id": 30, + "message": "go version go1.14.4 linux/amd64", + "timestamp": "2021-04-20T19:36:05.9049776Z" + }, + { + "id": 31, + "message": "go version go1.14.4 linux/amd64", + "timestamp": "2021-04-20T19:36:05.9086053Z" + }, + { "id": 32, "message": "Installing missing commands", "timestamp": "2021-04-20T19:36:05.9163568Z" }, + { "id": 33, "message": "Verify run directory", "timestamp": "2021-04-20T19:36:05.9163934Z" }, + { + "id": 34, + "message": "Executing user command: echo \"skipping build step: no build command specified\"", + "timestamp": "2021-04-20T19:36:05.9164636Z" + }, + { + "id": 35, + "message": "skipping build step: no build command specified", + "timestamp": "2021-04-20T19:36:05.9165087Z" + }, + { "id": 36, "message": "Finished", "timestamp": "2021-04-20T19:36:05.917412Z" } + ], + "end": 37, + "ended_on": "2021-04-20T19:36:06.38889Z", + "name": "build", + "start": 0, + "started_on": "2021-04-20T19:35:58.238757Z", + "status": "success", + "total": 37 + }, + "type": "object" + } + } + } + ] + }, + "deployment_configs": { + "description": "Configs for deployments in a project.", + "properties": { + "preview": { + "anyOf": [{ "$ref": "#/components/schemas/deployment_configs_values" }], + "description": "Configs for preview deploys.", + "type": "object" + }, + "production": { + "anyOf": [{ "$ref": "#/components/schemas/deployment_configs_values" }], + "description": "Configs for production deploys.", + "type": "object" + } + }, + "type": "object" + }, + "deployment_configs_values": { + "properties": { + "compatibility_date": { + "description": "Compatibility date used for Pages Functions.", + "example": "2022-01-01", + "type": "string" + }, + "compatibility_flags": { + "description": "Compatibility flags used for Pages Functions.", + "example": ["url_standard"], + "type": "array" + }, + "d1_databases": { + "description": "D1 databases used for Pages Functions.", + "nullable": true, + "properties": { + "D1_BINDING": { + "description": "D1 binding.", + "example": { "id": "445e2955-951a-43f8-a35b-a4d0c8138f63" }, + "properties": { + "id": { + "description": "UUID of the D1 database.", + "example": "445e2955-951a-43f8-a35b-a4d0c8138f63", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "durable_object_namespaces": { + "description": "Durabble Object namespaces used for Pages Functions.", + "nullable": true, + "properties": { + "DO_BINDING": { + "description": "Durabble Object binding.", + "example": { "namespace_id": "5eb63bbbe01eeed093cb22bb8f5acdc3" }, + "properties": { + "namespace_id": { + "description": "ID of the Durabble Object namespace.", + "example": "5eb63bbbe01eeed093cb22bb8f5acdc3", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "env_vars": { + "description": "Environment variables for build configs.", + "nullable": true, + "properties": { + "ENVIRONMENT_VARIABLE": { + "description": "Environment variable.", + "example": { "type": "plain_text", "value": "hello world" }, + "properties": { + "type": { + "description": "The type of environment variable (plain text or secret)", + "enum": ["plain_text", "secret_text"], + "type": "string" + }, + "value": { "description": "Environment variable value.", "type": "string" } + }, + "type": "object" + } + }, + "type": "object" + }, + "kv_namespaces": { + "description": "KV namespaces used for Pages Functions.", + "properties": { + "KV_BINDING": { + "description": "KV binding.", + "example": { "namespace_id": "5eb63bbbe01eeed093cb22bb8f5acdc3" }, + "properties": { + "namespace_id": { + "description": "ID of the KV namespace.", + "example": "5eb63bbbe01eeed093cb22bb8f5acdc3", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "queue_producers": { + "description": "Queue Producer bindings used for Pages Functions.", + "nullable": true, + "properties": { + "QUEUE_PRODUCER_BINDING": { + "description": "Queue Producer binding.", + "example": { "name": "some-queue" }, + "properties": { + "name": { "description": "Name of the Queue.", "example": "some-queue", "type": "string" } + }, + "type": "object" + } + }, + "type": "object" + }, + "r2_buckets": { + "description": "R2 buckets used for Pages Functions.", + "nullable": true, + "properties": { + "R2_BINDING": { + "description": "R2 binding.", + "example": { "name": "some-bucket" }, + "properties": { + "name": { "description": "Name of the R2 bucket.", "example": "some-bucket", "type": "string" } + }, + "type": "object" + } + }, + "type": "object" + }, + "service_bindings": { + "description": "Services used for Pages Functions.", + "nullable": true, + "properties": { + "SERVICE_BINDING": { + "description": "Service binding.", + "example": { "environment": "production", "service": "example-worker" }, + "properties": { + "environment": { "description": "The Service environment.", "type": "string" }, + "service": { "description": "The Service name.", "type": "string" } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "deployment_identifier": { + "example": "bcf48806-b317-4351-9ee7-36e7d557d4de", + "maxLength": 36, + "readOnly": true, + "type": "string" + }, + "deployment_stage_name": { + "description": "Deployment stage name.", + "example": "deploy", + "pattern": "queued|initialize|clone_repo|build|deploy", + "type": "string" + }, + "deployments": { + "properties": { + "aliases": { + "description": "A list of alias URLs pointing to this deployment.", + "example": ["https://branchname.projectname.pages.dev"], + "items": {}, + "nullable": true, + "readOnly": true, + "type": "array" + }, + "build_config": { "readOnly": true }, + "created_on": { + "description": "When the deployment was created.", + "example": "2021-03-09T00:55:03.923456Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "deployment_trigger": { + "description": "Info about what caused the deployment.", + "properties": { + "metadata": { + "description": "Additional info about the trigger.", + "properties": { + "branch": { + "description": "Where the trigger happened.", + "example": "main", + "readOnly": true, + "type": "string" + }, + "commit_hash": { + "description": "Hash of the deployment trigger commit.", + "example": "ad9ccd918a81025731e10e40267e11273a263421", + "readOnly": true, + "type": "string" + }, + "commit_message": { + "description": "Message of the deployment trigger commit.", + "example": "Update index.html", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "type": { + "description": "What caused the deployment.", + "example": "ad_hoc", + "pattern": "push|ad_hoc", + "readOnly": true, + "type": "string" + } + }, + "readOnly": true, + "type": "object" + }, + "env_vars": { + "description": "A dict of env variables to build this deploy.", + "example": { "BUILD_VERSION": { "value": "3.3" }, "ENV": { "value": "STAGING" } }, + "readOnly": true, + "type": "object" + }, + "environment": { + "description": "Type of deploy.", + "example": "preview", + "pattern": "preview|production", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Id of the deployment.", + "example": "f64788e9-fccd-4d4a-a28a-cb84f88f6", + "readOnly": true, + "type": "string" + }, + "is_skipped": { + "description": "If the deployment has been skipped.", + "example": true, + "readOnly": true, + "type": "boolean" + }, + "latest_stage": { "readOnly": true }, + "modified_on": { + "description": "When the deployment was last modified.", + "example": "2021-03-09T00:58:59.045655", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "project_id": { + "description": "Id of the project.", + "example": "7b162ea7-7367-4d67-bcde-1160995d5", + "readOnly": true, + "type": "string" + }, + "project_name": { + "description": "Name of the project.", + "example": "ninjakittens", + "readOnly": true, + "type": "string" + }, + "short_id": { + "description": "Short Id (8 character) of the deployment.", + "example": "f64788e9", + "readOnly": true, + "type": "string" + }, + "source": { "readOnly": true }, + "stages": { + "description": "List of past stages.", + "example": [ + { + "ended_on": "2021-06-03T15:39:03.134378Z", + "name": "queued", + "started_on": "2021-06-03T15:38:15.608194Z", + "status": "active" + }, + { "ended_on": null, "name": "initialize", "started_on": null, "status": "idle" }, + { "ended_on": null, "name": "clone_repo", "started_on": null, "status": "idle" }, + { "ended_on": null, "name": "build", "started_on": null, "status": "idle" }, + { "ended_on": null, "name": "deploy", "started_on": null, "status": "idle" } + ], + "items": { "$ref": "#/components/schemas/stage" }, + "readOnly": true, + "type": "array" + }, + "url": { + "description": "The live URL to view this deployment.", + "example": "https://f64788e9.ninjakittens.pages.dev", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "deployments-list-response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { + "properties": { + "items": { + "example": [ + { + "id": "bcf48806-b317-4351-9ee7-36e7d557d4de", + "metadata": { + "author_email": "user@example.com", + "author_id": "408cbcdfd4dda4617efef40b04d168a1", + "created_on": "2022-11-15T18:25:44.442097Z", + "modified_on": "2022-11-15T18:25:44.442097Z", + "source": "api" + }, + "number": 2 + }, + { + "id": "18f97339-c287-4872-9bdd-e2135c07ec12", + "metadata": { + "author_email": "user@example.com", + "author_id": "408cbcdfd4dda4617efef40b04d168a1", + "created_on": "2022-11-08T17:30:56.968096Z", + "modified_on": "2022-11-08T17:30:56.968096Z", + "source": "api" + }, + "number": 1 + } + ], + "items": {}, + "type": "array" + }, + "latest": { + "example": { + "id": "bcf48806-b317-4351-9ee7-36e7d557d4de", + "metadata": { + "author_email": "user@example.com", + "author_id": "408cbcdfd4dda4617efef40b04d168a1", + "created_on": "2022-11-15T18:25:44.442097Z", + "modified_on": "2022-11-15T18:25:44.442097Z", + "source": "api" + }, + "number": 2, + "resources": { + "bindings": [{ "json": "example_binding", "name": "JSON_VAR", "type": "json" }], + "script": { + "etag": "13a3240e8fb414561b0366813b0b8f42b3e6cfa0d9e70e99835dae83d0d8a794", + "handlers": ["fetch"], + "last_deployed_from": "api" + }, + "script_runtime": { "usage_model": "bundled" } + } + }, + "type": "object" + } + } + } + ] + }, + "deployments-single-response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { + "properties": { + "id": { "example": "18f97339-c287-4872-9bdd-e2135c07ec12", "type": "string" }, + "metadata": { + "example": { + "author_email": "user@example.com", + "author_id": "408cbcdfd4dda4617efef40b04d168a1", + "created_on": "2022-11-08T17:19:29.176266Z", + "modified_on": "2022-11-08T17:19:29.176266Z", + "source": "api" + }, + "type": "object" + }, + "number": { "example": 1, "type": "number" }, + "resources": { + "example": { + "bindings": [{ "json": "example_binding", "name": "JSON_VAR", "type": "json" }], + "script": { + "etag": "13a3240e8fb414561b0366813b0b8f42b3e6cfa0d9e70e99835dae83d0d8a794", + "handlers": ["fetch"], + "last_deployed_from": "api" + }, + "script_runtime": { "usage_model": "bundled" } + }, + "type": "object" + } + } + } + ] + }, + "deprecate_any_requests": { + "description": "Deprecate the response to ANY requests.", + "example": true, + "type": "boolean" + }, + "description": { + "description": "The description of the List.", + "example": "The serial numbers for administrators", + "type": "string" + }, + "description-AqNwNwjr": { + "description": "Description of the prefix.", + "example": "Internal test prefix", + "maxLength": 1000, + "type": "string" + }, + "description-DIf6mz41": { + "default": "", + "description": "A note that you can use to add more details about the waiting room.", + "example": "Production - DO NOT MODIFY", + "type": "string" + }, + "description-HWZDzyev": { + "description": "The description of the Device Posture Rule.", + "example": "The rule for admin serial numbers", + "type": "string" + }, + "description-Jd6AMFjR": { + "description": "Object description.", + "example": "Login page monitor", + "type": "string" + }, + "description-dSE9ExYP": { + "description": "An optional human provided description of the static route.", + "example": "New route for new prefix 203.0.113.1", + "type": "string" + }, + "description-gV3mXO2g": { + "description": "Description of role's permissions.", + "example": "Administrative access to the entire Organization", + "readOnly": true, + "type": "string" + }, + "description-hRvlp2wh": { + "description": "A human-readable description of the health check.", + "example": "Health check for www.example.com", + "type": "string" + }, + "description_search": { + "description": "A string to search for in the description of existing rules.", + "example": "abusive", + "type": "string" + }, + "destination_address_identifier": { + "description": "Destination address identifier.", + "example": "ea95132c15732412d22c1476fa83f27a", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "destination_address_properties": { + "properties": { + "created": { "$ref": "#/components/schemas/created-UVGJEhhU" }, + "email": { "$ref": "#/components/schemas/email-xwlVNguu" }, + "modified": { "$ref": "#/components/schemas/modified-Hq0wyeit" }, + "tag": { "$ref": "#/components/schemas/destination_address_identifier" }, + "verified": { "$ref": "#/components/schemas/verified" } + }, + "type": "object" + }, + "destination_address_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/addresses" } } } + ] + }, + "destination_addresses_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/addresses" }, "type": "array" }, + "result_info": { + "properties": { + "count": { "example": 1 }, + "page": { "example": 1 }, + "per_page": { "example": 20 }, + "total_count": { "example": 1 } + }, + "type": "object" + } + } + } + ] + }, + "destination_conf": { + "description": "Uniquely identifies a resource (such as an s3 bucket) where data will be pushed. Additional configuration parameters supported by the destination may be included.", + "example": "s3://mybucket/logs?region=us-west-2", + "format": "uri", + "maxLength": 4096, + "type": "string" + }, + "destination_exists_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { + "properties": { + "result": { + "nullable": true, + "properties": { "exists": { "example": false, "type": "boolean" } }, + "type": "object" + } + } + } + ] + }, + "detection_mode": { + "description": "The mode that defines how rules within the package are evaluated during the course of a request. When a package uses anomaly detection mode (`anomaly` value), each rule is given a score when triggered. If the total score of all triggered rules exceeds the sensitivity defined in the WAF package, the action configured in the package will be performed. Traditional detection mode (`traditional` value) will decide the action to take when it is triggered by the request. If multiple rules are triggered, the action providing the highest protection will be applied (for example, a 'block' action will win over a 'challenge' action).", + "enum": ["anomaly", "traditional"], + "example": "traditional", + "readOnly": true, + "type": "string" + }, + "development_mode": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { + "description": "ID of the zone setting.", + "enum": ["development_mode"], + "example": "development_mode" + }, + "time_remaining": { + "description": "Value of the zone setting.\nNotes: The interval (in seconds) from when development mode expires (positive integer) or last expired (negative integer) for the domain. If development mode has never been enabled, this value is false.", + "example": 3600, + "readOnly": true, + "type": "number" + }, + "value": { "$ref": "#/components/schemas/development_mode_value" } + } + } + ], + "description": "Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare's accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off.", + "title": "Development Mode" + }, + "development_mode_value": { + "default": "off", + "description": "Value of the zone setting.", + "enum": ["on", "off"], + "type": "string" + }, + "device-dex-test-schemas-data": { + "description": "The configuration object which contains the details for the WARP client to conduct the test.", + "example": { "host": "https://dash.cloudflare.com", "kind": "http", "method": "GET" }, + "properties": { + "host": { + "description": "The desired endpoint to test.", + "example": "https://dash.cloudflare.com", + "type": "string" + }, + "kind": { "description": "The type of test.", "example": "http", "type": "string" }, + "method": { "description": "The HTTP request method type.", "example": "GET", "type": "string" } + }, + "type": "object" + }, + "device-dex-test-schemas-description": { + "description": "Additional details about the test.", + "example": "Checks the dash endpoint every 30 minutes", + "type": "string" + }, + "device-dex-test-schemas-enabled": { + "description": "Determines whether or not the test is active.", + "example": true, + "type": "boolean" + }, + "device-dex-test-schemas-http": { + "properties": { + "data": { "$ref": "#/components/schemas/device-dex-test-schemas-data" }, + "description": { "$ref": "#/components/schemas/device-dex-test-schemas-description" }, + "enabled": { "$ref": "#/components/schemas/device-dex-test-schemas-enabled" }, + "interval": { "$ref": "#/components/schemas/device-dex-test-schemas-interval" }, + "name": { "$ref": "#/components/schemas/device-dex-test-schemas-name" } + }, + "required": ["name", "interval", "enabled", "data"], + "type": "object" + }, + "device-dex-test-schemas-interval": { + "description": "How often the test will run.", + "example": "30m", + "type": "string" + }, + "device-dex-test-schemas-name": { + "description": "The name of the DEX test. Must be unique.", + "example": "HTTP dash health check", + "type": "string" + }, + "device-managed-networks": { + "properties": { + "config": { "$ref": "#/components/schemas/schemas-config_response" }, + "name": { "$ref": "#/components/schemas/device-managed-networks_components-schemas-name" }, + "network_id": { "$ref": "#/components/schemas/device-managed-networks_components-schemas-uuid" }, + "type": { "$ref": "#/components/schemas/device-managed-networks_components-schemas-type" } + }, + "type": "object" + }, + "device-managed-networks-FH3V2phW": { + "properties": { + "config": { "$ref": "#/components/schemas/schemas-config_response" }, + "name": { "$ref": "#/components/schemas/device-managed-networks_components-schemas-name" }, + "network_id": { "$ref": "#/components/schemas/uuid-l20MFQPz" }, + "type": { "$ref": "#/components/schemas/components-schemas-type-KlrF1JPW" } + }, + "type": "object" + }, + "device-managed-networks_components-schemas-identifier": { "example": "699d98642c564d2e855e9661899b7252" }, + "device-managed-networks_components-schemas-name": { + "description": "The name of the Device Managed Network. Must be unique.", + "example": "managed-network-1", + "type": "string" + }, + "device-managed-networks_components-schemas-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/device-managed-networks" }, "type": "array" } + } + } + ] + }, + "device-managed-networks_components-schemas-single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/device-managed-networks" } } } + ] + }, + "device-managed-networks_components-schemas-type": { + "description": "The type of Device Managed Network.", + "enum": ["tls"], + "example": "tls", + "type": "string" + }, + "device-managed-networks_components-schemas-uuid": { + "description": "API uuid tag.", + "example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", + "maxLength": 36, + "type": "string" + }, + "device-posture-integrations": { + "properties": { + "config": { "$ref": "#/components/schemas/config_response" }, + "id": { "$ref": "#/components/schemas/device-posture-integrations_components-schemas-uuid" }, + "interval": { "$ref": "#/components/schemas/schemas-interval" }, + "name": { "$ref": "#/components/schemas/device-posture-integrations_components-schemas-name" }, + "type": { "$ref": "#/components/schemas/device-posture-integrations_components-schemas-type" } + }, + "type": "object" + }, + "device-posture-integrations-Xb3lCexZ": { + "properties": { + "config": { "$ref": "#/components/schemas/config_response" }, + "id": { "$ref": "#/components/schemas/uuid-l20MFQPz" }, + "interval": { "$ref": "#/components/schemas/interval-FAyugCvL" }, + "name": { "$ref": "#/components/schemas/components-schemas-name-4QGVxQIe" }, + "type": { "$ref": "#/components/schemas/schemas-type-BQBcyQpN" } + }, + "type": "object" + }, + "device-posture-integrations_components-schemas-id_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "nullable": true } } } + ] + }, + "device-posture-integrations_components-schemas-identifier": { "example": "699d98642c564d2e855e9661899b7252" }, + "device-posture-integrations_components-schemas-name": { + "description": "The name of the Device Posture Integration.", + "example": "My Workspace One Integration", + "type": "string" + }, + "device-posture-integrations_components-schemas-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/device-posture-integrations" }, "type": "array" } + } + } + ] + }, + "device-posture-integrations_components-schemas-single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/device-posture-integrations" } } } + ] + }, + "device-posture-integrations_components-schemas-type": { + "description": "The type of Device Posture Integration.", + "enum": ["workspace_one", "crowdstrike_s2s", "uptycs", "intune"], + "example": "workspace_one", + "type": "string" + }, + "device-posture-integrations_components-schemas-uuid": { + "description": "API uuid tag.", + "example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", + "maxLength": 36, + "type": "string" + }, + "device-posture-rules": { + "properties": { + "description": { "$ref": "#/components/schemas/device-posture-rules_components-schemas-description" }, + "expiration": { "$ref": "#/components/schemas/schemas-expiration" }, + "id": { "$ref": "#/components/schemas/device-posture-rules_components-schemas-uuid" }, + "input": { "$ref": "#/components/schemas/input" }, + "match": { "$ref": "#/components/schemas/schemas-match" }, + "name": { "$ref": "#/components/schemas/device-posture-rules_components-schemas-name" }, + "schedule": { "$ref": "#/components/schemas/schedule-6SyTxxBD" }, + "type": { "$ref": "#/components/schemas/device-posture-rules_components-schemas-type" } + }, + "type": "object" + }, + "device-posture-rules-gduy4mTZ": { + "properties": { + "description": { "$ref": "#/components/schemas/description-HWZDzyev" }, + "expiration": { "$ref": "#/components/schemas/expiration-9DsFtGHX" }, + "id": { "$ref": "#/components/schemas/uuid-l20MFQPz" }, + "input": { "$ref": "#/components/schemas/input-NaZjecAw" }, + "match": { "$ref": "#/components/schemas/match-gWGZ7MOw" }, + "name": { "$ref": "#/components/schemas/name-wyyCMADI" }, + "schedule": { "$ref": "#/components/schemas/schedule-kOC57cA0" }, + "type": { "$ref": "#/components/schemas/type-tb4QXpPC" } + }, + "type": "object" + }, + "device-posture-rules_components-schemas-description": { + "description": "The description of the Device Posture Rule.", + "example": "The rule for admin serial numbers", + "type": "string" + }, + "device-posture-rules_components-schemas-id_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { "id": { "$ref": "#/components/schemas/device-posture-rules_components-schemas-uuid" } }, + "type": "object" + } + } + } + ] + }, + "device-posture-rules_components-schemas-identifier": { "example": "699d98642c564d2e855e9661899b7252" }, + "device-posture-rules_components-schemas-name": { + "description": "The name of the Device Posture Rule.", + "example": "Admin Serial Numbers", + "type": "string" + }, + "device-posture-rules_components-schemas-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/device-posture-rules" }, "type": "array" } + } + } + ] + }, + "device-posture-rules_components-schemas-single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/device-posture-rules" } } } + ] + }, + "device-posture-rules_components-schemas-type": { + "description": "The type of Device Posture Rule.", + "enum": ["file", "application", "serial_number", "tanium", "gateway", "warp"], + "example": "file", + "type": "string" + }, + "device-posture-rules_components-schemas-uuid": { + "description": "API uuid tag.", + "example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", + "maxLength": 36, + "type": "string" + }, + "device_posture": { + "description": "The wirefilter expression to be used for device posture check matching.", + "example": "any(device_posture.checks.passed[*] in {\"1308749e-fcfb-4ebc-b051-fe022b632644\"})", + "type": "string" + }, + "device_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } } } + ] + }, + "device_settings_policy": { + "properties": { + "allow_mode_switch": { "$ref": "#/components/schemas/allow_mode_switch" }, + "allow_updates": { "$ref": "#/components/schemas/allow_updates" }, + "allowed_to_leave": { "$ref": "#/components/schemas/allowed_to_leave" }, + "auto_connect": { "$ref": "#/components/schemas/auto_connect" }, + "captive_portal": { "$ref": "#/components/schemas/captive_portal" }, + "default": { "$ref": "#/components/schemas/schemas-default" }, + "description": { "$ref": "#/components/schemas/devices_components-schemas-description" }, + "disable_auto_fallback": { "$ref": "#/components/schemas/disable_auto_fallback" }, + "enabled": { + "description": "Whether the policy will be applied to matching devices.", + "example": true, + "type": "boolean" + }, + "exclude": { "$ref": "#/components/schemas/components-schemas-exclude" }, + "exclude_office_ips": { "$ref": "#/components/schemas/exclude_office_ips" }, + "fallback_domains": { "$ref": "#/components/schemas/fallback_domains" }, + "gateway_unique_id": { "$ref": "#/components/schemas/gateway_unique_id" }, + "include": { "$ref": "#/components/schemas/schemas-include" }, + "match": { "$ref": "#/components/schemas/components-schemas-match" }, + "name": { + "description": "The name of the device settings policy.", + "example": "Allow Developers", + "maxLength": 100, + "type": "string" + }, + "policy_id": { "$ref": "#/components/schemas/uuid-s0SXln0q" }, + "precedence": { "$ref": "#/components/schemas/schemas-precedence" }, + "service_mode_v2": { "$ref": "#/components/schemas/service_mode_v2" }, + "support_url": { "$ref": "#/components/schemas/support_url" }, + "switch_locked": { "$ref": "#/components/schemas/switch_locked" } + }, + "type": "object" + }, + "device_settings_policy-ZinBC9X3": { + "properties": { + "allow_mode_switch": { "$ref": "#/components/schemas/allow_mode_switch" }, + "allow_updates": { "$ref": "#/components/schemas/allow_updates" }, + "allowed_to_leave": { "$ref": "#/components/schemas/allowed_to_leave" }, + "auto_connect": { "$ref": "#/components/schemas/auto_connect" }, + "captive_portal": { "$ref": "#/components/schemas/captive_portal" }, + "default": { "$ref": "#/components/schemas/default-VASQNGRU" }, + "description": { "$ref": "#/components/schemas/schemas-description-jdg4o19i" }, + "disable_auto_fallback": { "$ref": "#/components/schemas/disable_auto_fallback" }, + "enabled": { + "description": "Whether the policy will be applied to matching devices.", + "example": true, + "type": "boolean" + }, + "exclude": { "$ref": "#/components/schemas/exclude-tYW3UmZW" }, + "exclude_office_ips": { "$ref": "#/components/schemas/exclude_office_ips" }, + "fallback_domains": { "$ref": "#/components/schemas/fallback_domains" }, + "gateway_unique_id": { "$ref": "#/components/schemas/gateway_unique_id" }, + "include": { "$ref": "#/components/schemas/include-9GPmbbUN" }, + "match": { "$ref": "#/components/schemas/schemas-match-ImQchlrH" }, + "name": { + "description": "The name of the device settings policy.", + "example": "Allow Developers", + "maxLength": 100, + "type": "string" + }, + "policy_id": { "$ref": "#/components/schemas/schemas-uuid-lt6l49Ob" }, + "precedence": { "$ref": "#/components/schemas/precedence-HZLvpi3q" }, + "service_mode_v2": { "$ref": "#/components/schemas/service_mode_v2" }, + "support_url": { "$ref": "#/components/schemas/support_url" }, + "switch_locked": { "$ref": "#/components/schemas/switch_locked" } + }, + "type": "object" + }, + "device_settings_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "$ref": "#/components/schemas/device_settings_policy-ZinBC9X3" } } } + ] + }, + "device_settings_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/device_settings_policy-ZinBC9X3" }, "type": "array" } + } + } + ] + }, + "devices": { + "properties": { + "created": { "$ref": "#/components/schemas/schemas-created" }, + "deleted": { "$ref": "#/components/schemas/schemas-deleted" }, + "device_type": { "$ref": "#/components/schemas/platform" }, + "id": { "$ref": "#/components/schemas/devices_components-schemas-uuid" }, + "ip": { "$ref": "#/components/schemas/components-schemas-ip" }, + "key": { "$ref": "#/components/schemas/schemas-key" }, + "last_seen": { "$ref": "#/components/schemas/last_seen" }, + "mac_address": { "$ref": "#/components/schemas/mac_address" }, + "manufacturer": { "$ref": "#/components/schemas/manufacturer" }, + "model": { "$ref": "#/components/schemas/model" }, + "name": { "$ref": "#/components/schemas/devices_components-schemas-name" }, + "os_distro_name": { "$ref": "#/components/schemas/os_distro_name" }, + "os_distro_revision": { "$ref": "#/components/schemas/os_distro_revision" }, + "os_version": { "$ref": "#/components/schemas/os_version" }, + "revoked_at": { "$ref": "#/components/schemas/revoked_at" }, + "serial_number": { "$ref": "#/components/schemas/components-schemas-serial_number-AUVcZzty" }, + "updated": { "$ref": "#/components/schemas/updated" }, + "user": { "$ref": "#/components/schemas/user" }, + "version": { "$ref": "#/components/schemas/devices_components-schemas-version" } + }, + "type": "object" + }, + "devices-NWwWHmPO": { + "properties": { + "created": { "$ref": "#/components/schemas/created-lduEKfk7" }, + "deleted": { "$ref": "#/components/schemas/deleted-gN7SICJB" }, + "device_type": { "$ref": "#/components/schemas/platform" }, + "id": { "$ref": "#/components/schemas/schemas-uuid-lt6l49Ob" }, + "ip": { "$ref": "#/components/schemas/ip-idMl3BYW" }, + "key": { "$ref": "#/components/schemas/key-sOXCdDRQ" }, + "last_seen": { "$ref": "#/components/schemas/last_seen" }, + "mac_address": { "$ref": "#/components/schemas/mac_address" }, + "manufacturer": { "$ref": "#/components/schemas/manufacturer" }, + "model": { "$ref": "#/components/schemas/model" }, + "name": { "$ref": "#/components/schemas/schemas-name-1UDkXCXq" }, + "os_distro_name": { "$ref": "#/components/schemas/os_distro_name" }, + "os_distro_revision": { "$ref": "#/components/schemas/os_distro_revision" }, + "os_version": { "$ref": "#/components/schemas/os_version" }, + "revoked_at": { "$ref": "#/components/schemas/revoked_at" }, + "serial_number": { "$ref": "#/components/schemas/serial_number-8kzQvaWX" }, + "updated": { "$ref": "#/components/schemas/updated" }, + "user": { "$ref": "#/components/schemas/user-L6j8gcON" }, + "version": { "$ref": "#/components/schemas/version-SGF9qNGE" } + }, + "type": "object" + }, + "devices_components-schemas-description": { + "description": "A description of the policy.", + "example": "Policy for test teams.", + "maxLength": 500, + "type": "string" + }, + "devices_components-schemas-identifier": { "example": "699d98642c564d2e855e9661899b7252" }, + "devices_components-schemas-name": { + "description": "The device name.", + "example": "My mobile device", + "type": "string" + }, + "devices_components-schemas-uuid": { + "description": "Device ID.", + "example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", + "maxLength": 36, + "type": "string" + }, + "devices_components-schemas-version": { + "description": "The WARP client version.", + "example": "1.0.0", + "type": "string" + }, + "devices_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/devices-NWwWHmPO" }, "type": "array" } + } + } + ] + }, + "dex-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection-common" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/device-dex-test-schemas-http" }, "type": "array" } + } + } + ] + }, + "dex-single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/device-dex-test-schemas-http" } } } + ] + }, + "digest": { + "description": "Digest hash.", + "example": "48E939042E82C22542CB377B580DFDC52A361CEFDC72E7F9107E2B6BD9306A45", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "digest_algorithm": { + "description": "Type of digest algorithm.", + "example": "SHA256", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "digest_type": { + "description": "Coded type for digest algorithm.", + "example": "2", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "dimensions": { + "description": "A comma-separated list of dimensions to group results by.", + "example": "queryType", + "type": "string" + }, + "dimensions-ICwErPf5": { + "description": "Can be used to break down the data by given attributes. Options are: \n\nDimension | Name | Example\n--------------------------|---------------------------------|--------------------------\nevent | Connection Event | connect, progress, disconnect, originError, clientFiltered\nappID | Application ID | 40d67c87c6cd4b889a4fd57805225e85\ncoloName | Colo Name | SFO\nipVersion | IP version used by the client | 4, 6.", + "example": ["event", "appID"], + "items": { "enum": ["event", "appID", "coloName", "ipVersion"], "type": "string" }, + "type": "array" + }, + "direct_upload_request": { + "properties": { + "allowedOrigins": { "$ref": "#/components/schemas/allowedOrigins" }, + "creator": { "$ref": "#/components/schemas/creator" }, + "expiry": { + "default": "Now + 30 minutes", + "description": "The date and time after upload when videos will not be accepted.", + "example": "2021-01-02T02:20:00Z", + "format": "date-time", + "type": "string" + }, + "maxDurationSeconds": { "$ref": "#/components/schemas/maxDurationSeconds" }, + "requireSignedURLs": { "$ref": "#/components/schemas/requireSignedURLs-9DKWYMwu" }, + "thumbnailTimestampPct": { "$ref": "#/components/schemas/thumbnailTimestampPct" }, + "watermark": { "$ref": "#/components/schemas/watermark_at_upload" } + }, + "required": ["maxDurationSeconds"], + "type": "object" + }, + "direct_upload_request_v2": { + "properties": { + "expiry": { + "default": "Now + 30 minutes", + "description": "The date after which the upload will not be accepted. Minimum: Now + 2 minutes. Maximum: Now + 6 hours.", + "example": "2021-01-02T02:20:00Z", + "format": "date-time", + "type": "string" + }, + "id": { + "description": "Optional Image Custom ID. Up to 1024 chars. Can include any number of subpaths, and utf8 characters. Cannot start nor end with a / (forward slash). Cannot be a UUID.", + "example": "this/is/my-customid", + "maxLength": 1024, + "readOnly": true, + "type": "string" + }, + "metadata": { + "description": "User modifiable key-value store. Can be used for keeping references to another system of record, for managing images.", + "type": "object" + }, + "requireSignedURLs": { + "default": false, + "description": "Indicates whether the image requires a signature token to be accessed.", + "example": true, + "type": "boolean" + } + }, + "type": "object" + }, + "direct_upload_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "uid": { "$ref": "#/components/schemas/identifier-XSj9HnWY" }, + "uploadURL": { + "description": "The URL an unauthenticated upload can use for a single `HTTP POST multipart/form-data` request.", + "example": "www.example.com/samplepath", + "type": "string" + }, + "watermark": { "$ref": "#/components/schemas/watermarks" } + } + } + } + } + ] + }, + "direct_upload_response_v2": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "id": { + "description": "Image unique identifier.", + "example": "e22e9e6b-c02b-42fd-c405-6c32af5fe600", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "uploadURL": { + "description": "The URL the unauthenticated upload can be performed to using a single HTTP POST (multipart/form-data) request.", + "example": "https://upload.imagedelivery.net/FxUufywByo0m2v3xhKSiU8/e22e9e6b-c02b-42fd-c405-6c32af5fe600", + "type": "string" + } + } + } + } + } + ] + }, + "disable_auto_fallback": { + "description": "If the dns_server field of a fallback domain is not present, the client will fall back to a best guess of the default/system DNS resolvers, unless this policy option is set.", + "example": true, + "type": "boolean" + }, + "disable_for_time": { + "properties": { + "1": { "description": "Override code that is valid for 1 hour.", "example": "9106681" }, + "12": { "description": "Override code that is valid for 12 hour2.", "example": "3424359" }, + "24": { "description": "Override code that is valid for 24 hour.2.", "example": "2887634" }, + "3": { "description": "Override code that is valid for 3 hours.", "example": "5356247" }, + "6": { "description": "Override code that is valid for 6 hours.", "example": "9478972" } + }, + "type": "object" + }, + "disable_session_renewal": { + "default": false, + "description": "Only available for the Waiting Room Advanced subscription. Disables automatic renewal of session cookies. If `true`, an accepted user will have session_duration minutes to browse the site. After that, they will have to go through the waiting room again. If `false`, a user's session cookie will be automatically renewed on every request.", + "example": false, + "type": "boolean" + }, + "disable_transfer_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/disable_transfer_result" } } } + ] + }, + "disable_transfer_result": { + "description": "The zone transfer status of a primary zone", + "example": "Disabled", + "type": "string" + }, + "disabled": { + "description": "When true, indicates that the rate limit is currently disabled.", + "example": false, + "type": "boolean" + }, + "disabled_at": { + "description": "This field shows up only if the origin is disabled. This field is set with the time the origin was disabled.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "display_name": { "description": "Alert type name.", "example": "Origin Error Rate Alert", "type": "string" }, + "dlq_name": { "example": "example-dlq", "type": "string" }, + "dns": { + "description": "The name and type of DNS record for the Spectrum application.", + "properties": { + "name": { "$ref": "#/components/schemas/dns_name" }, + "type": { "$ref": "#/components/schemas/dns_type" } + }, + "type": "object" + }, + "dns-firewall": { + "properties": { + "attack_mitigation": { "$ref": "#/components/schemas/attack_mitigation" }, + "deprecate_any_requests": { "$ref": "#/components/schemas/deprecate_any_requests" }, + "dns_firewall_ips": { "$ref": "#/components/schemas/dns_firewall_ips" }, + "ecs_fallback": { "$ref": "#/components/schemas/ecs_fallback" }, + "id": { "$ref": "#/components/schemas/identifier-b3jdvVAb" }, + "maximum_cache_ttl": { "$ref": "#/components/schemas/maximum_cache_ttl" }, + "minimum_cache_ttl": { "$ref": "#/components/schemas/minimum_cache_ttl" }, + "modified_on": { "$ref": "#/components/schemas/modified_on-uPCC7iXw" }, + "name": { "$ref": "#/components/schemas/name-SScjQrIN" }, + "negative_cache_ttl": { "$ref": "#/components/schemas/negative_cache_ttl" }, + "origin_ips": { "$ref": "#/components/schemas/origin_ips" }, + "ratelimit": { "$ref": "#/components/schemas/ratelimit" }, + "retries": { "$ref": "#/components/schemas/retries-w39sVXcQ" } + }, + "required": [ + "id", + "name", + "origin_ips", + "dns_firewall_ips", + "minimum_cache_ttl", + "maximum_cache_ttl", + "deprecate_any_requests", + "ecs_fallback", + "modified_on" + ], + "type": "object" + }, + "dns-record": { + "oneOf": [ + { "$ref": "#/components/schemas/ARecord" }, + { "$ref": "#/components/schemas/AAAARecord" }, + { "$ref": "#/components/schemas/CAARecord" }, + { "$ref": "#/components/schemas/CERTRecord" }, + { "$ref": "#/components/schemas/CNAMERecord" }, + { "$ref": "#/components/schemas/DNSKEYRecord" }, + { "$ref": "#/components/schemas/DSRecord" }, + { "$ref": "#/components/schemas/HTTPSRecord" }, + { "$ref": "#/components/schemas/LOCRecord" }, + { "$ref": "#/components/schemas/MXRecord" }, + { "$ref": "#/components/schemas/NAPTRRecord" }, + { "$ref": "#/components/schemas/NSRecord" }, + { "$ref": "#/components/schemas/PTRRecord" }, + { "$ref": "#/components/schemas/SMIMEARecord" }, + { "$ref": "#/components/schemas/SRVRecord" }, + { "$ref": "#/components/schemas/SSHFPRecord" }, + { "$ref": "#/components/schemas/SVCBRecord" }, + { "$ref": "#/components/schemas/TLSARecord" }, + { "$ref": "#/components/schemas/TXTRecord" }, + { "$ref": "#/components/schemas/URIRecord" } + ], + "required": ["id", "type", "name", "content", "proxiable", "locked", "zone_name", "created_on", "modified_on"], + "type": "object" + }, + "dns-record-c3EG7MiH": { + "description": "List of records needed to enable an Email Routing zone.", + "properties": { + "content": { "description": "DNS record content.", "example": "route1.mx.cloudflare.net", "type": "string" }, + "name": { + "description": "DNS record name (or @ for the zone apex).", + "example": "example.com", + "maxLength": 255, + "type": "string" + }, + "priority": { + "description": "Required for MX, SRV and URI records. Unused by other record types. Records with lower priorities are preferred.", + "example": 12, + "maximum": 65535, + "minimum": 0, + "type": "number" + }, + "ttl": { + "anyOf": [ + { "example": 3600, "maximum": 86400, "minimum": 1, "type": "number" }, + { "enum": [1], "type": "number" } + ], + "description": "Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1 for 'automatic'.", + "example": 1, + "type": "number" + }, + "type": { + "description": "DNS record type.", + "enum": [ + "A", + "AAAA", + "CNAME", + "HTTPS", + "TXT", + "SRV", + "LOC", + "MX", + "NS", + "CERT", + "DNSKEY", + "DS", + "NAPTR", + "SMIMEA", + "SSHFP", + "SVCB", + "TLSA", + "URI" + ], + "example": "NS", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "dns-secondary-secondary-zone": { + "properties": { + "auto_refresh_seconds": { "$ref": "#/components/schemas/auto_refresh_seconds" }, + "id": { "$ref": "#/components/schemas/identifier-ahBjrSIO" }, + "name": { "$ref": "#/components/schemas/name-YGUm4gr7" }, + "peers": { "$ref": "#/components/schemas/peers" } + }, + "required": ["id", "name", "peers", "auto_refresh_seconds"], + "type": "object" + }, + "dns-settings_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/dns-record-c3EG7MiH" }, "type": "array" } + } + } + ] + }, + "dns_firewall_ips": { + "example": ["203.0.113.1", "203.0.113.254", "2001:DB8:AB::CF", "2001:DB8:CD::CF"], + "items": { + "anyOf": [ + { + "description": "Origin DNS Server IPv4 Address.", + "example": "203.0.113.1", + "format": "ipv4", + "type": "string" + }, + { + "description": "Origin DNS Server IPv6 Address.", + "example": "2001:DB8:ab::CF", + "format": "ipv6", + "type": "string" + } + ] + }, + "type": "array" + }, + "dns_firewall_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/dns-firewall" }, "type": "array" } } } + ] + }, + "dns_firewall_single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/dns-firewall" } } } + ] + }, + "dns_name": { + "description": "The name of the DNS record associated with the application.", + "example": "ssh.example.com", + "format": "hostname", + "type": "string" + }, + "dns_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { "result": { "items": { "$ref": "#/components/schemas/dns-record" }, "type": "array" } }, + "type": "object" + } + ] + }, + "dns_response_import_scan": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "recs_added": { "description": "Number of DNS records added.", "example": 5, "type": "number" }, + "total_records_parsed": { + "description": "Total number of DNS records parsed.", + "example": 5, + "type": "number" + } + }, + "type": "object" + }, + "timing": { + "properties": { + "end_time": { + "description": "When the file parsing ended.", + "example": "2014-03-01T12:20:01Z", + "format": "date-time", + "type": "string" + }, + "process_time": { + "description": "Processing time of the file in seconds.", + "example": 1, + "type": "number" + }, + "start_time": { + "description": "When the file parsing started.", + "example": "2014-03-01T12:20:00Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "dns_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/dns-record" } }, "type": "object" } + ] + }, + "dns_ttl": { + "description": "The TTL of our resolution of your DNS record in seconds.", + "minimum": 600, + "type": "integer" + }, + "dns_type": { + "description": "The type of DNS record associated with the application.", + "enum": ["CNAME", "ADDRESS"], + "example": "CNAME", + "type": "string" + }, + "dnslink": { + "description": "DNSLink value used if the target is ipfs.", + "example": "/ipns/onboarding.ipfs.cloudflare.com", + "type": "string" + }, + "dnssec": { + "properties": { + "algorithm": { "$ref": "#/components/schemas/algorithm" }, + "digest": { "$ref": "#/components/schemas/digest" }, + "digest_algorithm": { "$ref": "#/components/schemas/digest_algorithm" }, + "digest_type": { "$ref": "#/components/schemas/digest_type" }, + "ds": { "$ref": "#/components/schemas/ds" }, + "flags": { "$ref": "#/components/schemas/flags" }, + "key_tag": { "$ref": "#/components/schemas/key_tag" }, + "key_type": { "$ref": "#/components/schemas/key_type" }, + "modified_on": { "$ref": "#/components/schemas/modified_on-JpSxLOr6" }, + "public_key": { "$ref": "#/components/schemas/public_key" }, + "status": { "$ref": "#/components/schemas/status-2mOK9Pc7" } + }, + "type": "object" + }, + "dnssec_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/dnssec" } } } + ] + }, + "domain": { + "description": "The domain and path that Access will secure.", + "example": "test.example.com/admin", + "type": "string" + }, + "domain-UjOhLqjI": { + "properties": { + "environment": { "$ref": "#/components/schemas/environment" }, + "hostname": { "$ref": "#/components/schemas/components-schemas-hostname" }, + "id": { "$ref": "#/components/schemas/domain_identifier" }, + "service": { "$ref": "#/components/schemas/schemas-service" }, + "zone_id": { "$ref": "#/components/schemas/zone_identifier" }, + "zone_name": { "$ref": "#/components/schemas/zone_name" } + }, + "type": "object" + }, + "domain-history": { + "properties": { + "categorizations": { + "items": { + "properties": { + "categories": { "example": [{ "id": 155, "name": "Technology" }] }, + "end": { "example": "2021-04-30", "format": "date", "type": "string" }, + "start": { "example": "2021-04-01", "format": "date", "type": "string" } + }, + "type": "object" + }, + "type": "array" + }, + "domain": { "$ref": "#/components/schemas/schemas-domain_name" } + } + }, + "domain-response-collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { + "properties": { + "result_info": { + "properties": { + "count": { "example": 1 }, + "page": { "example": 1 }, + "per_page": { "example": 100 }, + "total_count": { "example": 1 } + }, + "type": "object" + } + } + }, + { "properties": { "result": { "items": { "type": "object" }, "type": "array" } } } + ] + }, + "domain-response-collection-7KXX2Ghb": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/domain-UjOhLqjI" }, "type": "array" } + }, + "type": "object" + } + ] + }, + "domain-response-single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } } } + ] + }, + "domain-response-single-0j5uvVNJ": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { "properties": { "result": { "$ref": "#/components/schemas/domain-UjOhLqjI" } }, "type": "object" } + ] + }, + "domain_components-schemas-domain": { + "properties": { + "additional_information": { "$ref": "#/components/schemas/additional_information" }, + "application": { "$ref": "#/components/schemas/application-WiomAg5h" }, + "content_categories": { "$ref": "#/components/schemas/content_categories" }, + "domain": { "$ref": "#/components/schemas/schemas-domain_name" }, + "popularity_rank": { "$ref": "#/components/schemas/popularity_rank" }, + "resolves_to_refs": { "$ref": "#/components/schemas/resolves_to_refs" }, + "risk_score": { "$ref": "#/components/schemas/risk_score" }, + "risk_types": { "$ref": "#/components/schemas/risk_types" } + } + }, + "domain_components-schemas-single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/domain_components-schemas-domain" } } } + ] + }, + "domain_identifier": { + "description": "Identifer of the Worker Domain.", + "example": "dbe10b4bc17c295377eabd600e1787fd" + }, + "domain_name": { + "description": "Name of the domain.", + "example": "this-is-my-domain-01.com", + "pattern": "^[a-z0-9][a-z0-9-]*$", + "type": "string" + }, + "domain_name-lovco9gj": { "description": "Domain name.", "example": "cloudflare.com", "type": "string" }, + "domain_names": { + "description": "List of domain names.", + "example": ["cloudflare.com", "cloudflare.net"], + "items": { "type": "string" }, + "type": "array" + }, + "domain_properties": { + "properties": { + "available": { "$ref": "#/components/schemas/schemas-available" }, + "can_register": { "$ref": "#/components/schemas/can_register" }, + "created_at": { "$ref": "#/components/schemas/components-schemas-created_at" }, + "current_registrar": { "$ref": "#/components/schemas/current_registrar" }, + "expires_at": { "$ref": "#/components/schemas/expires_at" }, + "id": { "$ref": "#/components/schemas/schemas-domain_identifier" }, + "locked": { "$ref": "#/components/schemas/locked" }, + "registrant_contact": { "$ref": "#/components/schemas/registrant_contact" }, + "registry_statuses": { "$ref": "#/components/schemas/registry_statuses" }, + "supported_tld": { "$ref": "#/components/schemas/supported_tld" }, + "transfer_in": { "$ref": "#/components/schemas/transfer_in" }, + "updated_at": { "$ref": "#/components/schemas/components-schemas-updated_at" } + }, + "type": "object" + }, + "domain_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/domains" }, "type": "array" } } } + ] + }, + "domain_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } } } + ] + }, + "domain_rule": { + "description": "Match an entire email domain.", + "properties": { + "email_domain": { + "properties": { + "domain": { "description": "The email domain to match.", "example": "example.com", "type": "string" } + }, + "required": ["domain"], + "type": "object" + } + }, + "required": ["email_domain"], + "title": "Email domain", + "type": "object" + }, + "domain_update_properties": { + "properties": { + "auto_renew": { "$ref": "#/components/schemas/auto_renew" }, + "locked": { "$ref": "#/components/schemas/locked" }, + "name_servers": { "$ref": "#/components/schemas/name_servers" }, + "privacy": { "$ref": "#/components/schemas/privacy" } + }, + "type": "object" + }, + "domains": { "allOf": [{ "$ref": "#/components/schemas/domain_properties" }], "type": "object" }, + "domains-post": { "example": { "name": "example.com" } }, + "downloadedFrom": { + "description": "The source URL for a downloaded image. If the watermark profile was created via direct upload, this field is null.", + "example": "https://company.com/logo.png", + "readOnly": true, + "type": "string" + }, + "downloads_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } } } + ] + }, + "ds": { + "description": "Full DS record.", + "example": "example.com. 3600 IN DS 16953 13 2 48E939042E82C22542CB377B580DFDC52A361CEFDC72E7F9107E2B6BD9306A45", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "duration": { "description": "The duration of the plan subscription.", "example": 1, "type": "number" }, + "duration-nfHavjWr": { + "description": "The duration of the video in seconds. A value of `-1` means the duration is unknown. The duration becomes available after the upload and before the video is ready.", + "readOnly": true, + "type": "integer" + }, + "dynamic-redirect-rules_components-schemas-rule": { + "properties": { + "action": { "example": "redirect" }, + "action_parameters": { "$ref": "#/components/schemas/components-schemas-action_parameters" }, + "description": { "example": "Blog redirect" }, + "expression": { "example": "http.request.uri.path == \"/blog\"" }, + "id": { "example": "3a03d665bac047339bb530ecb439a90d" }, + "version": { "example": "1" } + } + }, + "early_hints": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { "description": "ID of the zone setting.", "enum": ["early_hints"], "example": "early_hints" }, + "value": { "$ref": "#/components/schemas/early_hints_value" } + } + } + ], + "description": "When enabled, Cloudflare will attempt to speed up overall page loads by serving `103` responses with `Link` headers from the final response. Refer to [Early Hints](https://developers.cloudflare.com/cache/about/early-hints) for more information.", + "title": "Early Hints" + }, + "early_hints_value": { + "default": "off", + "description": "Value of the zone setting.", + "enum": ["on", "off"], + "type": "string" + }, + "ecs-support": { + "description": "Set if the location needs to resolve EDNS queries.", + "example": false, + "type": "boolean" + }, + "ecs_fallback": { + "description": "Forward client IP (resolver) subnet if no EDNS Client Subnet is sent.", + "example": false, + "type": "boolean" + }, + "edge_cache_ttl": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { + "description": "ID of the zone setting.", + "enum": ["edge_cache_ttl"], + "example": "edge_cache_ttl" + }, + "value": { "$ref": "#/components/schemas/edge_cache_ttl_value" } + } + } + ], + "description": "Time (in seconds) that a resource will be ensured to remain on Cloudflare's cache servers.", + "title": "Edge Cache TTL" + }, + "edge_cache_ttl_value": { + "default": 7200, + "description": "Value of the zone setting.\nNotes: The minimum TTL available depends on the plan level of the zone. (Enterprise = 30, Business = 1800, Pro = 3600, Free = 7200)", + "enum": [ + 30, 60, 300, 1200, 1800, 3600, 7200, 10800, 14400, 18000, 28800, 43200, 57600, 72000, 86400, 172800, 259200, + 345600, 432000, 518400, 604800 + ], + "type": "number" + }, + "edge_ips": { + "default": { "connectivity": "all", "type": "dynamic" }, + "description": "The anycast edge IP configuration for the hostname of this application.", + "oneOf": [ + { + "properties": { + "connectivity": { + "description": "The IP versions supported for inbound connections on Spectrum anycast IPs.", + "enum": ["all", "ipv4", "ipv6"], + "example": "all", + "type": "string" + }, + "type": { + "description": "The type of edge IP configuration specified. Dynamically allocated edge IPs use Spectrum anycast IPs in accordance with the connectivity you specify. Only valid with CNAME DNS names.", + "enum": ["dynamic"], + "example": "dynamic", + "type": "string" + } + }, + "type": "object" + }, + { + "properties": { + "ips": { + "description": "The array of customer owned IPs we broadcast via anycast for this hostname and application.", + "example": ["192.0.2.1"], + "items": { "description": "Edge anycast IPs.", "example": "192.0.2.1", "type": "string" }, + "type": "array" + }, + "type": { + "description": "The type of edge IP configuration specified. Statically allocated edge IPs use customer IPs in accordance with the ips array you specify. Only valid with ADDRESS DNS names.", + "enum": ["static"], + "example": "static", + "type": "string" + } + }, + "type": "object" + } + ] + }, + "editable": { + "default": true, + "description": "Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).", + "enum": [true, false], + "readOnly": true, + "type": "boolean" + }, + "effect": { + "description": "Allow or deny operations against the resources.", + "enum": ["allow", "deny"], + "example": "allow", + "type": "string" + }, + "egs-pagination": { + "properties": { + "page": { + "default": 1, + "description": "The page number of paginated results.", + "minimum": 1, + "type": "number" + }, + "per_page": { + "default": 20, + "description": "The maximum number of results per page. You can only set the value to `1` or to a multiple of 5 such as `5`, `10`, `15`, or `20`.", + "maximum": 1000, + "minimum": 1, + "type": "number" + } + }, + "type": "object" + }, + "either_profile_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "anyOf": [ + { "$ref": "#/components/schemas/predefined_profile" }, + { "$ref": "#/components/schemas/custom_profile" }, + { "$ref": "#/components/schemas/integration_profile" } + ] + } + } + } + ] + }, + "either_profile_response-G4QJIAYV": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "anyOf": [ + { "$ref": "#/components/schemas/predefined_profile" }, + { "$ref": "#/components/schemas/custom_profile" } + ] + } + } + } + ] + }, + "eligibility": { + "properties": { + "eligible": { "$ref": "#/components/schemas/eligible" }, + "ready": { "$ref": "#/components/schemas/ready" }, + "type": { "$ref": "#/components/schemas/eligibility_components-schemas-type" } + }, + "type": "object" + }, + "eligibility_components-schemas-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "additionalProperties": { "items": { "$ref": "#/components/schemas/eligibility" }, "type": "array" }, + "example": { "email": { "eligible": true, "ready": true, "type": "email" } }, + "type": "object" + } + } + } + ] + }, + "eligibility_components-schemas-type": { + "description": "Determines type of delivery mechanism.", + "enum": ["email", "pagerduty", "webhook"], + "example": "email", + "type": "string" + }, + "eligible": { + "description": "Determines whether or not the account is eligible for the delivery mechanism.", + "example": true, + "type": "boolean" + }, + "email": { + "description": "The email address of the authenticating user.", + "example": "user@example.com", + "format": "email", + "type": "string" + }, + "email-rXr4fRvz": { + "description": "The contact email address of the user.", + "example": "user@example.com", + "maxLength": 90, + "type": "string" + }, + "email-sNyq81Xd": { + "description": "The contact email address of the user.", + "example": "user@example.com", + "maxLength": 90, + "type": "string" + }, + "email-setting_created": { + "description": "The date and time the settings have been created.", + "example": "2014-01-02T02:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "email-setting_enabled": { + "default": true, + "description": "State of the zone settings for Email Routing.", + "enum": [true, false], + "example": true, + "type": "boolean" + }, + "email-setting_identifier": { + "description": "Email Routing settings identifier.", + "example": "75610dab9e69410a82cf7e400a09ecec", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "email-setting_modified": { + "description": "The date and time the settings have been modified.", + "example": "2014-01-02T02:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "email-setting_name": { + "description": "Domain of your zone.", + "example": "example.net", + "readOnly": true, + "type": "string" + }, + "email-setting_skip-wizard": { + "default": true, + "description": "Flag to check if the user skipped the configuration wizard.", + "enum": [true, false], + "example": true, + "type": "boolean" + }, + "email-setting_status": { + "description": "Show the state of your account, and the type or configuration error.", + "enum": ["ready", "unconfigured", "misconfigured", "misconfigured/locked", "unlocked"], + "example": "ready", + "readOnly": true, + "type": "string" + }, + "email-settings_properties": { + "properties": { + "created": { "$ref": "#/components/schemas/email-setting_created" }, + "enabled": { "$ref": "#/components/schemas/email-setting_enabled" }, + "modified": { "$ref": "#/components/schemas/email-setting_modified" }, + "name": { "$ref": "#/components/schemas/email-setting_name" }, + "skip_wizard": { "$ref": "#/components/schemas/email-setting_skip-wizard" }, + "status": { "$ref": "#/components/schemas/email-setting_status" }, + "tag": { "$ref": "#/components/schemas/email-setting_identifier" } + }, + "type": "object" + }, + "email-settings_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/settings-2v3jrs7t" } } } + ] + }, + "email-xwlVNguu": { + "description": "The contact email address of the user.", + "example": "user@example.com", + "maxLength": 90, + "type": "string" + }, + "email_obfuscation": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { + "description": "ID of the zone setting.", + "enum": ["email_obfuscation"], + "example": "email_obfuscation" + }, + "value": { "$ref": "#/components/schemas/email_obfuscation_value" } + } + } + ], + "description": "Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016).", + "title": "Email Obfuscation" + }, + "email_obfuscation_value": { + "default": "on", + "description": "Value of the zone setting.", + "enum": ["on", "off"], + "type": "string" + }, + "email_rule": { + "description": "Matches a specific email.", + "properties": { + "email": { + "properties": { + "email": { + "description": "The email of the user.", + "example": "test@example.com", + "format": "email", + "type": "string" + } + }, + "required": ["email"], + "type": "object" + } + }, + "required": ["email"], + "title": "Email", + "type": "object" + }, + "empty_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } } } + ] + }, + "empty_response-47a5DGxM": { + "allOf": [ + { + "properties": { + "result": { "enum": [true, false], "example": true, "type": "boolean" }, + "success": { "enum": [true, false], "example": true, "type": "boolean" } + } + } + ] + }, + "empty_response-RrteGbXp": { + "allOf": [ + { + "properties": { + "result": { "enum": [true, false], "example": true, "type": "boolean" }, + "success": { "enum": [true, false], "example": true, "type": "boolean" } + } + } + ] + }, + "empty_response-V46LqGZw": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": {}, "maxItems": 0, "type": "array" } }, "type": "object" } + ] + }, + "enable_binding_cookie": { + "default": false, + "description": "Enables the binding cookie, which increases security against compromised authorization tokens and CSRF attacks.", + "type": "boolean" + }, + "enable_transfer_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/enable_transfer_result" } } } + ] + }, + "enable_transfer_result": { + "description": "The zone transfer status of a primary zone", + "example": "Enabled", + "type": "string" + }, + "enabled": { "description": "Set if the rule is enabled.", "example": true, "type": "boolean" }, + "enabled-A6pti18n": { + "description": "Flag that indicates if the job is enabled.", + "example": false, + "type": "boolean" + }, + "enabled-N6CliIvj": { + "description": "When true, indicates that Page Shield is enabled.", + "example": true, + "type": "boolean" + }, + "enabled-WoQtkwsn": { + "default": true, + "description": "Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).", + "example": false, + "type": "boolean" + }, + "enabled-i0fFiRwL": { + "default": false, + "description": "Whether the Address Map is enabled or not. Cloudflare's DNS will not respond with IP addresses on an Address Map until the map is enabled.", + "example": true, + "nullable": true, + "type": "boolean" + }, + "enabled-mOUbjYfQ": { + "description": "Whether or not the Keyless SSL is on or off.", + "example": false, + "readOnly": true, + "type": "boolean" + }, + "enabled-uhOFAV56": { + "description": "Whether or not the Keyless SSL is on or off.", + "example": false, + "readOnly": true, + "type": "boolean" + }, + "enabled_download_phase": { + "description": "Set to enable antivirus scan on downloads.", + "example": false, + "type": "boolean" + }, + "enabled_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "enabled": { + "$ref": "#/components/schemas/zone-authenticated-origin-pull_components-schemas-enabled" + } + } + } + } + } + ] + }, + "enabled_upload_phase": { + "description": "Set to enable antivirus scan on uploads.", + "example": false, + "type": "boolean" + }, + "enabled_write": { + "deprecated": true, + "description": "Whether or not the Keyless SSL is on or off.", + "example": false, + "name": "enabled", + "type": "boolean" + }, + "end": { + "anyOf": [{ "type": "string" }, { "type": "integer" }], + "description": "Sets the (exclusive) end of the requested time frame. This can be a unix timestamp (in seconds or nanoseconds), or an absolute timestamp that conforms to RFC 3339. `end` must be at least five minutes earlier than now and must be later than `start`. Difference between `start` and `end` must be not greater than one hour.", + "example": "2018-05-20T10:01:00Z" + }, + "end_time_seconds": { + "description": "Specifies the end time for the video clip in seconds.", + "readOnly": true, + "type": "integer" + }, + "endpoint": { + "description": "The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}, during insertion. This will further be Cloudflare-normalized upon insertion. See: https://developers.cloudflare.com/rules/normalization/how-it-works/.", + "example": "/api/v1/users/{var1}", + "format": "uri-template", + "maxLength": 4096, + "pattern": "^/.*$", + "type": "string" + }, + "entry_id": { + "allOf": [{ "$ref": "#/components/schemas/uuid-lbOWhPVX" }], + "description": "The ID for this entry", + "example": "719d1215-260f-41d0-8c32-eb320ad107f7" + }, + "entry_id-A2p6ZYit": { + "allOf": [{ "$ref": "#/components/schemas/uuid-s0SXln0q" }], + "description": "The ID for this entry", + "example": "719d1215-260f-41d0-8c32-eb320ad107f7" + }, + "environment": { + "description": "Worker environment associated with the zone and hostname.", + "example": "production", + "type": "string" + }, + "error": { + "description": "Errors resulting from collecting traceroute from colo to target.", + "enum": [ + "", + "Could not gather traceroute data: Code 1", + "Could not gather traceroute data: Code 2", + "Could not gather traceroute data: Code 3", + "Could not gather traceroute data: Code 4" + ], + "example": "", + "type": "string" + }, + "errorReasonCode": { + "description": "Specifies why the video failed to encode. This field is empty if the video is not in an `error` state. Preferred for programmatic use.", + "example": "ERR_NON_VIDEO", + "readOnly": true, + "type": "string" + }, + "errorReasonText": { + "description": "Specifies why the video failed to encode using a human readable error message in English. This field is empty if the video is not in an `error` state.", + "example": "The file was not recognized as a valid video file.", + "readOnly": true, + "type": "string" + }, + "error_message": { + "description": "If not null, the job is currently failing. Failures are usually repetitive (example: no permissions to write to destination bucket). Only the last failure is recorded. On successful execution of a job the error_message and last_error are set to null.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "estimated_queued_users": { "type": "integer" }, + "estimated_total_active_users": { "type": "integer" }, + "etag": { + "description": "Hashed script content, can be used in a If-None-Match header when updating.", + "example": "ea95132c15732412d22c1476fa83f27a", + "readOnly": true, + "type": "string" + }, + "etag-q3CF2kCS": { + "description": "A digest of the IP data. Useful for determining if the data has changed.", + "example": "a8e453d9d129a3769407127936edfdb0", + "type": "string" + }, + "event_custom_page_html": { + "description": "If set, the event will override the waiting room's `custom_page_html` property while it is active. If null, the event will inherit it.", + "example": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}", + "nullable": true, + "type": "string" + }, + "event_description": { + "default": "", + "description": "A note that you can use to add more details about the event.", + "example": "Production event - DO NOT MODIFY", + "type": "string" + }, + "event_details_custom_page_html": { + "example": "{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}", + "type": "string" + }, + "event_details_disable_session_renewal": { "example": false, "type": "boolean" }, + "event_details_new_users_per_minute": { "type": "integer" }, + "event_details_queueing_method": { "example": "random", "type": "string" }, + "event_details_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/event_details_result" } } } + ] + }, + "event_details_result": { + "properties": { + "created_on": { "$ref": "#/components/schemas/timestamp" }, + "custom_page_html": { "$ref": "#/components/schemas/event_details_custom_page_html" }, + "description": { "$ref": "#/components/schemas/event_description" }, + "disable_session_renewal": { "$ref": "#/components/schemas/event_details_disable_session_renewal" }, + "event_end_time": { "$ref": "#/components/schemas/event_end_time" }, + "event_start_time": { "$ref": "#/components/schemas/event_start_time" }, + "id": { "$ref": "#/components/schemas/event_id" }, + "modified_on": { "$ref": "#/components/schemas/timestamp" }, + "name": { "$ref": "#/components/schemas/event_name" }, + "new_users_per_minute": { "$ref": "#/components/schemas/event_details_new_users_per_minute" }, + "prequeue_start_time": { "$ref": "#/components/schemas/event_prequeue_start_time" }, + "queueing_method": { "$ref": "#/components/schemas/event_details_queueing_method" }, + "session_duration": { "$ref": "#/components/schemas/event_details_session_duration" }, + "shuffle_at_event_start": { "$ref": "#/components/schemas/event_shuffle_at_event_start" }, + "suspended": { "$ref": "#/components/schemas/event_suspended" }, + "total_active_users": { "$ref": "#/components/schemas/event_details_total_active_users" } + }, + "type": "object" + }, + "event_details_session_duration": { "type": "integer" }, + "event_details_total_active_users": { "type": "integer" }, + "event_disable_session_renewal": { + "description": "If set, the event will override the waiting room's `disable_session_renewal` property while it is active. If null, the event will inherit it.", + "nullable": true, + "type": "boolean" + }, + "event_end_time": { + "description": "An ISO 8601 timestamp that marks the end of the event.", + "example": "2021-09-28T17:00:00.000Z", + "type": "string" + }, + "event_id": { "example": "25756b2dfe6e378a06b033b670413757" }, + "event_id_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { "properties": { "id": { "$ref": "#/components/schemas/event_id" } }, "type": "object" } + } + } + ] + }, + "event_name": { + "description": "A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.", + "example": "production_webinar_event", + "type": "string" + }, + "event_new_users_per_minute": { + "description": "If set, the event will override the waiting room's `new_users_per_minute` property while it is active. If null, the event will inherit it. This can only be set if the event's `total_active_users` property is also set.", + "maximum": 2147483647, + "minimum": 200, + "nullable": true, + "type": "integer" + }, + "event_prequeue_start_time": { + "description": "An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before `event_start_time`.", + "example": "2021-09-28T15:00:00.000Z", + "nullable": true, + "type": "string" + }, + "event_queueing_method": { + "description": "If set, the event will override the waiting room's `queueing_method` property while it is active. If null, the event will inherit it.", + "example": "random", + "nullable": true, + "type": "string" + }, + "event_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/event_result" } } } + ] + }, + "event_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/event_result" }, "type": "array" } } } + ] + }, + "event_result": { + "properties": { + "created_on": { "$ref": "#/components/schemas/timestamp" }, + "custom_page_html": { "$ref": "#/components/schemas/event_custom_page_html" }, + "description": { "$ref": "#/components/schemas/event_description" }, + "disable_session_renewal": { "$ref": "#/components/schemas/event_disable_session_renewal" }, + "event_end_time": { "$ref": "#/components/schemas/event_end_time" }, + "event_start_time": { "$ref": "#/components/schemas/event_start_time" }, + "id": { "$ref": "#/components/schemas/event_id" }, + "modified_on": { "$ref": "#/components/schemas/timestamp" }, + "name": { "$ref": "#/components/schemas/event_name" }, + "new_users_per_minute": { "$ref": "#/components/schemas/event_new_users_per_minute" }, + "prequeue_start_time": { "$ref": "#/components/schemas/event_prequeue_start_time" }, + "queueing_method": { "$ref": "#/components/schemas/event_queueing_method" }, + "session_duration": { "$ref": "#/components/schemas/event_session_duration" }, + "shuffle_at_event_start": { "$ref": "#/components/schemas/event_shuffle_at_event_start" }, + "suspended": { "$ref": "#/components/schemas/event_suspended" }, + "total_active_users": { "$ref": "#/components/schemas/event_total_active_users" } + }, + "type": "object" + }, + "event_session_duration": { + "description": "If set, the event will override the waiting room's `session_duration` property while it is active. If null, the event will inherit it.", + "maximum": 30, + "minimum": 1, + "nullable": true, + "type": "integer" + }, + "event_shuffle_at_event_start": { + "default": false, + "description": "If enabled, users in the prequeue will be shuffled randomly at the `event_start_time`. Requires that `prequeue_start_time` is not null. This is useful for situations when many users will join the event prequeue at the same time and you want to shuffle them to ensure fairness. Naturally, it makes the most sense to enable this feature when the `queueing_method` during the event respects ordering such as **fifo**, or else the shuffling may be unnecessary.", + "type": "boolean" + }, + "event_start_time": { + "description": "An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. The start time must be at least one minute before `event_end_time`.", + "example": "2021-09-28T15:30:00.000Z", + "type": "string" + }, + "event_suspended": { + "default": false, + "description": "Suspends or allows an event. If set to `true`, the event is ignored and traffic will be handled based on the waiting room configuration.", + "type": "boolean" + }, + "event_total_active_users": { + "description": "If set, the event will override the waiting room's `total_active_users` property while it is active. If null, the event will inherit it. This can only be set if the event's `new_users_per_minute` property is also set.", + "maximum": 2147483647, + "minimum": 200, + "nullable": true, + "type": "integer" + }, + "everyone_rule": { + "description": "Matches everyone.", + "properties": { + "everyone": { "description": "An empty object which matches on all users.", "example": {}, "type": "object" } + }, + "required": ["everyone"], + "title": "Everyone", + "type": "object" + }, + "exclude": { + "description": "Rules evaluated with a NOT logical operator. To match a policy, a user cannot meet any of the Exclude rules.", + "items": { "$ref": "#/components/schemas/rule" }, + "type": "array" + }, + "exclude-TaQDb77a": { + "description": "Rules evaluated with a NOT logical operator. To match a policy, a user cannot meet any of the Exclude rules.", + "items": { "$ref": "#/components/schemas/rule_components-schemas-rule" }, + "type": "array" + }, + "exclude-tYW3UmZW": { "items": { "$ref": "#/components/schemas/split_tunnel" }, "type": "array" }, + "exclude_office_ips": { + "description": "Whether to add Microsoft IPs to split tunnel exclusions.", + "example": true, + "type": "boolean" + }, + "existed_at": { + "description": "If provided, include only tunnels that were created (and not deleted) before this time.", + "example": "2019-10-12T07:20:50.52Z", + "format": "date-time", + "type": "string" + }, + "expected_body": { + "description": "A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. This parameter is only valid for HTTP and HTTPS monitors.", + "example": "alive", + "type": "string" + }, + "expected_codes": { + "default": "200", + "description": "The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.", + "example": "2xx", + "type": "string" + }, + "expiration": { + "description": "The time, measured in number of seconds since the UNIX epoch, at which the key should expire.", + "example": 1578435000, + "type": "number" + }, + "expiration-9DsFtGHX": { + "description": "Sets the expiration time for a posture check result. If empty, the result remains valid until it is overwritten by new data from the WARP client.", + "example": "1h", + "type": "string" + }, + "expiration_ttl": { + "description": "The number of seconds for which the key should be visible before it expires. At least 60.", + "example": 300, + "type": "number" + }, + "expired_on": { + "description": "Date that the Client Certificate expires", + "example": "2033-02-20T23:18:00Z", + "readOnly": true, + "type": "string" + }, + "expires_at": { + "description": "Shows when domain name registration expires.", + "example": "2019-08-28T23:59:59Z", + "format": "date-time", + "type": "string" + }, + "expires_on": { + "description": "When the certificate from the authority expires.", + "example": "2016-01-01T05:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "expires_on-dkbMDCaD": { + "description": "The expiration time on or after which the JWT MUST NOT be accepted for processing.", + "example": "2020-01-01T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "expression": { + "description": "The filter expression. For more information, refer to [Expressions](https://developers.cloudflare.com/ruleset-engine/rules-language/expressions/).", + "example": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155", + "type": "string" + }, + "externally_managed": { + "default": false, + "description": "Indicates whether this plan is managed externally.", + "example": false, + "type": "boolean" + }, + "facebook": { + "allOf": [ + { "$ref": "#/components/schemas/identity-provider" }, + { "properties": { "config": { "$ref": "#/components/schemas/generic-oauth-config" } }, "type": "object" } + ], + "title": "Facebook", + "type": "object" + }, + "fail_closed": { + "description": "Block requests for files that cannot be scanned.", + "example": false, + "type": "boolean" + }, + "failed_login_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "items": { + "properties": { + "expiration": { "type": "integer" }, + "metadata": { + "example": { + "app_name": "Test App", + "aud": "39691c1480a2352a18ece567debc2b32552686cbd38eec0887aa18d5d3f00c04", + "datetime": "2022-02-02T21:54:34.914Z", + "ray_id": "6d76a8a42ead4133", + "user_email": "test@cloudflare.com", + "user_uuid": "57171132-e453-4ee8-b2a5-8cbaad333207" + }, + "type": "object" + } + }, + "type": "object" + }, + "type": "array" + } + } + } + ] + }, + "failure_reason": { + "description": "The current failure reason if status is unhealthy.", + "example": "", + "readOnly": true, + "type": "string" + }, + "fallback_domain": { + "properties": { + "description": { + "description": "A description of the fallback domain, displayed in the client UI.", + "example": "Domain bypass for local development", + "maxLength": 100, + "type": "string" + }, + "dns_server": { + "description": "A list of IP addresses to handle domain resolution.", + "items": {}, + "type": "array" + }, + "suffix": { + "description": "The domain suffix to match when resolving locally.", + "example": "example.com", + "type": "string" + } + }, + "required": ["suffix"], + "type": "object" + }, + "fallback_domain_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { "result": { "items": { "$ref": "#/components/schemas/fallback_domain" }, "type": "array" } } + } + ] + }, + "fallback_domains": { "items": { "$ref": "#/components/schemas/fallback_domain" }, "type": "array" }, + "fallback_origin_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } } } + ] + }, + "fallback_pool": { "description": "The pool ID to use when all other pools are detected as unhealthy." }, + "fax": { "description": "Contact fax number.", "example": "123-867-5309", "type": "string" }, + "feature_app_props": { + "properties": { + "allowed_idps": { "$ref": "#/components/schemas/allowed_idps" }, + "auto_redirect_to_identity": { "$ref": "#/components/schemas/schemas-auto_redirect_to_identity" }, + "domain": { "$ref": "#/components/schemas/domain" }, + "name": { "$ref": "#/components/schemas/apps_components-schemas-name" }, + "session_duration": { "$ref": "#/components/schemas/session_duration-itWcJrO0" }, + "type": { "$ref": "#/components/schemas/type-u7orNcta" } + }, + "required": ["type"], + "type": "object" + }, + "feature_app_props-g2VC0WUC": { + "properties": { + "allowed_idps": { "$ref": "#/components/schemas/allowed_idps" }, + "auto_redirect_to_identity": { "$ref": "#/components/schemas/auto_redirect_to_identity-zRTYoQOC" }, + "domain": { "$ref": "#/components/schemas/schemas-domain-N8byIUtr" }, + "name": { "$ref": "#/components/schemas/apps_components-schemas-name" }, + "session_duration": { "$ref": "#/components/schemas/session_duration-ZxG3i84k" }, + "type": { "$ref": "#/components/schemas/apps_components-schemas-type" } + }, + "type": "object" + }, + "features": { + "anyOf": [{ "$ref": "#/components/schemas/thresholds" }, { "$ref": "#/components/schemas/parameter_schemas" }], + "readOnly": true, + "type": "object" + }, + "fetched_at": { + "description": "The timestamp of when the script was last fetched.", + "nullable": true, + "type": "string" + }, + "fields": { + "description": "Comma-separated list of fields.", + "example": "ClientIP,ClientRequestHost,ClientRequestMethod,ClientRequestURI,EdgeEndTimestamp,EdgeResponseBytes,EdgeResponseStatus,EdgeStartTimestamp,RayID", + "type": "string" + }, + "fields_response": { "properties": { "key": { "example": "value", "type": "string" } }, "type": "object" }, + "filename": { + "description": "Image file name.", + "example": "logo.png", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "filter": { + "description": "Filters to drill down into specific events.", + "example": "{\"where\":{\"and\":[{\"key\":\"ClientCountry\",\"operator\":\"neq\",\"value\":\"ca\"}]}}", + "type": "string" + }, + "filter-delete-response-collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "items": { + "allOf": [ + { "$ref": "#/components/schemas/filter-k8oSIkrx" }, + { "required": ["id"], "type": "object" } + ] + }, + "type": "array" + } + }, + "type": "object" + } + ] + }, + "filter-delete-response-single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "allOf": [{ "$ref": "#/components/schemas/filter-k8oSIkrx" }, { "required": ["id"], "type": "object" }] + } + }, + "required": ["result"], + "type": "object" + } + ] + }, + "filter-k8oSIkrx": { + "additionalProperties": false, + "properties": { + "description": { "$ref": "#/components/schemas/filters_components-schemas-description" }, + "expression": { "$ref": "#/components/schemas/expression" }, + "id": { "$ref": "#/components/schemas/filters_components-schemas-id" }, + "paused": { "$ref": "#/components/schemas/filters_components-schemas-paused" }, + "ref": { "$ref": "#/components/schemas/schemas-ref" } + }, + "type": "object" + }, + "filter-no-id": { + "properties": { + "enabled": { "$ref": "#/components/schemas/filters_components-schemas-enabled" }, + "pattern": { "$ref": "#/components/schemas/schemas-pattern" } + }, + "required": ["pattern", "enabled"] + }, + "filter-response-collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/filters-TIm7UZqb" }, "type": "array" } + } + } + ] + }, + "filter-response-single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/filters-TIm7UZqb" } } } + ] + }, + "filter-rule-base": { + "properties": { + "action": { "$ref": "#/components/schemas/components-schemas-action" }, + "description": { "$ref": "#/components/schemas/firewall-rules_components-schemas-description" }, + "id": { "$ref": "#/components/schemas/firewall-rules_components-schemas-id" }, + "paused": { "$ref": "#/components/schemas/components-schemas-paused" }, + "priority": { "$ref": "#/components/schemas/firewall-rules_components-schemas-priority" }, + "products": { "$ref": "#/components/schemas/products" }, + "ref": { "$ref": "#/components/schemas/ref" } + }, + "type": "object" + }, + "filter-rule-response": { + "allOf": [ + { "$ref": "#/components/schemas/filter-rule-base" }, + { + "properties": { + "filter": { + "oneOf": [ + { "$ref": "#/components/schemas/filter-k8oSIkrx" }, + { "$ref": "#/components/schemas/deleted-filter" } + ] + } + } + } + ], + "type": "object" + }, + "filter-rules-response-collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "items": { + "allOf": [ + { "$ref": "#/components/schemas/filter-rule-response" }, + { "required": ["id", "filter", "action", "paused"], "type": "object" } + ] + }, + "type": "array" + } + }, + "required": ["result"], + "type": "object" + } + ] + }, + "filter-rules-response-collection-delete": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "items": { + "allOf": [ + { "$ref": "#/components/schemas/filter-rule-response" }, + { "required": ["id"], "type": "object" } + ] + }, + "type": "array" + } + }, + "required": ["result"], + "type": "object" + } + ] + }, + "filter-rules-single-response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "allOf": [ + { "$ref": "#/components/schemas/filter-rule-response" }, + { "required": ["id", "filter", "action", "paused"], "type": "object" } + ] + } + }, + "required": ["result"], + "type": "object" + } + ] + }, + "filter-rules-single-response-delete": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "allOf": [ + { "$ref": "#/components/schemas/filter-rule-response" }, + { "required": ["id"], "type": "object" } + ] + } + }, + "required": ["result"], + "type": "object" + } + ] + }, + "filter_options": { + "description": "Filter options for a particular resource type (pool or origin). Use null to reset.", + "nullable": true, + "properties": { + "disable": { + "default": false, + "description": "If set true, disable notifications for this type of resource (pool or origin).", + "type": "boolean" + }, + "healthy": { + "description": "If present, send notifications only for this health status (e.g. false for only DOWN events). Use null to reset (all events).", + "nullable": true, + "type": "boolean" + } + }, + "type": "object" + }, + "filters": { + "description": "The protocol or layer to evaluate the traffic, identity, and device posture expressions.", + "example": ["http"], + "items": { + "description": "The protocol or layer to use.", + "enum": ["http", "dns", "l4", "egress"], + "example": "http", + "type": "string" + }, + "type": "array" + }, + "filters-6K6BiPDe": { + "description": "Segmentation filter in 'attribute operator value' format.", + "example": "responseCode==NOERROR,queryType==A", + "type": "string" + }, + "filters-TIm7UZqb": { + "properties": { + "enabled": { "$ref": "#/components/schemas/filters_components-schemas-enabled" }, + "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" }, + "pattern": { "$ref": "#/components/schemas/schemas-pattern" } + }, + "required": ["id", "pattern", "enabled"], + "type": "object" + }, + "filters_components-schemas-description": { + "description": "An informative summary of the filter.", + "example": "Restrict access from these browsers on this address range.", + "maxLength": 500, + "type": "string" + }, + "filters_components-schemas-enabled": { + "example": true, + "title": "Whether or not this filter will run a script", + "type": "boolean" + }, + "filters_components-schemas-id": { + "description": "The unique identifier of the filter.", + "example": "372e67954025e0ba6aaa6d586b9e0b61", + "maxLength": 32, + "minLength": 32, + "readOnly": true, + "type": "string" + }, + "filters_components-schemas-paused": { + "description": "When true, indicates that the filter is currently paused.", + "example": false, + "type": "boolean" + }, + "fingerprint": { + "description": "The MD5 fingerprint of the certificate.", + "example": "MD5 Fingerprint=1E:80:0F:7A:FD:31:55:96:DE:D5:CB:E2:F0:91:F6:91", + "type": "string" + }, + "fingerprint_sha256": { + "description": "Unique identifier of the Client Certificate", + "example": "256c24690243359fb8cf139a125bd05ebf1d968b71e4caf330718e9f5c8a89ea", + "readOnly": true, + "type": "string" + }, + "fips-settings": { + "description": "FIPS settings.", + "properties": { + "tls": { + "description": "Enable only cipher suites and TLS versions compliant with FIPS 140-2.", + "example": true, + "type": "boolean" + } + }, + "type": "object" + }, + "firewall-rules_components-schemas-description": { + "description": "An informative summary of the firewall rule.", + "example": "Blocks traffic identified during investigation for MIR-31", + "maxLength": 500, + "type": "string" + }, + "firewall-rules_components-schemas-id": { + "description": "The unique identifier of the firewall rule.", + "example": "372e67954025e0ba6aaa6d586b9e0b60", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "firewall-rules_components-schemas-priority": { + "description": "The priority of the rule. Optional value used to define the processing order. A lower number indicates a higher priority. If not provided, rules with a defined priority will be processed before rules without a priority.", + "example": 50, + "maximum": 2147483647, + "minimum": 0, + "type": "number" + }, + "firewalluablock": { + "properties": { + "configuration": { "$ref": "#/components/schemas/components-schemas-configuration" }, + "description": { "$ref": "#/components/schemas/ua-rules_components-schemas-description" }, + "id": { "$ref": "#/components/schemas/ua-rules_components-schemas-id" }, + "mode": { "$ref": "#/components/schemas/ua-rules_components-schemas-mode" }, + "paused": { "$ref": "#/components/schemas/schemas-paused" } + } + }, + "firewalluablock_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { "result": { "items": { "$ref": "#/components/schemas/ua-rules" }, "type": "array" } }, + "type": "object" + } + ] + }, + "firewalluablock_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } }, "type": "object" } + ] + }, + "first_name": { + "description": "User's first name", + "example": "John", + "maxLength": 60, + "nullable": true, + "type": "string" + }, + "fit": { + "description": "The fit property describes how the width and height dimensions should be interpreted.", + "enum": ["scale-down", "contain", "cover", "crop", "pad"], + "example": "scale-down", + "type": "string" + }, + "flag": { "description": "The log retention flag for Logpull API.", "example": true, "type": "boolean" }, + "flag_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { "properties": { "flag": { "example": true, "type": "boolean" } }, "type": "object" } + } + } + ] + }, + "flags": { + "description": "Flag for DNSSEC record.", + "example": 257, + "nullable": true, + "readOnly": true, + "type": "number" + }, + "follow_redirects": { + "default": false, + "description": "Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.", + "example": true, + "type": "boolean" + }, + "force_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/force_result" } } } + ] + }, + "force_result": { + "description": "When force_axfr query parameter is set to true, the response is a simple string", + "example": "OK", + "type": "string" + }, + "frequency": { + "default": "high", + "description": "The frequency at which Cloudflare sends batches of logs to your destination. Setting frequency to high sends your logs in larger quantities of smaller files. Setting frequency to low sends logs in smaller quantities of larger files.", + "enum": ["high", "low"], + "example": "high", + "nullable": true, + "type": "string" + }, + "frequency-StdFMmw2": { + "description": "How often the subscription is renewed automatically.", + "enum": ["weekly", "monthly", "quarterly", "yearly"], + "example": "monthly", + "type": "string" + }, + "full_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "allOf": [ + { "$ref": "#/components/schemas/address-maps" }, + { + "properties": { + "ips": { "$ref": "#/components/schemas/schemas-ips" }, + "memberships": { "$ref": "#/components/schemas/memberships" } + }, + "type": "object" + } + ] + } + }, + "type": "object" + } + ] + }, + "full_response-VmfHZCxr": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "allOf": [ + { "$ref": "#/components/schemas/address-maps-ldXASIMl" }, + { + "properties": { + "ips": { "$ref": "#/components/schemas/ips-noQAIDso" }, + "memberships": { "$ref": "#/components/schemas/memberships" } + }, + "type": "object" + } + ] + } + }, + "type": "object" + } + ] + }, + "gateway-account-device-settings": { + "properties": { + "gateway_proxy_enabled": { + "description": "Enable gateway proxy filtering on TCP.", + "example": true, + "type": "boolean" + }, + "gateway_udp_proxy_enabled": { + "description": "Enable gateway proxy filtering on UDP.", + "example": true, + "type": "boolean" + } + }, + "type": "object" + }, + "gateway-account-device-settings-response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/gateway-account-device-settings" } } } + ], + "type": "object" + }, + "gateway-account-logging-settings": { + "properties": { + "redact_pii": { + "description": "Redact personally identifiable information from activity logging (PII fields are: source IP, user email, user ID, device ID, URL, referrer, user agent).", + "example": true, + "type": "boolean" + }, + "settings_by_rule_type": { + "description": "Logging settings by rule type.", + "properties": { + "dns": { "description": "Logging settings for DNS firewall.", "type": "object" }, + "http": { "description": "Logging settings for HTTP/HTTPS firewall.", "type": "object" }, + "l4": { "description": "Logging settings for Network firewall.", "type": "object" } + }, + "type": "object" + } + }, + "type": "object" + }, + "gateway-account-logging-settings-response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/gateway-account-logging-settings" } } } + ], + "type": "object" + }, + "gateway-account-settings": { + "description": "account settings.", + "properties": { + "settings": { + "description": "account settings.", + "properties": { + "activity_log": { "$ref": "#/components/schemas/activity-log-settings" }, + "antivirus": { "$ref": "#/components/schemas/anti-virus-settings" }, + "block_page": { "$ref": "#/components/schemas/block-page-settings" }, + "body_scanning": { "$ref": "#/components/schemas/body-scanning-settings" }, + "browser_isolation": { "$ref": "#/components/schemas/browser-isolation-settings" }, + "custom_certificate": { "$ref": "#/components/schemas/custom-certificate-settings" }, + "fips": { "$ref": "#/components/schemas/fips-settings" }, + "tls_decrypt": { "$ref": "#/components/schemas/tls-settings" } + }, + "type": "object" + } + }, + "type": "object" + }, + "gateway_account": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "gateway_tag": { "$ref": "#/components/schemas/gateway_tag" }, + "id": { "$ref": "#/components/schemas/cf_account_id" }, + "provider_name": { "$ref": "#/components/schemas/provider_name" } + }, + "type": "object" + } + } + } + ], + "type": "object" + }, + "gateway_account_config": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "allOf": [ + { "$ref": "#/components/schemas/gateway-account-settings" }, + { + "properties": { + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "updated_at": { "$ref": "#/components/schemas/timestamp" } + } + } + ], + "type": "object" + } + } + } + ], + "type": "object" + }, + "gateway_seat": { "description": "True if the seat is part of Gateway.", "example": false, "type": "boolean" }, + "gateway_tag": { + "description": "Gateway internal id.", + "example": "f174e90afafe4643bbbc4a0ed4fc8415", + "maxLength": 32, + "type": "string" + }, + "gateway_unique_id": { "example": "699d98642c564d2e855e9661899b7252", "type": "string" }, + "generic-oauth-config": { + "properties": { + "client_id": { + "description": "Your OAuth Client ID", + "example": "\u003cyour client id\u003e", + "type": "string" + }, + "client_secret": { + "description": "Your OAuth Client Secret", + "example": "\u003cyour client secret\u003e", + "type": "string" + } + }, + "type": "object" + }, + "geo_restrictions": { + "description": "Specify the region where your private key can be held locally for optimal TLS performance. HTTPS connections to any excluded data center will still be fully encrypted, but will incur some latency while Keyless SSL is used to complete the handshake with the nearest allowed data center. Options allow distribution to only to U.S. data centers, only to E.U. data centers, or only to highest security data centers. Default distribution is to all Cloudflare datacenters, for optimal performance.", + "properties": { "label": { "enum": ["us", "eu", "highest_security"], "example": "us" } }, + "type": "object" + }, + "get-zone-connection-response": { "allOf": [{ "$ref": "#/components/schemas/connection" }] }, + "get-zone-script-response": { + "allOf": [ + { "$ref": "#/components/schemas/script" }, + { + "properties": { + "versions": { + "example": [ + { + "fetched_at": "2021-08-18T10:51:08Z", + "hash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b423", + "js_integrity_score": 2 + } + ], + "items": { "$ref": "#/components/schemas/version" }, + "nullable": true, + "type": "array" + } + } + } + ] + }, + "get-zone-settings-response": { + "properties": { + "enabled": { "$ref": "#/components/schemas/enabled-N6CliIvj" }, + "updated_at": { "$ref": "#/components/schemas/updated_at" }, + "use_cloudflare_reporting_endpoint": { "$ref": "#/components/schemas/use_cloudflare_reporting_endpoint" }, + "use_connection_url_path": { "$ref": "#/components/schemas/use_connection_url_path" } + } + }, + "get_ownership_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { + "properties": { + "result": { + "nullable": true, + "properties": { + "filename": { "example": "logs/challenge-filename.txt", "type": "string" }, + "message": { "example": "", "type": "string" }, + "valid": { "example": true, "type": "boolean" } + }, + "type": "object" + } + } + } + ] + }, + "get_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "$ref": "#/components/schemas/zone_metadata" } + ] + }, + "get_settings_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "public_key": { + "example": "EmpOvSXw8BfbrGCi0fhGiD/3yXk2SiV1Nzg2lru3oj0=", + "nullable": true, + "type": "string" + } + }, + "required": ["public_key"] + } + } + } + ] + }, + "github": { + "allOf": [ + { "$ref": "#/components/schemas/identity-provider" }, + { "properties": { "config": { "$ref": "#/components/schemas/generic-oauth-config" } }, "type": "object" } + ], + "title": "GitHub", + "type": "object" + }, + "github_organization_rule": { + "description": "Matches a Github organization.\nRequires a Github identity provider.", + "properties": { + "github-organization": { + "properties": { + "connection_id": { + "description": "The ID of your Github identity provider.", + "example": "ea85612a-29c8-46c2-bacb-669d65136971", + "type": "string" + }, + "name": { "description": "The name of the organization.", "example": "cloudflare", "type": "string" } + }, + "required": ["name", "connection_id"], + "type": "object" + } + }, + "required": ["github-organization"], + "title": "Github organization", + "type": "object" + }, + "google": { + "allOf": [ + { "$ref": "#/components/schemas/identity-provider" }, + { "properties": { "config": { "$ref": "#/components/schemas/generic-oauth-config" } }, "type": "object" } + ], + "title": "Google", + "type": "object" + }, + "google-apps": { + "allOf": [ + { "$ref": "#/components/schemas/identity-provider" }, + { + "properties": { + "config": { + "allOf": [ + { "$ref": "#/components/schemas/generic-oauth-config" }, + { + "properties": { + "apps_domain": { + "description": "Your companies TLD", + "example": "mycompany.com", + "type": "string" + } + }, + "type": "object" + } + ] + } + }, + "type": "object" + } + ], + "title": "Google Workspace", + "type": "object" + }, + "grants": { + "example": { "read": true, "write": false }, + "properties": { + "read": { "example": true, "type": "boolean" }, + "write": { "example": true, "type": "boolean" } + }, + "type": "object" + }, + "gre": { + "description": "The configuration specific to GRE interconnects.", + "properties": { + "cloudflare_endpoint": { + "description": "The IP address assigned to the Cloudflare side of the GRE tunnel created as part of the Interconnect.", + "example": "203.0.113.1", + "type": "string" + } + }, + "type": "object" + }, + "gre-tunnel": { + "properties": { + "cloudflare_gre_endpoint": { "$ref": "#/components/schemas/cloudflare_gre_endpoint" }, + "created_on": { "$ref": "#/components/schemas/schemas-created_on" }, + "customer_gre_endpoint": { "$ref": "#/components/schemas/customer_gre_endpoint" }, + "description": { "$ref": "#/components/schemas/schemas-description-SitV9b51" }, + "health_check": { "$ref": "#/components/schemas/health_check" }, + "id": { "$ref": "#/components/schemas/schemas-identifier-67y1Mk1I" }, + "interface_address": { "$ref": "#/components/schemas/interface_address" }, + "modified_on": { "$ref": "#/components/schemas/schemas-modified_on" }, + "mtu": { "$ref": "#/components/schemas/mtu" }, + "name": { "$ref": "#/components/schemas/name-z6BHq9UH" }, + "ttl": { "$ref": "#/components/schemas/ttl" } + }, + "required": ["name", "customer_gre_endpoint", "cloudflare_gre_endpoint", "interface_address"], + "type": "object" + }, + "group": { + "properties": { + "description": { "$ref": "#/components/schemas/group_components-schemas-description" }, + "id": { "$ref": "#/components/schemas/group_components-schemas-identifier" }, + "modified_rules_count": { "$ref": "#/components/schemas/modified_rules_count" }, + "name": { "$ref": "#/components/schemas/group_components-schemas-name" }, + "package_id": { "$ref": "#/components/schemas/package_components-schemas-identifier" }, + "rules_count": { "$ref": "#/components/schemas/rules_count" } + }, + "type": "object" + }, + "group_components-schemas-description": { + "description": "An informative summary of what the rule group does.", + "example": "Group designed to protect against IP addresses that are a threat and typically used to launch DDoS attacks", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "group_components-schemas-identifier": { + "description": "The unique identifier of the rule group.", + "example": "de677e5818985db1285d0e80225f06e5", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "group_components-schemas-name": { + "description": "The name of the rule group.", + "example": "Project Honey Pot", + "readOnly": true, + "type": "string" + }, + "groups": { + "properties": { + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "exclude": { "$ref": "#/components/schemas/exclude" }, + "id": { "$ref": "#/components/schemas/schemas-uuid-JmfIpL8C" }, + "include": { "$ref": "#/components/schemas/include" }, + "name": { "$ref": "#/components/schemas/components-schemas-name-4G3Rlgj8" }, + "require": { "$ref": "#/components/schemas/require" }, + "updated_at": { "$ref": "#/components/schemas/timestamp" } + }, + "type": "object" + }, + "groups-fQOB8cgI": { + "additionalProperties": true, + "description": "An object that allows you to enable or disable WAF rule groups for the current WAF override. Each key of this object must be the ID of a WAF rule group, and each value must be a valid WAF action (usually `default` or `disable`). When creating a new URI-based WAF override, you must provide a `groups` object or a `rules` object.", + "example": { "ea8687e59929c1fd05ba97574ad43f77": "default" }, + "type": "object" + }, + "groups_components-schemas-id_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { "id": { "$ref": "#/components/schemas/schemas-uuid-vgvRNXQL" } }, + "type": "object" + } + } + } + ] + }, + "groups_components-schemas-name": { + "description": "The name of the Access group.", + "example": "Allow devs", + "type": "string" + }, + "groups_components-schemas-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { "result": { "items": { "$ref": "#/components/schemas/schemas-groups" }, "type": "array" } } + } + ] + }, + "groups_components-schemas-single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/schemas-groups" } } } + ] + }, + "gsuite_group_rule": { + "description": "Matches a group in Google Workspace.\nRequires a Google Workspace identity provider.", + "properties": { + "gsuite": { + "properties": { + "connection_id": { + "description": "The ID of your Google Workspace identity provider.", + "example": "ea85612a-29c8-46c2-bacb-669d65136971", + "type": "string" + }, + "email": { + "description": "The email of the Google Workspace group.", + "example": "devs@cloudflare.com", + "type": "string" + } + }, + "required": ["email", "connection_id"], + "type": "object" + } + }, + "required": ["gsuite"], + "title": "Google Workspace group", + "type": "object" + }, + "h2_prioritization": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { + "description": "ID of the zone setting.", + "enum": ["h2_prioritization"], + "example": "h2_prioritization" + }, + "value": { "$ref": "#/components/schemas/h2_prioritization_value" } + } + } + ], + "description": "HTTP/2 Edge Prioritization optimises the delivery of resources served through HTTP/2 to improve page load performance. It also supports fine control of content delivery when used in conjunction with Workers.", + "title": "HTTP/2 Edge Prioritization" + }, + "h2_prioritization_value": { + "default": "off", + "description": "Value of the zone setting.", + "enum": ["on", "off", "custom"], + "type": "string" + }, + "hash": { + "description": "The computed hash of the analyzed script.", + "maxLength": 64, + "minLength": 64, + "nullable": true, + "type": "string" + }, + "header": { + "description": "The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden. This parameter is only valid for HTTP and HTTPS monitors.", + "example": { "Host": ["example.com"], "X-App-ID": ["abc123"] }, + "type": "object" + }, + "header_name": { + "description": "The name of the response header to match.", + "example": "Cf-Cache-Status", + "type": "string" + }, + "header_op": { + "description": "The operator used when matching: `eq` means \"equal\" and `ne` means \"not equal\".", + "enum": ["eq", "ne"], + "example": "ne", + "type": "string" + }, + "header_value": { + "description": "The value of the response header, which must match exactly.", + "example": "HIT", + "type": "string" + }, + "health_check": { + "properties": { + "enabled": { + "default": true, + "description": "Determines whether to run healthchecks for a tunnel.", + "example": true, + "type": "boolean" + }, + "rate": { + "default": "mid", + "description": "How frequent the health check is run. The default value is `mid`.", + "enum": ["low", "mid", "high"], + "example": "low", + "type": "string" + }, + "target": { + "description": "The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`.", + "example": "203.0.113.1", + "type": "string" + }, + "type": { + "default": "reply", + "description": "The type of healthcheck to run, reply or request. The default value is `reply`.", + "enum": ["reply", "request"], + "example": "request", + "type": "string" + } + }, + "type": "object" + }, + "health_details": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "description": "A list of regions from which to run health checks. Null means every Cloudflare data center.", + "example": { + "pool_id": "17b5962d775c646f3f9725cbc7a53df4", + "pop_health": { + "Amsterdam, NL": { + "healthy": true, + "origins": [ + { + "2001:DB8::5": { + "failure_reason": "No failures", + "healthy": true, + "response_code": 401, + "rtt": "12.1ms" + } + } + ] + } + } + }, + "type": "object" + } + } + } + ] + }, + "healthchecks": { + "properties": { + "address": { "$ref": "#/components/schemas/address" }, + "check_regions": { "$ref": "#/components/schemas/check_regions" }, + "consecutive_fails": { "$ref": "#/components/schemas/consecutive_fails" }, + "consecutive_successes": { "$ref": "#/components/schemas/consecutive_successes" }, + "created_on": { "$ref": "#/components/schemas/timestamp" }, + "description": { "$ref": "#/components/schemas/description-hRvlp2wh" }, + "failure_reason": { "$ref": "#/components/schemas/failure_reason" }, + "http_config": { "$ref": "#/components/schemas/http_config" }, + "id": { "$ref": "#/components/schemas/identifier-Kg4WBtjI" }, + "interval": { "$ref": "#/components/schemas/interval" }, + "modified_on": { "$ref": "#/components/schemas/timestamp" }, + "name": { "$ref": "#/components/schemas/name-51RmM5yT" }, + "retries": { "$ref": "#/components/schemas/retries" }, + "status": { "$ref": "#/components/schemas/status" }, + "suspended": { "$ref": "#/components/schemas/suspended" }, + "tcp_config": { "$ref": "#/components/schemas/tcp_config" }, + "timeout": { "$ref": "#/components/schemas/timeout" }, + "type": { "$ref": "#/components/schemas/type-Eu3SX4l3" } + }, + "type": "object" + }, + "height": { "description": "Maximum height in image pixels.", "example": 768, "minimum": 1, "type": "number" }, + "height-YS9whiRo": { "description": "The height of the image in pixels.", "readOnly": true, "type": "integer" }, + "hero_url": { + "description": "URI to hero variant for an image.", + "example": "https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/hero", + "format": "uri", + "readOnly": true, + "type": "string" + }, + "history": { + "properties": { + "alert_body": { "$ref": "#/components/schemas/alert_body" }, + "alert_type": { "$ref": "#/components/schemas/schemas-alert_type" }, + "description": { "$ref": "#/components/schemas/history_components-schemas-description" }, + "id": { "$ref": "#/components/schemas/uuid-s0SXln0q" }, + "mechanism": { "$ref": "#/components/schemas/mechanism" }, + "mechanism_type": { "$ref": "#/components/schemas/mechanism_type" }, + "name": { "$ref": "#/components/schemas/history_components-schemas-name" }, + "sent": { "$ref": "#/components/schemas/sent" } + }, + "type": "object" + }, + "history_components-schemas-description": { + "description": "Description of the notification policy (if present).", + "example": "Universal Certificate validation status, issuance, renewal, and expiration notices", + "type": "string" + }, + "history_components-schemas-name": { + "description": "Name of the policy.", + "example": "SSL Notification Event Policy", + "type": "string" + }, + "history_components-schemas-per_page": { + "default": 25, + "description": "Number of items per page.", + "maximum": 1000, + "minimum": 5, + "type": "number" + }, + "history_components-schemas-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "example": [ + { + "alert_body": "SSL certificate has expired", + "alert_type": "universal_ssl_event_type", + "description": "Universal Certificate validation status, issuance, renewal, and expiration notices.", + "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", + "mechanism": "test@example.com", + "mechanism_type": "email", + "name": "SSL Notification Event Policy", + "sent": "2021-10-08T17:52:17.571336Z" + } + ], + "items": { "$ref": "#/components/schemas/history" }, + "type": "array" + }, + "result_info": { "example": { "count": 1, "page": 1, "per_page": 20 }, "type": "object" } + } + } + ] + }, + "hop_result": { + "properties": { + "nodes": { + "description": "An array of node objects.", + "items": { "$ref": "#/components/schemas/node_result" }, + "type": "array" + }, + "packets_lost": { "$ref": "#/components/schemas/packets_lost" }, + "packets_sent": { "$ref": "#/components/schemas/packets_sent" }, + "packets_ttl": { "$ref": "#/components/schemas/packets_ttl" } + }, + "type": "object" + }, + "host": { + "description": "The host name to which the waiting room will be applied (no wildcards). Please do not include the scheme (http:// or https://). The host and path combination must be unique.", + "example": "shop.example.com", + "type": "string" + }, + "host-EEtGIG7W": { + "description": "The keyless SSL name.", + "example": "example.com", + "format": "hostname", + "maxLength": 253, + "type": "string" + }, + "host-nm3Leu3G": { + "description": "RFC3986-compliant host.", + "example": "www.example.com", + "format": "hostname", + "maxLength": 255, + "type": "string" + }, + "hostname": { + "description": "The custom hostname that will point to your hostname via CNAME.", + "example": "app.example.com", + "maxLength": 255, + "readOnly": true, + "type": "string" + }, + "hostname-authenticated-origin-pull": { + "allOf": [{ "$ref": "#/components/schemas/hostname_certid_object" }], + "properties": { + "cert_id": { "$ref": "#/components/schemas/identifier-tZwYoMuc" }, + "certificate": { + "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate" + }, + "enabled": { "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-enabled" }, + "hostname": { "$ref": "#/components/schemas/schemas-hostname" }, + "id": { "$ref": "#/components/schemas/identifier-tZwYoMuc" }, + "private_key": { "$ref": "#/components/schemas/schemas-private_key" } + }, + "type": "object" + }, + "hostname-authenticated-origin-pull-q1NG48LD": { + "allOf": [{ "$ref": "#/components/schemas/hostname_certid_object-EGVUDBlM" }], + "properties": { + "cert_id": { + "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier" + }, + "certificate": { + "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate" + }, + "enabled": { "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-enabled" }, + "hostname": { "$ref": "#/components/schemas/schemas-hostname" }, + "id": { "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier" }, + "private_key": { "$ref": "#/components/schemas/schemas-private_key" } + }, + "type": "object" + }, + "hostname-authenticated-origin-pull_components-schemas-certificate": { + "description": "The hostname certificate.", + "example": "-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n", + "type": "string" + }, + "hostname-authenticated-origin-pull_components-schemas-certificate_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "items": { "$ref": "#/components/schemas/hostname-authenticated-origin-pull-q1NG48LD" }, + "type": "array" + } + } + } + ] + }, + "hostname-authenticated-origin-pull_components-schemas-enabled": { + "description": "Indicates whether hostname-level authenticated origin pulls is enabled. A null value voids the association.", + "example": true, + "nullable": true, + "type": "boolean" + }, + "hostname-authenticated-origin-pull_components-schemas-expires_on": { + "description": "The date when the certificate expires.", + "example": "2100-01-01T05:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "hostname-authenticated-origin-pull_components-schemas-identifier": { + "description": "Certificate identifier tag.", + "example": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60", + "maxLength": 36, + "readOnly": true, + "type": "string" + }, + "hostname-authenticated-origin-pull_components-schemas-status": { + "description": "Status of the certificate or the association.", + "enum": [ + "initializing", + "pending_deployment", + "pending_deletion", + "active", + "deleted", + "deployment_timed_out", + "deletion_timed_out" + ], + "example": "active", + "readOnly": true + }, + "hostname_aop_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "items": { "$ref": "#/components/schemas/hostname-authenticated-origin-pull-q1NG48LD" }, + "type": "array" + } + } + } + ] + }, + "hostname_aop_single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/hostname_certid_object-EGVUDBlM" } } } + ] + }, + "hostname_association": { + "properties": { "hostnames": { "items": { "example": "api.example.com", "type": "string" }, "type": "array" } }, + "type": "object" + }, + "hostname_associations_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/hostname_association" } } } + ] + }, + "hostname_certid_input": { + "properties": { + "cert_id": { "$ref": "#/components/schemas/cert_id" }, + "enabled": { "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-enabled" }, + "hostname": { "$ref": "#/components/schemas/schemas-hostname" } + }, + "type": "object" + }, + "hostname_certid_input-CNETqmIk": { + "properties": { + "cert_id": { + "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier" + }, + "enabled": { "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-enabled" }, + "hostname": { "$ref": "#/components/schemas/schemas-hostname" } + }, + "type": "object" + }, + "hostname_certid_object": { + "properties": { + "cert_id": { "$ref": "#/components/schemas/identifier-tZwYoMuc" }, + "cert_status": { + "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-status" + }, + "cert_updated_at": { "$ref": "#/components/schemas/updated_at-AejnlvA8" }, + "cert_uploaded_on": { "$ref": "#/components/schemas/components-schemas-uploaded_on" }, + "certificate": { + "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate" + }, + "created_at": { "$ref": "#/components/schemas/schemas-created_at" }, + "enabled": { "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-enabled" }, + "expires_on": { + "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-expires_on" + }, + "hostname": { "$ref": "#/components/schemas/schemas-hostname" }, + "issuer": { "$ref": "#/components/schemas/issuer" }, + "serial_number": { "$ref": "#/components/schemas/serial_number" }, + "signature": { "$ref": "#/components/schemas/signature" }, + "status": { "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-status" }, + "updated_at": { "$ref": "#/components/schemas/updated_at-AejnlvA8" } + } + }, + "hostname_certid_object-EGVUDBlM": { + "properties": { + "cert_id": { + "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier" + }, + "cert_status": { + "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-status" + }, + "cert_updated_at": { "$ref": "#/components/schemas/updated_at-W25UuRZk" }, + "cert_uploaded_on": { "$ref": "#/components/schemas/components-schemas-uploaded_on" }, + "certificate": { + "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate" + }, + "created_at": { "$ref": "#/components/schemas/schemas-created_at" }, + "enabled": { "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-enabled" }, + "expires_on": { + "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-expires_on" + }, + "hostname": { "$ref": "#/components/schemas/schemas-hostname" }, + "issuer": { "$ref": "#/components/schemas/issuer" }, + "serial_number": { "$ref": "#/components/schemas/serial_number" }, + "signature": { "$ref": "#/components/schemas/signature" }, + "status": { "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-status" }, + "updated_at": { "$ref": "#/components/schemas/updated_at-W25UuRZk" } + } + }, + "hostname_post": { + "description": "The custom hostname that will point to your hostname via CNAME.", + "example": "app.example.com", + "maxLength": 255, + "type": "string" + }, + "hostnames": { + "description": "Array of hostnames or wildcard names (e.g., *.example.com) bound to the certificate.", + "example": ["example.com", "*.example.com"], + "items": {}, + "type": "array" + }, + "hosts": { + "items": { + "description": "The valid hosts for the certificates.", + "example": "example.com", + "maxLength": 253, + "readOnly": true, + "type": "string" + }, + "type": "array" + }, + "hotlink_protection": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { + "description": "ID of the zone setting.", + "enum": ["hotlink_protection"], + "example": "hotlink_protection" + }, + "value": { "$ref": "#/components/schemas/hotlink_protection_value" } + } + } + ], + "description": "When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it's not another site requesting them. People will still be able to download and view images from your page, but other sites won't be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026).", + "title": "Hotlink Protection" + }, + "hotlink_protection_value": { + "default": "off", + "description": "Value of the zone setting.", + "enum": ["on", "off"], + "type": "string" + }, + "http2": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { "description": "ID of the zone setting.", "enum": ["http2"], "example": "http2" }, + "value": { "$ref": "#/components/schemas/http2_value" } + } + } + ], + "description": "HTTP2 enabled for this zone.", + "title": "HTTP2 Value" + }, + "http2_value": { + "default": "off", + "description": "Value of the HTTP2 setting.", + "enum": ["on", "off"], + "type": "string" + }, + "http3": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { "description": "ID of the zone setting.", "enum": ["http3"], "example": "http3" }, + "value": { "$ref": "#/components/schemas/http3_value" } + } + } + ], + "description": "HTTP3 enabled for this zone.", + "title": "HTTP3 Value" + }, + "http3_value": { + "default": "off", + "description": "Value of the HTTP3 setting.", + "enum": ["on", "off"], + "type": "string" + }, + "http_config": { + "description": "Parameters specific to an HTTP or HTTPS health check.", + "nullable": true, + "properties": { + "allow_insecure": { + "default": false, + "description": "Do not validate the certificate when the health check uses HTTPS.", + "type": "boolean" + }, + "expected_body": { + "description": "A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy.", + "example": "success", + "type": "string" + }, + "expected_codes": { + "default": "200", + "description": "The expected HTTP response codes (e.g. \"200\") or code ranges (e.g. \"2xx\" for all codes starting with 2) of the health check.", + "example": ["2xx", "302"], + "items": { "type": "string" }, + "nullable": true, + "type": "array" + }, + "follow_redirects": { + "default": false, + "description": "Follow redirects if the origin returns a 3xx status code.", + "type": "boolean" + }, + "header": { + "description": "The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden.", + "example": { "Host": ["example.com"], "X-App-ID": ["abc123"] }, + "nullable": true, + "type": "object" + }, + "method": { + "default": "GET", + "description": "The HTTP method to use for the health check.", + "enum": ["GET", "HEAD"], + "type": "string" + }, + "path": { + "default": "/", + "description": "The endpoint path to health check against.", + "example": "/health", + "type": "string" + }, + "port": { + "default": 80, + "description": "Port number to connect to for the health check. Defaults to 80 if type is HTTP or 443 if type is HTTPS.", + "type": "integer" + } + }, + "type": "object" + }, + "http_only_cookie_attribute": { + "default": true, + "description": "Enables the HttpOnly cookie attribute, which increases security against XSS attacks.", + "example": true, + "type": "boolean" + }, + "id": { + "description": "The identifier for this category. There is only one category per id.", + "type": "integer" + }, + "id-6U71Robk": { + "description": "Identifier of a recommedation result.", + "example": "ssl_recommendation", + "type": "string" + }, + "id-Un5diNDY": { "description": "Unique id of the job.", "minimum": 1, "type": "integer" }, + "id-ZJpijMo1": { + "description": "The ID of the resource.", + "example": "c9ef84a6bf5e47138c75d95e2f933e8f", + "maxLength": 32, + "minLength": 32, + "type": "string" + }, + "id-e2D1eWah": { + "description": "The ID of the CA.", + "example": "7eddae4619b50ab1361ba8ae9bd72269a432fea041529ed9", + "maxLength": 48, + "readOnly": true, + "type": "string" + }, + "id_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { "id": { "$ref": "#/components/schemas/identifier-Kg4WBtjI" } }, + "type": "object" + } + } + } + ] + }, + "id_response-99rIWUZu": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { "id": { "$ref": "#/components/schemas/identifier-FZThz4k7" } }, + "type": "object" + } + } + } + ] + }, + "id_response-DDywCCxj": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { "id": { "$ref": "#/components/schemas/schemas-uuid-JmfIpL8C" } }, + "type": "object" + } + } + } + ] + }, + "id_response-I5lr4Hc3": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { "id": { "$ref": "#/components/schemas/delegation_identifier" } }, + "type": "object" + } + } + } + ] + }, + "id_response-W0Mu1ujx": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { "id": { "$ref": "#/components/schemas/monitor_components-schemas-identifier" } }, + "type": "object" + } + } + } + ] + }, + "id_response-eHg5OKOR": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { "properties": { "id": { "$ref": "#/components/schemas/uuid-l20MFQPz" } }, "type": "object" } + } + } + ] + }, + "id_response-lg4lL9us": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { "id": { "$ref": "#/components/schemas/identifier-ahBjrSIO" } }, + "type": "object" + } + } + } + ] + }, + "identifier": { "example": "699d98642c564d2e855e9661899b7252" }, + "identifier-59LodGbZ": { + "description": "Identifier", + "example": "023e105f4ecef8ad9ca31a8372d0c353", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "identifier-5dNKLCP5": { + "description": "Identifier", + "example": "023e105f4ecef8ad9ca31a8372d0c353", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "identifier-98VX040R": { + "description": "Identifier", + "example": "023e105f4ecef8ad9ca31a8372d0c353", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "identifier-A3V71xbt": { + "description": "Identifier", + "example": "023e105f4ecef8ad9ca31a8372d0c353", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "identifier-BccsQUhC": { "type": "string" }, + "identifier-ECDhGQVO": { + "description": "Policy identifier.", + "example": "f267e341f3dd4697bd3b9f71dd96247f", + "readOnly": true, + "type": "string" + }, + "identifier-FZThz4k7": { "example": "f1aba936b94213e5b8dca0c0dbf1f9cc" }, + "identifier-Gw95Cj70": { + "description": "Identifier", + "example": "023e105f4ecef8ad9ca31a8372d0c353", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "identifier-JiolAARC": { + "description": "Identifier", + "example": "023e105f4ecef8ad9ca31a8372d0c353", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "identifier-Kg4WBtjI": { + "description": "Identifier", + "example": "023e105f4ecef8ad9ca31a8372d0c353", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "identifier-MZFDye9j": { + "description": "Identifier", + "example": "023e105f4ecef8ad9ca31a8372d0c353", + "maxLength": 32, + "type": "string" + }, + "identifier-W1xsq8r6": { + "description": "Identifier", + "example": "023e105f4ecef8ad9ca31a8372d0c353", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "identifier-XSj9HnWY": { + "description": "A Cloudflare-generated unique identifier for a media item.", + "example": "ea95132c15732412d22c1476fa83f27a", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "identifier-YhmC5GTP": { + "description": "Identifier", + "example": "023e105f4ecef8ad9ca31a8372d0c353", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "identifier-ahBjrSIO": { "example": "269d8f4853475ca241c4e730be286b20", "readOnly": true }, + "identifier-b3jdvVAb": { + "description": "Identifier", + "example": "023e105f4ecef8ad9ca31a8372d0c353", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "identifier-fzl1amog": { + "description": "Identifier", + "example": "023e105f4ecef8ad9ca31a8372d0c353", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "identifier-g7jwPNXP": { + "description": "Identifier", + "example": "023e105f4ecef8ad9ca31a8372d0c353", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "identifier-gI2sCanq": { + "description": "Identifier", + "example": "023e105f4ecef8ad9ca31a8372d0c353", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "identifier-jnfvAiHn": { + "description": "Identifier", + "example": "023e105f4ecef8ad9ca31a8372d0c353", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "identifier-oBX6a2Mp": { + "description": "Account identifier tag.", + "example": "372e67954025e0ba6aaa6d586b9e0b59", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "identifier-smPsQb9r": { + "description": "Identifier", + "example": "023e105f4ecef8ad9ca31a8372d0c353", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "identifier-tZwYoMuc": { + "description": "Identifier", + "example": "023e105f4ecef8ad9ca31a8372d0c353", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "identifier-v0xEcFCj": { + "description": "Identifier", + "example": "023e105f4ecef8ad9ca31a8372d0c353", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "identifier-zpETYDGh": { + "description": "Identifier", + "example": "023e105f4ecef8ad9ca31a8372d0c353", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "identity": { + "description": "The wirefilter expression to be used for identity matching.", + "example": "any(identity.groups.name[*] in {\"finance\"})", + "type": "string" + }, + "identity-provider": { + "properties": { + "config": { + "description": "The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).", + "type": "object" + }, + "id": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" }, + "name": { "$ref": "#/components/schemas/schemas-name-QA00iN6H" }, + "scim_config": { + "description": "The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.", + "properties": { + "enabled": { + "description": "A flag to enable or disable SCIM for the identity provider.", + "type": "boolean" + }, + "group_member_deprovision": { + "description": "A flag to revoke a user's session in Access and force a reauthentication on the user's Gateway session when they have been added or removed from a group in the Identity Provider.", + "type": "boolean" + }, + "seat_deprovision": { + "description": "A flag to remove a user's seat in Zero Trust when they have been deprovisioned in the Identity Provider. This cannot be enabled unless user_deprovision is also enabled.", + "type": "boolean" + }, + "secret": { + "description": "A read-only token generated when the SCIM integration is enabled for the first time. It is redacted on subsequent requests. If you lose this you will need to refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.", + "type": "string" + }, + "user_deprovision": { + "description": "A flag to enable revoking a user's session in Access and Gateway when they have been deprovisioned in the Identity Provider.", + "type": "boolean" + } + }, + "type": "object" + }, + "type": { + "description": "The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).", + "example": "onetimepin", + "type": "string" + } + }, + "required": ["name", "type", "config"], + "type": "object" + }, + "identity-providers": { + "oneOf": [ + { "$ref": "#/components/schemas/azureAD" }, + { "$ref": "#/components/schemas/centrify" }, + { "$ref": "#/components/schemas/facebook" }, + { "$ref": "#/components/schemas/github" }, + { "$ref": "#/components/schemas/google" }, + { "$ref": "#/components/schemas/google-apps" }, + { "$ref": "#/components/schemas/linkedin" }, + { "$ref": "#/components/schemas/oidc" }, + { "$ref": "#/components/schemas/okta" }, + { "$ref": "#/components/schemas/onelogin" }, + { "$ref": "#/components/schemas/pingone" }, + { "$ref": "#/components/schemas/saml" }, + { "$ref": "#/components/schemas/yandex" } + ] + }, + "identity-providers-jdnkP8pB": { + "properties": { + "config": { "$ref": "#/components/schemas/schemas-config" }, + "id": { "$ref": "#/components/schemas/uuid-s0SXln0q" }, + "name": { "$ref": "#/components/schemas/identity-providers_components-schemas-name" }, + "type": { "$ref": "#/components/schemas/identity-providers_components-schemas-type" } + }, + "type": "object" + }, + "identity-providers_components-schemas-name": { + "description": "The name of the identity provider, shown to users on the login page.", + "example": "Widget Corps OTP", + "type": "string" + }, + "identity-providers_components-schemas-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "items": { + "anyOf": [ + { "$ref": "#/components/schemas/schemas-azureAD" }, + { "$ref": "#/components/schemas/schemas-centrify" }, + { "$ref": "#/components/schemas/schemas-facebook" }, + { "$ref": "#/components/schemas/schemas-github" }, + { "$ref": "#/components/schemas/schemas-google" }, + { "$ref": "#/components/schemas/schemas-google-apps" }, + { "$ref": "#/components/schemas/schemas-linkedin" }, + { "$ref": "#/components/schemas/schemas-oidc" }, + { "$ref": "#/components/schemas/schemas-okta" }, + { "$ref": "#/components/schemas/schemas-onelogin" }, + { "$ref": "#/components/schemas/schemas-pingone" }, + { "$ref": "#/components/schemas/schemas-saml" }, + { "$ref": "#/components/schemas/schemas-yandex" } + ] + }, + "type": "array" + } + }, + "type": "object" + } + ], + "type": "object" + }, + "identity-providers_components-schemas-response_collection-7VdQuy6l": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/identity-providers-jdnkP8pB" }, "type": "array" } + } + } + ] + }, + "identity-providers_components-schemas-single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/schemas-identity-providers" } } } + ] + }, + "identity-providers_components-schemas-single_response-mzpMSK38": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/identity-providers-jdnkP8pB" } } } + ] + }, + "identity-providers_components-schemas-type": { + "description": "The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).", + "example": "onetimepin", + "type": "string" + }, + "image_basic_upload_via_url": { + "properties": { + "metadata": { + "description": "User modifiable key-value store. Can use used for keeping references to another system of record for managing images.", + "type": "object" + }, + "requireSignedURLs": { + "default": false, + "description": "Indicates whether the image requires a signature token for the access.", + "example": true, + "type": "boolean" + }, + "url": { + "description": "A URL to fetch an image from origin.", + "example": "https://example.com/path/to/logo.png", + "type": "string" + } + }, + "required": ["url"], + "type": "object" + }, + "image_patch_request": { + "properties": { + "metadata": { + "description": "User modifiable key-value store. Can be used for keeping references to another system of record for managing images. No change if not specified.", + "type": "object" + }, + "requireSignedURLs": { + "description": "Indicates whether the image can be accessed using only its UID. If set to `true`, a signed token needs to be generated with a signing key to view the image. Returns a new UID on a change. No change if not specified.", + "example": true, + "type": "boolean" + } + }, + "type": "object" + }, + "image_resizing": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { + "description": "ID of the zone setting.", + "enum": ["image_resizing"], + "example": "image_resizing" + }, + "value": { "$ref": "#/components/schemas/image_resizing_value" } + } + } + ], + "description": "Image Resizing provides on-demand resizing, conversion and optimisation for images served through Cloudflare's network. Refer to the [Image Resizing documentation](https://developers.cloudflare.com/images/) for more information.", + "title": "Image Resizing" + }, + "image_resizing_value": { + "default": "off", + "description": "Whether the feature is enabled, disabled, or enabled in `open proxy` mode.", + "enum": ["on", "off", "open"], + "type": "string" + }, + "image_response_blob": { + "anyOf": [{ "type": "string" }, { "type": "object" }], + "example": "\u003cimage blob data\u003e" + }, + "image_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/images" }, "type": "array" } } } + ] + }, + "image_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } } } + ] + }, + "images": { + "properties": { + "filename": { "$ref": "#/components/schemas/filename" }, + "id": { "$ref": "#/components/schemas/images_components-schemas-identifier" }, + "metadata": { "$ref": "#/components/schemas/metadata" }, + "requireSignedURLs": { "$ref": "#/components/schemas/requireSignedURLs" }, + "uploaded": { "$ref": "#/components/schemas/uploaded" }, + "variants": { "$ref": "#/components/schemas/schemas-variants" } + }, + "type": "object" + }, + "images_components-schemas-identifier": { + "description": "Image unique identifier.", + "example": "107b9558-dd06-4bbd-5fef-9c2c16bb7900", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "images_count": { + "properties": { + "allowed": { "$ref": "#/components/schemas/allowed-r2rT3jf5" }, + "current": { "$ref": "#/components/schemas/current" } + }, + "type": "object" + }, + "images_stats": { "properties": { "count": { "$ref": "#/components/schemas/images_count" } }, "type": "object" }, + "include": { + "description": "Rules evaluated with an OR logical operator. A user needs to meet only one of the Include rules.", + "items": { "$ref": "#/components/schemas/rule" }, + "type": "array" + }, + "include-6K7SmqAm": { + "description": "Rules evaluated with an OR logical operator. A user needs to meet only one of the Include rules.", + "items": { "$ref": "#/components/schemas/rule_components-schemas-rule" }, + "type": "array" + }, + "include-9GPmbbUN": { "items": { "$ref": "#/components/schemas/split_tunnel_include" }, "type": "array" }, + "input": { + "description": "The value to be checked against.", + "properties": { "id": { "$ref": "#/components/schemas/device-posture-rules_components-schemas-uuid" } }, + "type": "object" + }, + "input-NaZjecAw": { + "description": "The value to be checked against.", + "properties": { + "checkDisks": { "$ref": "#/components/schemas/checkDisks" }, + "id": { "$ref": "#/components/schemas/uuid-l20MFQPz" }, + "requireAll": { "$ref": "#/components/schemas/requireAll" } + }, + "type": "object" + }, + "input-kvQ6FpFL": { + "properties": { + "height": { + "description": "The video height in pixels. A value of `-1` means the height is unknown. The value becomes available after the upload and before the video is ready.", + "readOnly": true, + "type": "integer" + }, + "width": { + "description": "The video width in pixels. A value of `-1` means the width is unknown. The value becomes available after the upload and before the video is ready.", + "readOnly": true, + "type": "integer" + } + }, + "readOnly": true, + "type": "object" + }, + "input_rtmps": { + "description": "Details for streaming to an live input using RTMPS.", + "properties": { + "streamKey": { "$ref": "#/components/schemas/input_rtmps_stream_key" }, + "url": { "$ref": "#/components/schemas/input_rtmps_url" } + }, + "type": "object" + }, + "input_rtmps_stream_key": { + "description": "The secret key to use when streaming via RTMPS to a live input.", + "example": "2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada", + "readOnly": true, + "type": "string" + }, + "input_rtmps_url": { + "description": "The RTMPS URL you provide to the broadcaster, which they stream live video to.", + "example": "rtmps://live.cloudflare.com:443/live/", + "readOnly": true, + "type": "string" + }, + "input_srt": { + "description": "Details for streaming to a live input using SRT.", + "properties": { + "passphrase": { "$ref": "#/components/schemas/input_srt_stream_passphrase" }, + "streamId": { "$ref": "#/components/schemas/input_srt_stream_id" }, + "url": { "$ref": "#/components/schemas/input_srt_url" } + }, + "type": "object" + }, + "input_srt_stream_id": { + "description": "The identifier of the live input to use when streaming via SRT.", + "example": "f256e6ea9341d51eea64c9454659e576", + "readOnly": true, + "type": "string" + }, + "input_srt_stream_passphrase": { + "description": "The secret key to use when streaming via SRT to a live input.", + "example": "2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada", + "readOnly": true, + "type": "string" + }, + "input_srt_url": { + "description": "The SRT URL you provide to the broadcaster, which they stream live video to.", + "example": "srt://live.cloudflare.com:778", + "readOnly": true, + "type": "string" + }, + "input_webrtc": { + "description": "Details for streaming to a live input using WebRTC.", + "properties": { "url": { "$ref": "#/components/schemas/input_webrtc_url" } }, + "type": "object" + }, + "input_webrtc_url": { + "description": "The WebRTC URL you provide to the broadcaster, which they stream live video to.", + "example": "https://customer-m033z5x00ks6nunl.cloudflarestream.com/b236bde30eb07b9d01318940e5fc3edake34a3efb3896e18f2dc277ce6cc993ad/webRTC/publish", + "readOnly": true, + "type": "string" + }, + "install_id": { "description": "app install id.", "type": "string" }, + "instant_logs_job": { + "nullable": true, + "properties": { + "destination_conf": { "$ref": "#/components/schemas/schemas-destination_conf" }, + "fields": { "$ref": "#/components/schemas/fields" }, + "filter": { "$ref": "#/components/schemas/filter" }, + "sample": { "$ref": "#/components/schemas/sample" }, + "session_id": { "$ref": "#/components/schemas/session_id" } + }, + "type": "object" + }, + "instant_logs_job_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/instant_logs_job" }, "type": "array" } + } + } + ] + }, + "instant_logs_job_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/instant_logs_job" } } } + ] + }, + "integration_entry": { + "description": "An entry derived from an integration", + "properties": { + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "enabled": { "description": "Whether the entry is enabled or not.", "example": true, "type": "boolean" }, + "id": { "$ref": "#/components/schemas/entry_id" }, + "name": { "description": "The name of the entry.", "example": "Top Secret", "type": "string" }, + "profile_id": { "description": "ID of the parent profile" }, + "updated_at": { "$ref": "#/components/schemas/timestamp" } + }, + "title": "Integration entry", + "type": "object" + }, + "integration_profile": { + "properties": { + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "description": { "description": "The description of the profile.", "type": "string" }, + "entries": { + "description": "The entries for this profile.", + "items": { "$ref": "#/components/schemas/integration_entry" }, + "type": "array" + }, + "id": { "$ref": "#/components/schemas/profile_id" }, + "name": { + "description": "The name of the profile.", + "example": "MIP Sensitivity Labels: Profile 1", + "type": "string" + }, + "type": { + "description": "The type of the profile.", + "enum": ["integration"], + "example": "integration", + "type": "string" + }, + "updated_at": { "$ref": "#/components/schemas/timestamp" } + }, + "title": "Integration profile", + "type": "object" + }, + "interconnect": { + "properties": { + "colo_name": { "$ref": "#/components/schemas/components-schemas-name-MuyCBGYr" }, + "created_on": { "$ref": "#/components/schemas/schemas-created_on" }, + "description": { "$ref": "#/components/schemas/interconnect_components-schemas-description" }, + "gre": { "$ref": "#/components/schemas/gre" }, + "health_check": { "$ref": "#/components/schemas/schemas-health_check" }, + "id": { "$ref": "#/components/schemas/schemas-identifier-67y1Mk1I" }, + "interface_address": { "$ref": "#/components/schemas/interface_address" }, + "modified_on": { "$ref": "#/components/schemas/schemas-modified_on" }, + "mtu": { "$ref": "#/components/schemas/schemas-mtu" }, + "name": { "$ref": "#/components/schemas/components-schemas-name-MuyCBGYr" } + }, + "type": "object" + }, + "interconnect_components-schemas-description": { + "description": "An optional description of the interconnect.", + "example": "Tunnel for Interconnect to ORD", + "type": "string" + }, + "interface_address": { + "description": "A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side of the tunnel. Select the subnet from the following private IP space: 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.", + "example": "192.0.2.0/31", + "type": "string" + }, + "interval": { + "default": 60, + "description": "The interval between each health check. Shorter intervals may give quicker notifications if the origin status changes, but will increase load on the origin as we check from multiple locations.", + "type": "integer" + }, + "interval-FAyugCvL": { + "description": "The interval between each posture check with the third party API. Use \"m\" for minutes (e.g. \"5m\") and \"h\" for hours (e.g. \"12h\").", + "example": "10m", + "type": "string" + }, + "interval-IFpdxmAf": { + "default": 60, + "description": "The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations.", + "type": "integer" + }, + "interval-hA6swy38": { + "default": 60, + "description": "The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations.", + "type": "integer" + }, + "intune_config_request": { + "properties": { + "client_id": { "description": "The Intune client ID.", "example": "example client id", "type": "string" }, + "client_secret": { + "description": "The Intune client secret.", + "example": "example client secret", + "type": "string" + }, + "customer_id": { + "description": "The Intune customer ID.", + "example": "example customer id", + "type": "string" + } + }, + "required": ["customer_id", "client_id", "client_secret"], + "type": "object" + }, + "invite": { "allOf": [{ "$ref": "#/components/schemas/organization_invite" }], "type": "object" }, + "invite_components-schemas-identifier": { + "description": "Invite identifier tag.", + "example": "4f5f0c14a2a41d5063dd301b2f829f04", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "invited_by": { + "description": "The email address of the user who created the invite.", + "example": "user@example.com", + "maxLength": 90, + "type": "string" + }, + "invited_member_email": { + "description": "Email address of the user to add to the organization.", + "example": "user@example.com", + "maxLength": 90, + "type": "string" + }, + "invited_on": { + "description": "When the invite was sent.", + "example": "2014-01-01T05:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "ip": { + "description": "IPV6 destination ip assigned to this location. DNS requests sent to this IP will counted as the request under this location. (auto-generated).", + "example": "2001:0db8:85a3:0000:0000:8a2e:0370:7334", + "type": "string" + }, + "ip-8QKcCQCp": { "description": "An IPv4 or IPv6 address.", "example": "192.0.2.1", "type": "string" }, + "ip-anO5UL8J": { + "description": "IPv4/IPv6 address of primary or secondary nameserver, depending on what zone this peer is linked to. For primary zones this IP defines the IP of the secondary nameserver Cloudflare will NOTIFY upon zone changes. For secondary zones this IP defines the IP of the primary nameserver Cloudflare will send AXFR/IXFR requests to.", + "example": "192.0.2.53", + "type": "string" + }, + "ip-gs35mKhq": { "description": "An IPv4 or IPv6 address.", "example": "192.0.2.1", "type": "string" }, + "ip-ibmclV7b": { + "description": "The IP address of the authenticating user.", + "example": "198.41.129.166", + "type": "string" + }, + "ip-idMl3BYW": { "description": "IPv4 or IPv6 address.", "example": "1.1.1.1", "type": "string" }, + "ip-list": { + "properties": { + "description": { "type": "string" }, + "id": { "type": "integer" }, + "name": { "example": "Malware", "type": "string" } + } + }, + "ip_address": { "description": "An IPv4 or IPv6 address.", "example": "192.0.2.1", "type": "string" }, + "ip_components-schemas-ip": { + "properties": { + "belongs_to_ref": { + "description": "Specifies a reference to the autonomous systems (AS) that the IP address belongs to.", + "properties": { + "country": { "example": "US", "type": "string" }, + "description": { "example": "CLOUDFLARENET", "type": "string" }, + "id": { "example": "autonomous-system--2fa28d71-3549-5a38-af05-770b79ad6ea8" }, + "type": { + "description": "Infrastructure type of this ASN.", + "enum": ["hosting_provider", "isp", "organization"], + "example": "hosting_provider", + "type": "string" + }, + "value": { "type": "string" } + }, + "type": "object" + }, + "ip": { "$ref": "#/components/schemas/common_components-schemas-ip" }, + "risk_types": { "example": [{ "id": 131, "name": "Phishing", "super_category_id": 21 }] } + } + }, + "ip_configuration": { + "properties": { + "target": { + "description": "The configuration target. You must set the target to `ip` when specifying an IP address in the rule.", + "enum": ["ip"], + "example": "ip" + }, + "value": { + "description": "The IP address to match. This address will be compared to the IP address of incoming requests.", + "example": "198.51.100.4", + "type": "string" + } + }, + "title": "An IP address configuration." + }, + "ip_firewall": { + "description": "Enables IP Access Rules for this application.\nNotes: Only available for TCP applications.", + "example": true, + "type": "boolean" + }, + "ip_geolocation": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { + "description": "ID of the zone setting.", + "enum": ["ip_geolocation"], + "example": "ip_geolocation" + }, + "value": { "$ref": "#/components/schemas/ip_geolocation_value" } + } + } + ], + "description": "Enable IP Geolocation to have Cloudflare geolocate visitors to your website and pass the country code to you. (https://support.cloudflare.com/hc/en-us/articles/200168236).", + "title": "IP Geolocation" + }, + "ip_geolocation_value": { + "default": "on", + "description": "Value of the zone setting.", + "enum": ["on", "off"], + "type": "string" + }, + "ip_list_rule": { + "description": "Matches an IP address from a list.", + "properties": { + "ip_list": { + "properties": { + "id": { + "description": "The ID of a previously created IP list.", + "example": "aa0a4aab-672b-4bdb-bc33-a59f1130a11f", + "type": "string" + } + }, + "required": ["id"], + "type": "object" + } + }, + "required": ["ip_list"], + "title": "IP list", + "type": "object" + }, + "ip_network": { + "description": "The private IPv4 or IPv6 range connected by the route, in CIDR notation.", + "example": "172.16.0.0/16", + "type": "string" + }, + "ip_network_encoded": { + "description": "IP/CIDR range in URL-encoded format", + "example": "172.16.0.0%2F16", + "type": "string" + }, + "ip_range": { + "description": "Allowed IPv4/IPv6 address range of primary or secondary nameservers. This will be applied for the entire account. The IP range is used to allow additional NOTIFY IPs for secondary zones and IPs Cloudflare allows AXFR/IXFR requests from for primary zones. CIDRs are limited to a maximum of /24 for IPv4 and /64 for IPv6 respectively.", + "example": "192.0.2.53/28", + "type": "string" + }, + "ip_range_search": { + "description": "A single IP address range to search for in existing rules.", + "example": "1.2.3.0/16", + "type": "string" + }, + "ip_rule": { + "description": "Matches an IP address block.", + "properties": { + "ip": { + "properties": { + "ip": { + "description": "An IPv4 or IPv6 CIDR block.", + "example": "2400:cb00:21:10a::/64", + "type": "string" + } + }, + "required": ["ip"], + "type": "object" + } + }, + "required": ["ip"], + "title": "IP ranges", + "type": "object" + }, + "ip_search": { + "description": "A single IP address to search for in existing rules.", + "example": "1.2.3.4", + "type": "string" + }, + "ipam-delegations": { + "properties": { + "cidr": { "$ref": "#/components/schemas/cidr" }, + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "delegated_account_id": { "$ref": "#/components/schemas/delegated_account_identifier" }, + "id": { "$ref": "#/components/schemas/delegation_identifier" }, + "modified_at": { "$ref": "#/components/schemas/timestamp" }, + "parent_prefix_id": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + }, + "type": "object" + }, + "ipam-delegations-pbRciqF5": { + "properties": { + "cidr": { "$ref": "#/components/schemas/cidr" }, + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "delegated_account_id": { "$ref": "#/components/schemas/delegated_account_identifier-hmTz3KXe" }, + "id": { "$ref": "#/components/schemas/delegation_identifier" }, + "modified_at": { "$ref": "#/components/schemas/timestamp" }, + "parent_prefix_id": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + "type": "object" + }, + "ipam-delegations_components-schemas-id_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { "id": { "$ref": "#/components/schemas/delegation_identifier" } }, + "type": "object" + } + } + } + ] + }, + "ipam-delegations_components-schemas-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/ipam-delegations-pbRciqF5" }, "type": "array" } + } + } + ] + }, + "ipam-delegations_components-schemas-single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/ipam-delegations-pbRciqF5" } } } + ] + }, + "ipam-prefixes": { + "properties": { + "account_id": { "$ref": "#/components/schemas/identifier-v0xEcFCj" }, + "advertised": { "$ref": "#/components/schemas/advertised" }, + "advertised_modified_at": { "$ref": "#/components/schemas/modified_at_nullable" }, + "approved": { "$ref": "#/components/schemas/approved" }, + "asn": { "$ref": "#/components/schemas/asn" }, + "cidr": { "$ref": "#/components/schemas/cidr" }, + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "description": { "$ref": "#/components/schemas/description-AqNwNwjr" }, + "id": { "$ref": "#/components/schemas/identifier-v0xEcFCj" }, + "loa_document_id": { "$ref": "#/components/schemas/loa_document_identifier" }, + "modified_at": { "$ref": "#/components/schemas/timestamp" }, + "on_demand_enabled": { "$ref": "#/components/schemas/on_demand_enabled" }, + "on_demand_locked": { "$ref": "#/components/schemas/on_demand_locked" } + }, + "type": "object" + }, + "ipam-prefixes-HslRkpIE": { + "properties": { + "account_id": { "$ref": "#/components/schemas/common_components-schemas-identifier" }, + "advertised": { "$ref": "#/components/schemas/advertised" }, + "advertised_modified_at": { "$ref": "#/components/schemas/modified_at_nullable" }, + "approved": { "$ref": "#/components/schemas/approved" }, + "asn": { "$ref": "#/components/schemas/asn-N957CyNV" }, + "cidr": { "$ref": "#/components/schemas/cidr" }, + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "description": { "$ref": "#/components/schemas/ipam-prefixes_components-schemas-description" }, + "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" }, + "loa_document_id": { "$ref": "#/components/schemas/loa_document_identifier-eboVwtvp" }, + "modified_at": { "$ref": "#/components/schemas/timestamp" }, + "on_demand_enabled": { "$ref": "#/components/schemas/on_demand_enabled" }, + "on_demand_locked": { "$ref": "#/components/schemas/on_demand_locked" } + }, + "type": "object" + }, + "ipam-prefixes_components-schemas-description": { + "description": "Description of the prefix.", + "example": "Internal test prefix", + "maxLength": 1000, + "type": "string" + }, + "ipam-prefixes_components-schemas-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/ipam-prefixes-HslRkpIE" }, "type": "array" } + } + } + ] + }, + "ipam-prefixes_components-schemas-single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/ipam-prefixes-HslRkpIE" } } } + ] + }, + "ips": { + "description": "A list of CIDRs to restrict ingress connections.", + "items": { + "description": "The IPv4 CIDR or IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /109. IPv4 CIDRs are limited to a maximum of /25.", + "example": "192.0.2.1/32", + "type": "string" + }, + "type": "array" + }, + "ips-BbJyXXsk": { + "properties": { + "etag": { + "description": "A digest of the IP data. Useful for determining if the data has changed.", + "example": "a8e453d9d129a3769407127936edfdb0", + "type": "string" + }, + "ipv4_cidrs": { + "description": "List of Cloudflare IPv4 CIDR addresses.", + "items": { "description": "IPv4 CIDR.", "example": "199.27.128.0/21", "type": "string" }, + "type": "array" + }, + "ipv6_cidrs": { + "description": "List of Cloudflare IPv6 CIDR addresses.", + "items": { "description": "IPv6 CIDR.", "example": "2400:cb00::/32", "type": "string" }, + "type": "array" + } + }, + "type": "object" + }, + "ips-noQAIDso": { + "description": "The set of IPs on the Address Map.", + "items": { "$ref": "#/components/schemas/address-maps-ip-spXX1kUy" }, + "type": "array" + }, + "ips_jdcloud": { + "properties": { + "etag": { "$ref": "#/components/schemas/etag-q3CF2kCS" }, + "ipv4_cidrs": { "$ref": "#/components/schemas/ipv4_cidrs" }, + "ipv6_cidrs": { "$ref": "#/components/schemas/ipv6_cidrs" }, + "jdcloud_cidrs": { + "description": "List IPv4 and IPv6 CIDRs, only popoulated if `?networks=jdcloud` is used.", + "items": { "description": "IPv4 or IPv6 CIDR.", "example": "199.27.128.0/21", "type": "string" }, + "type": "array" + } + }, + "type": "object" + }, + "ipsec-tunnel": { + "properties": { + "allow_null_cipher": { "$ref": "#/components/schemas/allow_null_cipher" }, + "cloudflare_endpoint": { "$ref": "#/components/schemas/cloudflare_ipsec_endpoint" }, + "created_on": { "$ref": "#/components/schemas/schemas-created_on" }, + "customer_endpoint": { "$ref": "#/components/schemas/customer_ipsec_endpoint" }, + "description": { "$ref": "#/components/schemas/components-schemas-description-EJnoLTyB" }, + "id": { "$ref": "#/components/schemas/schemas-identifier-67y1Mk1I" }, + "interface_address": { "$ref": "#/components/schemas/interface_address" }, + "modified_on": { "$ref": "#/components/schemas/schemas-modified_on" }, + "name": { "$ref": "#/components/schemas/schemas-name-m2fEJLlJ" }, + "psk_metadata": { "$ref": "#/components/schemas/psk_metadata" }, + "tunnel_health_check": { "$ref": "#/components/schemas/tunnel_health_check" } + }, + "required": ["name", "cloudflare_endpoint", "interface_address"], + "type": "object" + }, + "ipv4": { "example": "192.0.2.0", "format": "ipv4", "type": "string" }, + "ipv4_cidrs": { + "description": "List of Cloudflare IPv4 CIDR addresses.", + "items": { "description": "IPv4 CIDR.", "example": "199.27.128.0/21", "type": "string" }, + "type": "array" + }, + "ipv6": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { "description": "ID of the zone setting.", "enum": ["ipv6"], "example": "ipv6" }, + "value": { "$ref": "#/components/schemas/ipv6_value" } + } + } + ], + "description": "Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586).", + "title": "IPv6" + }, + "ipv6-KrBmBy6R": { "example": "2001:0DB8::", "format": "ipv6", "type": "string" }, + "ipv6_cidrs": { + "description": "List of Cloudflare IPv6 CIDR addresses.", + "items": { "description": "IPv6 CIDR.", "example": "2400:cb00::/32", "type": "string" }, + "type": "array" + }, + "ipv6_configuration": { + "properties": { + "target": { + "description": "The configuration target. You must set the target to `ip6` when specifying an IPv6 address in the rule.", + "enum": ["ip6"], + "example": "ip6" + }, + "value": { "description": "The IPv6 address to match.", "example": "2001:DB8:100::CF", "type": "string" } + }, + "title": "An IPv6 address configuration." + }, + "ipv6_value": { + "default": "off", + "description": "Value of the zone setting.", + "enum": ["off", "on"], + "type": "string" + }, + "is_default_network": { + "description": "If `true`, this virtual network is the default for the account.", + "example": true, + "type": "boolean" + }, + "is_pending_reconnect": { + "description": "Cloudflare continues to track connections for several minutes after they disconnect. This is an optimization to improve latency and reliability of reconnecting. If `true`, the connection has disconnected but is still being tracked. If `false`, the connection is actively serving traffic.", + "example": false, + "type": "boolean" + }, + "is_subscribed": { + "default": false, + "description": "Indicates whether you are currently subscribed to this plan.", + "example": false, + "type": "boolean" + }, + "is_ui_read_only": { + "description": "Lock all settings as Read-Only in the Dashboard, regardless of user permission. Updates may only be made via the API or Terraform for this account when enabled.", + "example": "false", + "type": "boolean" + }, + "issued_on": { + "description": "Date that the Client Certificate was issued by the Certificate Authority", + "example": "2023-02-23T23:18:00Z", + "readOnly": true, + "type": "string" + }, + "issued_on-ckMiaqK5": { + "description": "The time on which the token was created.", + "example": "2018-07-01T05:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "issuer": { + "description": "The certificate authority that issued the certificate.", + "example": "GlobalSign", + "readOnly": true, + "type": "string" + }, + "item": { + "example": { + "comment": "Private IP address", + "created_on": "2020-01-01T08:00:00Z", + "id": "2c0fc9fa937b11eaa1b71c4d701ab86e", + "ip": "10.0.0.1", + "modified_on": "2020-01-10T14:00:00Z" + }, + "oneOf": [{ "required": ["ip"] }, { "required": ["redirect"] }, { "required": ["hostname"] }], + "properties": { + "comment": { "$ref": "#/components/schemas/item_comment" }, + "created_on": { + "description": "The RFC 3339 timestamp of when the item was created.", + "example": "2020-01-01T08:00:00Z", + "readOnly": true, + "type": "string" + }, + "hostname": { "$ref": "#/components/schemas/item_hostname" }, + "id": { "$ref": "#/components/schemas/list_id" }, + "ip": { "$ref": "#/components/schemas/item_ip" }, + "modified_on": { + "description": "The RFC 3339 timestamp of when the item was last modified.", + "example": "2020-01-10T14:00:00Z", + "readOnly": true, + "type": "string" + }, + "redirect": { "$ref": "#/components/schemas/item_redirect" } + }, + "type": "object" + }, + "item-response-collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "$ref": "#/components/schemas/item" } }, "type": "object" } + ] + }, + "item_comment": { + "description": "An informative summary of the list item.", + "example": "Private IP address", + "type": "string" + }, + "item_hostname": { + "description": "Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the hyphen (-).", + "properties": { "url_hostname": { "example": "example.com", "type": "string" } }, + "required": ["url_hostname"], + "type": "string" + }, + "item_id": { + "description": "The unique ID of the item in the List.", + "example": "34b12448945f11eaa1b71c4d701ab86e", + "type": "string" + }, + "item_ip": { + "description": "An IPv4 address, an IPv4 CIDR, or an IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /64.", + "example": "10.0.0.1", + "type": "string" + }, + "item_redirect": { + "description": "The definition of the redirect.", + "properties": { + "include_subdomains": { "default": false, "type": "boolean" }, + "preserve_path_suffix": { "default": true, "type": "boolean" }, + "preserve_query_string": { "default": false, "type": "boolean" }, + "source_url": { "example": "example.com/arch", "type": "string" }, + "status_code": { "default": 301, "enum": [301, 302, 307, 308], "type": "integer" }, + "subpath_matching": { "default": false, "type": "boolean" }, + "target_url": { "example": "https://archlinux.org/", "type": "string" } + }, + "required": ["source_url", "target_url"], + "type": "object" + }, + "items": { + "description": "The items in the List.", + "items": { + "properties": { + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "value": { "$ref": "#/components/schemas/value" } + }, + "type": "object" + }, + "type": "array" + }, + "items-ExjoSuj9": { "items": { "$ref": "#/components/schemas/item" }, "type": "array" }, + "items-list-response-collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "$ref": "#/components/schemas/items-ExjoSuj9" }, + "result_info": { + "properties": { + "cursors": { + "properties": { + "after": { "example": "yyy", "type": "string" }, + "before": { "example": "xxx", "type": "string" } + }, + "type": "object" + } + }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "items-update-request-collection": { + "items": { + "allOf": [ + { + "oneOf": [{ "required": ["ip"] }, { "required": ["redirect"] }, { "required": ["hostname"] }], + "properties": { + "comment": { "$ref": "#/components/schemas/item_comment" }, + "ip": { "$ref": "#/components/schemas/item_ip" }, + "redirect": { "$ref": "#/components/schemas/item_redirect" } + }, + "type": "object" + } + ] + }, + "type": "array" + }, + "ixfr_enable": { + "description": "Enable IXFR transfer protocol, default is AXFR. Only applicable to secondary zones.", + "example": false, + "type": "boolean" + }, + "js_integrity_score": { + "description": "The integrity score of the JavaScript content.", + "maximum": 99, + "minimum": 1, + "nullable": true, + "type": "integer" + }, + "json_response_enabled": { + "default": false, + "description": "Only available for the Waiting Room Advanced subscription. If `true`, requests to the waiting room with the header `Accept: application/json` will receive a JSON response object with information on the user's status in the waiting room as opposed to the configured static HTML page. This JSON response object has one property `cfWaitingRoom` which is an object containing the following fields:\n1. `inWaitingRoom`: Boolean indicating if the user is in the waiting room (always **true**).\n2. `waitTimeKnown`: Boolean indicating if the current estimated wait times are accurate. If **false**, they are not available.\n3. `waitTime`: Valid only when `waitTimeKnown` is **true**. Integer indicating the current estimated time in minutes the user will wait in the waiting room. When `queueingMethod` is **random**, this is set to `waitTime50Percentile`.\n4. `waitTime25Percentile`: Valid only when `queueingMethod` is **random** and `waitTimeKnown` is **true**. Integer indicating the current estimated maximum wait time for the 25% of users that gain entry the fastest (25th percentile).\n5. `waitTime50Percentile`: Valid only when `queueingMethod` is **random** and `waitTimeKnown` is **true**. Integer indicating the current estimated maximum wait time for the 50% of users that gain entry the fastest (50th percentile). In other words, half of the queued users are expected to let into the origin website before `waitTime50Percentile` and half are expected to be let in after it.\n6. `waitTime75Percentile`: Valid only when `queueingMethod` is **random** and `waitTimeKnown` is **true**. Integer indicating the current estimated maximum wait time for the 75% of users that gain entry the fastest (75th percentile).\n7. `waitTimeFormatted`: String displaying the `waitTime` formatted in English for users. If `waitTimeKnown` is **false**, `waitTimeFormatted` will display **unavailable**.\n8. `queueIsFull`: Boolean indicating if the waiting room's queue is currently full and not accepting new users at the moment.\n9. `queueAll`: Boolean indicating if all users will be queued in the waiting room and no one will be let into the origin website.\n10. `lastUpdated`: String displaying the timestamp as an ISO 8601 string of the user's last attempt to leave the waiting room and be let into the origin website. The user is able to make another attempt after `refreshIntervalSeconds` past this time. If the user makes a request too soon, it will be ignored and `lastUpdated` will not change.\n11. `refreshIntervalSeconds`: Integer indicating the number of seconds after `lastUpdated` until the user is able to make another attempt to leave the waiting room and be let into the origin website. When the `queueingMethod` is `reject`, there is no specified refresh time — it will always be **zero**.\n12. `queueingMethod`: The queueing method currently used by the waiting room. It is either **fifo**, **random**, **passthrough**, or **reject**.\n13. `isFIFOQueue`: Boolean indicating if the waiting room uses a FIFO (First-In-First-Out) queue.\n14. `isRandomQueue`: Boolean indicating if the waiting room uses a Random queue where users gain access randomly.\n15. `isPassthroughQueue`: Boolean indicating if the waiting room uses a passthrough queue. Keep in mind that when passthrough is enabled, this JSON response will only exist when `queueAll` is **true** or `isEventPrequeueing` is **true** because in all other cases requests will go directly to the origin.\n16. `isRejectQueue`: Boolean indicating if the waiting room uses a reject queue.\n17. `isEventActive`: Boolean indicating if an event is currently occurring. Events are able to change a waiting room's behavior during a specified period of time. For additional information, look at the event properties `prequeue_start_time`, `event_start_time`, and `event_end_time` in the documentation for creating waiting room events. Events are considered active between these start and end times, as well as during the prequeueing period if it exists.\n18. `isEventPrequeueing`: Valid only when `isEventActive` is **true**. Boolean indicating if an event is currently prequeueing users before it starts.\n19. `timeUntilEventStart`: Valid only when `isEventPrequeueing` is **true**. Integer indicating the number of minutes until the event starts.\n20. `timeUntilEventStartFormatted`: String displaying the `timeUntilEventStart` formatted in English for users. If `isEventPrequeueing` is **false**, `timeUntilEventStartFormatted` will display **unavailable**.\n21. `timeUntilEventEnd`: Valid only when `isEventActive` is **true**. Integer indicating the number of minutes until the event ends.\n22. `timeUntilEventEndFormatted`: String displaying the `timeUntilEventEnd` formatted in English for users. If `isEventActive` is **false**, `timeUntilEventEndFormatted` will display **unavailable**.\n23. `shuffleAtEventStart`: Valid only when `isEventActive` is **true**. Boolean indicating if the users in the prequeue are shuffled randomly when the event starts.\n\nAn example cURL to a waiting room could be:\n\n\tcurl -X GET \"https://example.com/waitingroom\" \\\n\t\t-H \"Accept: application/json\"\n\nIf `json_response_enabled` is **true** and the request hits the waiting room, an example JSON response when `queueingMethod` is **fifo** and no event is active could be:\n\n\t{\n\t\t\"cfWaitingRoom\": {\n\t\t\t\"inWaitingRoom\": true,\n\t\t\t\"waitTimeKnown\": true,\n\t\t\t\"waitTime\": 10,\n\t\t\t\"waitTime25Percentile\": 0,\n\t\t\t\"waitTime50Percentile\": 0,\n\t\t\t\"waitTime75Percentile\": 0,\n\t\t\t\"waitTimeFormatted\": \"10 minutes\",\n\t\t\t\"queueIsFull\": false,\n\t\t\t\"queueAll\": false,\n\t\t\t\"lastUpdated\": \"2020-08-03T23:46:00.000Z\",\n\t\t\t\"refreshIntervalSeconds\": 20,\n\t\t\t\"queueingMethod\": \"fifo\",\n\t\t\t\"isFIFOQueue\": true,\n\t\t\t\"isRandomQueue\": false,\n\t\t\t\"isPassthroughQueue\": false,\n\t\t\t\"isRejectQueue\": false,\n\t\t\t\"isEventActive\": false,\n\t\t\t\"isEventPrequeueing\": false,\n\t\t\t\"timeUntilEventStart\": 0,\n\t\t\t\"timeUntilEventStartFormatted\": \"unavailable\",\n\t\t\t\"timeUntilEventEnd\": 0,\n\t\t\t\"timeUntilEventEndFormatted\": \"unavailable\",\n\t\t\t\"shuffleAtEventStart\": false\n\t\t}\n\t}\n\nIf `json_response_enabled` is **true** and the request hits the waiting room, an example JSON response when `queueingMethod` is **random** and an event is active could be:\n\n\t{\n\t\t\"cfWaitingRoom\": {\n\t\t\t\"inWaitingRoom\": true,\n\t\t\t\"waitTimeKnown\": true,\n\t\t\t\"waitTime\": 10,\n\t\t\t\"waitTime25Percentile\": 5,\n\t\t\t\"waitTime50Percentile\": 10,\n\t\t\t\"waitTime75Percentile\": 15,\n\t\t\t\"waitTimeFormatted\": \"5 minutes to 15 minutes\",\n\t\t\t\"queueIsFull\": false,\n\t\t\t\"queueAll\": false,\n\t\t\t\"lastUpdated\": \"2020-08-03T23:46:00.000Z\",\n\t\t\t\"refreshIntervalSeconds\": 20,\n\t\t\t\"queueingMethod\": \"random\",\n\t\t\t\"isFIFOQueue\": false,\n\t\t\t\"isRandomQueue\": true,\n\t\t\t\"isPassthroughQueue\": false,\n\t\t\t\"isRejectQueue\": false,\n\t\t\t\"isEventActive\": true,\n\t\t\t\"isEventPrequeueing\": false,\n\t\t\t\"timeUntilEventStart\": 0,\n\t\t\t\"timeUntilEventStartFormatted\": \"unavailable\",\n\t\t\t\"timeUntilEventEnd\": 15,\n\t\t\t\"timeUntilEventEndFormatted\": \"15 minutes\",\n\t\t\t\"shuffleAtEventStart\": true\n\t\t}\n\t}.", + "example": false, + "type": "boolean" + }, + "jwk": { + "description": "The signing key in JWK format.", + "example": "eyJ1c2UiOiJzaWciLCJrdHkiOiJSU0EiLCJraWQiOiI1MjEzY2ZhMTIxZjcwYjhjMTM4MDY4NmZmYzM3MWJhMyIsImFsZyI6IlJTMjU2IiwibiI6IjBUandqT2laV21KNDN2ZjNUbzREb1htWFd0SkdOR3lYZmh5dHRMYUJnRjEtRVFXUURLaG9LYm9hS21xakNBc21za3V0YkxVN1BVOGRrUU5ER1p3S3VWczA4elNaNGt4aTR0RWdQUFp5dDdkWEMtbFlSWW95ckFHRjRBWGh5MzI5YkhDUDFJbHJCQl9Ba0dnbmRMQWd1bnhZMHJSZ2N2T3ppYXc2S0p4Rm5jMlVLMFdVOGIwcDRLS0hHcDFLTDlkazBXVDhkVllxYmVSaUpqQ2xVRW1oOHl2OUNsT1ZhUzRLeGlYNnhUUTREWnc2RGFKZklWM1F0Tmd2cG1ieWxOSmFQSG5zc3JodDJHS1A5NjJlS2poUVJsaWd2SFhKTE9uSm9KZkxlSUVIWi1peFdmY1RETUg5MnNHdm93MURPanhMaUNOMXpISy1oN2JMb1hUaUxnYzRrdyIsImUiOiJBUUFCIiwiZCI6IndpQWEwaU5mWnNYSGNOcVMxSWhnUmdzVHJHay1TcFlYV2lReDZHTU9kWlJKekhGazN0bkRERFJvNHNKZTBxX0dEOWkzNlEyZkVadS15elpEcEJkc3U5OHNtaHhNU19Ta0s5X3VFYUo1Zm96V2IyN3JRRnFoLVliUU9MUThkUnNPRHZmQl9Hb2txWWJzblJDR3kzWkFaOGZJZ25ocXBUNEpiOHdsaWxpMUgxeFpzM3RnTWtkTEluTm1yMFAtcTYxZEtNd3JYZVRoSWNEc0kyb2Z1LTFtRm1MWndQb2ZGbmxaTW9QN1pfRU5pUGNfWGtWNzFhaHBOZE9pcW5ablZtMHBCNE5QS1UweDRWTjQyYlAzWEhMUmpkV2hJOGt3SC1BdXhqb3BLaHJ0R2tvcG1jZFRkM1ZRdElaOGRpZHByMXpBaEpvQi16ZVlIaTFUel9ZSFFld0FRUSIsInAiOiIyVTZFVUJka3U3TndDYXoyNzZuWGMxRXgwVHpNZjU4U0UtU2M2eUNaYWk2TkwzVURpWi1mNHlIdkRLYnFGUXdLWDNwZ0l2aVE3Y05QYUpkbE9NeS1mU21GTXU3V3hlbVZYamFlTjJCMkRDazhQY0NEOVgxU2hhR3E1ZUdSSHNObVUtSDNxTG1FRGpjLWliazRHZ0RNb2lVYjQ2OGxFZHAwU2pIOXdsOUdsYTgiLCJxIjoiOW5ucXg5ZnNNY2dIZ29DemhfVjJmaDhoRUxUSUM5aFlIOVBCTG9aQjZIaE1TWG1ja1BSazVnUlpPWlFEN002TzlMaWZjNmFDVXdEbjBlQzU2YkFDNUNrcWxjODJsVDhzTWlMeWJyTjh3bWotcjNjSTBGQTlfSGQySEY1ZkgycnJmenVqd0NWM3czb09Ud3p4d1g3c2xKbklRanphel91SzEyWEtucVZZcUYwIiwiZHAiOiJxQklTUTlfVUNWaV9Ucng0UU9VYnZoVU9jc2FUWkNHajJiNzNudU9YeElnOHFuZldSSnN4RG5zd2FKaXdjNWJjYnZ3M1h0VGhRd1BNWnhpeE1UMHFGNlFGWVY5WXZibnJ6UEp4YkdNdTZqajZYc2lIUjFlbWU3U09lVDM4Xzg0aFZyOXV6UkN2RWstb0R0MHlodW9YVzFGWVFNRTE2cGtMV0ZkUjdRUERsQUUiLCJkcSI6Im5zQUp3eXZFbW8tdW5wU01qYjVBMHB6MExCRjBZNFMxeGRJYXNfLVBSYzd0dThsVFdWMl8teExEOFR6dmhqX0lmY0RJR3JJZGNKNjlzVVZnR1M3ZnZkcng3Y21uNjFyai1XcmU0UVJFRC1lV1dxZDlpc2FVRmg5UGVKZ2tCbFZVVnYtdnladVlWdFF2a1NUU05ZR3RtVXl2V2xKZDBPWEFHRm9jdGlfak9aVSIsInFpIjoib0dYaWxLQ2NKRXNFdEE1eG54WUdGQW5UUjNwdkZLUXR5S0F0UGhHaHkybm5ya2VzN1RRaEFxMGhLRWZtU1RzaE1hNFhfd05aMEstX1F0dkdoNDhpeHdTTDVLTEwxZnFsY0k2TF9XUnF0cFQxS21LRERlUHR2bDVCUzFGbjgwSGFwR215cmZRWUU4S09QR2UwUl82S1BOZE1vc3dYQ3Nfd0RYMF92ZzNoNUxRIn0=", + "readOnly": true, + "type": "string" + }, + "key": { + "description": "A name for a value. A value stored under a given key may be retrieved via the same key.", + "properties": { + "expiration": { + "description": "The time, measured in number of seconds since the UNIX epoch, at which the key will expire. This property is omitted for keys that will not expire.", + "example": 1577836800, + "type": "number" + }, + "metadata": { "$ref": "#/components/schemas/list_metadata" }, + "name": { "$ref": "#/components/schemas/key_name" } + }, + "required": ["name"], + "type": "object" + }, + "key-sOXCdDRQ": { + "description": "The device's public key.", + "example": "yek0SUYoOQ10vMGsIYAevozXUQpQtNFJFfFGqER/BGc=", + "type": "string" + }, + "key_config": { + "properties": { + "days_until_next_rotation": { "$ref": "#/components/schemas/days_until_next_rotation" }, + "key_rotation_interval_days": { "$ref": "#/components/schemas/key_rotation_interval_days" }, + "last_key_rotation_at": { "$ref": "#/components/schemas/last_key_rotation_at" } + }, + "type": "object" + }, + "key_generation_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "$ref": "#/components/schemas/keys-iPBE1L5T" } } } + ] + }, + "key_name": { + "description": "A key's name. The name may be at most 512 bytes. All printable, non-whitespace characters are valid. Use percent-encoding to define key names as part of a URL.", + "example": "My-Key", + "maxLength": 512, + "type": "string" + }, + "key_name_bulk": { + "description": "A key's name. The name may be at most 512 bytes. All printable, non-whitespace characters are valid.", + "example": "My-Key", + "maxLength": 512, + "type": "string" + }, + "key_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "$ref": "#/components/schemas/keys_response" } } } + ] + }, + "key_response_collection-FpLR6Wht": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "items": { + "properties": { + "created": { "$ref": "#/components/schemas/signing_key_created" }, + "id": { "$ref": "#/components/schemas/schemas-identifier" } + }, + "type": "object" + }, + "type": "array" + } + } + } + ] + }, + "key_rotation_interval_days": { + "description": "The number of days between key rotations.", + "example": 30, + "maximum": 365, + "minimum": 21, + "type": "number" + }, + "key_tag": { + "description": "Code for key tag.", + "example": 42, + "nullable": true, + "readOnly": true, + "type": "number" + }, + "key_type": { + "description": "Algorithm key type.", + "example": "ECDSAP256SHA256", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "keyless-certificate": { "allOf": [{ "$ref": "#/components/schemas/base-cc0u02EK" }], "type": "object" }, + "keyless-certificate-1A90AEZs": { + "allOf": [{ "$ref": "#/components/schemas/components-schemas-base" }], + "type": "object" + }, + "keyless-certificate_components-schemas-identifier": { + "description": "Keyless certificate identifier tag.", + "example": "4d2844d2ce78891c34d0b6c0535a291e", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "keyless-certificate_components-schemas-name": { + "description": "The keyless SSL name.", + "example": "example.com Keyless SSL", + "maxLength": 180, + "readOnly": true, + "type": "string" + }, + "keyless-certificate_components-schemas-status": { + "description": "Status of the Keyless SSL.", + "enum": ["active", "deleted"], + "example": "active", + "readOnly": true, + "type": "string" + }, + "keyless_private_ip": { + "description": "Private IP of the Key Server Host", + "example": "10.0.0.1", + "type": "string" + }, + "keyless_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/keyless-certificate-1A90AEZs" }, "type": "array" } + } + } + ] + }, + "keyless_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { "allOf": [{ "$ref": "#/components/schemas/base-cc0u02EK" }], "type": "object" } + } + } + ] + }, + "keyless_response_single-D6V6oKzw": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } } } + ] + }, + "keyless_response_single_id": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { "id": { "$ref": "#/components/schemas/identifier-tZwYoMuc" } }, + "type": "object" + } + } + } + ] + }, + "keyless_response_single_id-oOZ29VcY": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "id": { "$ref": "#/components/schemas/keyless-certificate_components-schemas-identifier" } + }, + "type": "object" + } + } + } + ] + }, + "keyless_tunnel": { + "description": "Configuration for using Keyless SSL through a Cloudflare Tunnel", + "properties": { + "private_ip": { "$ref": "#/components/schemas/keyless_private_ip" }, + "vnet_id": { "$ref": "#/components/schemas/keyless_vnet_id" } + }, + "required": ["private_ip", "vnet_id"], + "type": "object" + }, + "keyless_vnet_id": { + "description": "Cloudflare Tunnel Virtual Network ID", + "example": "7365377a-85a4-4390-9480-531ef7dc7a3c", + "type": "string" + }, + "keys": { + "properties": { + "name": { "$ref": "#/components/schemas/keys_components-schemas-name" }, + "value": { "$ref": "#/components/schemas/keys_components-schemas-value" } + }, + "type": "object" + }, + "keys-iPBE1L5T": { + "properties": { + "created": { "$ref": "#/components/schemas/signing_key_created" }, + "id": { "$ref": "#/components/schemas/schemas-identifier" }, + "jwk": { "$ref": "#/components/schemas/jwk" }, + "pem": { "$ref": "#/components/schemas/pem" } + }, + "type": "object" + }, + "keys_components-schemas-name": { + "description": "Key name.", + "example": "default", + "readOnly": true, + "type": "string" + }, + "keys_components-schemas-single_response": { + "allOf": [{ "$ref": "#/components/schemas/api-response-single" }, { "$ref": "#/components/schemas/key_config" }] + }, + "keys_components-schemas-value": { + "description": "Key value.", + "example": "Oix0bbNaT8Rge9PuyxUBrjI6zrgnsyJ5=", + "readOnly": true, + "type": "string" + }, + "keys_response": { + "properties": { "keys": { "items": { "$ref": "#/components/schemas/keys" }, "type": "array" } }, + "type": "object" + }, + "kind": { + "description": "The type of the membership.", + "enum": ["zone", "account"], + "example": "zone", + "type": "string" + }, + "kind-ZDHCkJmG": { + "description": "The type of the list. Each type supports specific list items (IP addresses, hostnames or redirects).", + "enum": ["ip", "redirect", "hostname"], + "example": "ip", + "type": "string" + }, + "kolide_config_request": { + "properties": { + "client_id": { "description": "The Kolide client ID.", "example": "example client id", "type": "string" }, + "client_secret": { + "description": "The Kolide client secret.", + "example": "example client secret", + "type": "string" + } + }, + "required": ["client_id", "client_secret"], + "type": "object" + }, + "kv_components-schemas-value": { + "description": "A byte sequence to be stored, up to 10 MB in length.", + "example": "Some Value", + "type": "string" + }, + "kv_namespace_binding": { + "properties": { + "name": { "$ref": "#/components/schemas/binding_name" }, + "namespace_id": { "$ref": "#/components/schemas/namespace_identifier" }, + "type": { + "description": "The class of resource that the binding provides.", + "enum": ["kv_namespace"], + "example": "kv_namespace", + "type": "string" + } + }, + "required": ["name", "type", "namespace_id"], + "type": "object" + }, + "label": { + "description": "The language label displayed in the native language to users.", + "example": "Türkçe", + "readOnly": true, + "type": "string" + }, + "labels": { + "description": "Field appears if there is an additional annotation printed when the probe returns. Field also appears when running a GRE+ICMP traceroute to denote which traceroute a node comes from.", + "items": { "type": "string" }, + "type": "array" + }, + "language": { + "description": "The language tag in BCP 47 format.", + "example": "tr", + "readOnly": true, + "type": "string" + }, + "language_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/captions" }, "type": "array" } } } + ] + }, + "language_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } } } + ] + }, + "last_complete": { + "description": "Records the last time for which logs have been successfully pushed. If the last successful push was for logs range 2018-07-23T10:00:00Z to 2018-07-23T10:01:00Z then the value of this field will be 2018-07-23T10:01:00Z. If the job has never run or has just been enabled and hasn't run yet then the field will be empty.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "last_error": { + "description": "Records the last time the job failed. If not null, the job is currently failing. If null, the job has either never failed or has run successfully at least once since last failure. See also the error_message field.", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "last_failure": { + "description": "Timestamp of the last time an attempt to dispatch a notification to this webhook failed.", + "example": "2020-10-26T18:25:04.532316Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "last_key_rotation_at": { + "description": "The timestamp of the previous key rotation.", + "example": "2014-01-01T05:20:00.12345Z", + "format": "date-time", + "type": "string" + }, + "last_name": { + "description": "User's last name", + "example": "Appleseed", + "maxLength": 60, + "nullable": true, + "type": "string" + }, + "last_seen": { + "description": "When the device last connected to Cloudflare services.", + "example": "2017-06-14T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "last_success": { + "description": "Timestamp of the last time Cloudflare was able to successfully dispatch a notification using this webhook.", + "example": "2020-10-26T18:25:04.532316Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "last_successful_login": { + "description": "The time at which the user last successfully logged in.", + "example": "2020-07-01T05:20:00Z", + "format": "date-time", + "type": "string" + }, + "last_updated": { + "description": "The timestamp of when the ruleset was last modified.", + "example": "2000-01-01T00:00:00.000000Z", + "type": "string" + }, + "latitude": { + "description": "The latitude of the data center containing the origins used in this pool in decimal degrees. If this is set, longitude must also be set.", + "type": "number" + }, + "legacy_discount": { + "default": false, + "description": "Indicates whether this plan has a legacy discount applied.", + "example": false, + "type": "boolean" + }, + "legacy_id": { + "description": "The legacy identifier for this rate plan, if any.", + "example": "free", + "readOnly": true, + "type": "string" + }, + "limit": { + "default": 100000, + "description": "Limit number of returned metrics.", + "example": 100, + "type": "integer" + }, + "linkedin": { + "allOf": [ + { "$ref": "#/components/schemas/identity-provider" }, + { "properties": { "config": { "$ref": "#/components/schemas/generic-oauth-config" } }, "type": "object" } + ], + "title": "LinkedIn", + "type": "object" + }, + "list": { + "properties": { + "created_on": { "$ref": "#/components/schemas/schemas-created_on-KZj9IpMd" }, + "description": { "$ref": "#/components/schemas/lists_components-schemas-description" }, + "id": { "$ref": "#/components/schemas/list_id" }, + "kind": { "$ref": "#/components/schemas/kind-ZDHCkJmG" }, + "modified_on": { "$ref": "#/components/schemas/lists_components-schemas-modified_on" }, + "name": { "$ref": "#/components/schemas/lists_components-schemas-name" }, + "num_items": { "$ref": "#/components/schemas/num_items" }, + "num_referencing_filters": { "$ref": "#/components/schemas/num_referencing_filters" } + } + }, + "list-delete-response-collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "properties": { "id": { "$ref": "#/components/schemas/item_id" } }, "type": "object" } + }, + "type": "object" + } + ] + }, + "list-response-collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "$ref": "#/components/schemas/list" } }, "type": "object" } + ] + }, + "list-zone-connections-response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/connection" }, "type": "array" }, + "result_info": { "$ref": "#/components/schemas/result_info" } + }, + "type": "object" + } + ] + }, + "list-zone-scripts-response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/script" }, "type": "array" }, + "result_info": { "$ref": "#/components/schemas/result_info" } + }, + "type": "object" + } + ] + }, + "list_id": { + "description": "The unique ID of the list.", + "example": "2c0fc9fa937b11eaa1b71c4d701ab86e", + "maxLength": 32, + "minLength": 32, + "readOnly": true, + "type": "string" + }, + "list_item_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/items" }, "type": "array" } } }, + { + "properties": { + "result_info": { + "properties": { + "count": { + "description": "Total results returned based on your search parameters.", + "example": 1, + "type": "number" + }, + "page": { + "description": "Current page within paginated list of results.", + "example": 1, + "type": "number" + }, + "per_page": { + "description": "Number of results per page of results.", + "example": 20, + "type": "number" + }, + "total_count": { + "description": "Total results available without any search parameters.", + "example": 2000, + "type": "number" + } + }, + "type": "object" + } + } + } + ] + }, + "list_metadata": { + "description": "Arbitrary JSON that is associated with a key.", + "example": { "someMetadataKey": "someMetadataValue" }, + "type": "object" + }, + "lists": { + "properties": { + "count": { "$ref": "#/components/schemas/count" }, + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "description": { "$ref": "#/components/schemas/description" }, + "id": { "$ref": "#/components/schemas/uuid" }, + "name": { "$ref": "#/components/schemas/name" }, + "type": { "$ref": "#/components/schemas/type" }, + "updated_at": { "$ref": "#/components/schemas/timestamp" } + }, + "type": "object" + }, + "lists-async-response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "properties": { "operation_id": { "$ref": "#/components/schemas/operation_id" } }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + "lists-response-collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "items": { + "allOf": [ + { "$ref": "#/components/schemas/list" }, + { "required": ["id", "name", "kind", "num_items", "created_on", "modified_on"], "type": "object" } + ] + }, + "type": "array" + } + }, + "type": "object" + } + ] + }, + "lists_components-schemas-description": { + "description": "An informative summary of the list.", + "example": "This is a note.", + "maxLength": 500, + "type": "string" + }, + "lists_components-schemas-modified_on": { + "description": "The RFC 3339 timestamp of when the list was last modified.", + "example": "2020-01-10T14:00:00Z", + "type": "string" + }, + "lists_components-schemas-name": { + "description": "An informative name for the list. Use this name in filter and rule expressions.", + "example": "list1", + "maxLength": 50, + "pattern": "^[a-zA-Z0-9_]+$", + "type": "string" + }, + "liveInput": { + "description": "The live input ID used to upload a video with Stream Live.", + "example": "fc0a8dc887b16759bfd9ad922230a014", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "live_input": { + "description": "Details about a live input.", + "properties": { + "created": { "$ref": "#/components/schemas/live_input_created" }, + "meta": { "$ref": "#/components/schemas/live_input_metadata" }, + "modified": { "$ref": "#/components/schemas/live_input_modified" }, + "recording": { "$ref": "#/components/schemas/live_input_recording_settings" }, + "rtmps": { "$ref": "#/components/schemas/input_rtmps" }, + "rtmpsPlayback": { "$ref": "#/components/schemas/playback_rtmps" }, + "srt": { "$ref": "#/components/schemas/input_srt" }, + "srtPlayback": { "$ref": "#/components/schemas/playback_srt" }, + "status": { "$ref": "#/components/schemas/live_input_status" }, + "uid": { "$ref": "#/components/schemas/live_input_identifier" }, + "webRTC": { "$ref": "#/components/schemas/input_webrtc" }, + "webRTCPlayback": { "$ref": "#/components/schemas/playback_webrtc" } + }, + "type": "object" + }, + "live_input_created": { + "description": "The date and time the live input was created.", + "example": "2014-01-02T02:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "live_input_default_creator": { + "description": "Sets the creator ID asssociated with this live input.", + "type": "string" + }, + "live_input_identifier": { + "description": "A unique identifier for a live input.", + "example": "66be4bf738797e01e1fca35a7bdecdcd", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "live_input_metadata": { + "description": "A user modifiable key-value store used to reference other systems of record for managing live inputs.", + "example": { "name": "test stream 1" }, + "type": "object" + }, + "live_input_modified": { + "description": "The date and time the live input was last modified.", + "example": "2014-01-02T02:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "live_input_object_without_url": { + "properties": { + "created": { "$ref": "#/components/schemas/live_input_created" }, + "meta": { "$ref": "#/components/schemas/live_input_metadata" }, + "modified": { "$ref": "#/components/schemas/live_input_modified" }, + "uid": { "$ref": "#/components/schemas/live_input_identifier" } + } + }, + "live_input_recording_allowedOrigins": { + "description": "Lists the origins allowed to display videos created with this input. Enter allowed origin domains in an array and use `*` for wildcard subdomains. An empty array allows videos to be viewed on any origin.", + "example": ["example.com"], + "items": { "type": "string" }, + "type": "array" + }, + "live_input_recording_mode": { + "default": "off", + "description": "Specifies the recording behavior for the live input. Set this value to `off` to prevent a recording. Set the value to `automatic` to begin a recording and transition to on-demand after Stream Live stops receiving input.", + "enum": ["off", "automatic"], + "example": "automatic", + "type": "string" + }, + "live_input_recording_requireSignedURLs": { + "default": false, + "description": "Indicates if a video using the live input has the `requireSignedURLs` property set. Also enforces access controls on any video recording of the livestream with the live input.", + "example": true, + "type": "boolean" + }, + "live_input_recording_settings": { + "description": "Records the input to a Cloudflare Stream video. Behavior depends on the mode. In most cases, the video will initially be viewable as a live video and transition to on-demand after a condition is satisfied.", + "example": { "mode": "off", "requireSignedURLs": false, "timeoutSeconds": 0 }, + "properties": { + "allowedOrigins": { "$ref": "#/components/schemas/live_input_recording_allowedOrigins" }, + "mode": { "$ref": "#/components/schemas/live_input_recording_mode" }, + "requireSignedURLs": { "$ref": "#/components/schemas/live_input_recording_requireSignedURLs" }, + "timeoutSeconds": { "$ref": "#/components/schemas/live_input_recording_timeoutSeconds" } + }, + "type": "object" + }, + "live_input_recording_timeoutSeconds": { + "default": 0, + "description": "Determines the amount of time a live input configured in `automatic` mode should wait before a recording transitions from live to on-demand. `0` is recommended for most use cases and indicates the platform default should be used.", + "type": "integer" + }, + "live_input_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "properties": { + "liveInputs": { + "items": { "$ref": "#/components/schemas/live_input_object_without_url" }, + "type": "array" + }, + "range": { + "description": "The total number of remaining live inputs based on cursor position.", + "example": 1000, + "readOnly": true, + "type": "integer" + }, + "total": { + "description": "The total number of live inputs that match the provided filters.", + "example": 35586, + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + } + } + } + ] + }, + "live_input_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/live_input" } } } + ] + }, + "live_input_status": { + "description": "The connection status of a live input.", + "enum": [ + null, + "connected", + "reconnected", + "reconnecting", + "client_disconnect", + "ttl_exceeded", + "failed_to_connect", + "failed_to_reconnect", + "new_configuration_accepted" + ], + "nullable": true, + "readOnly": true, + "type": "string" + }, + "loa_document_identifier": { + "description": "Identifier for the uploaded LOA document.", + "example": "d933b1530bc56c9953cf8ce166da8004", + "maxLength": 32, + "nullable": true, + "type": "string" + }, + "loa_document_identifier-eboVwtvp": { + "description": "Identifier for the uploaded LOA document.", + "example": "d933b1530bc56c9953cf8ce166da8004", + "maxLength": 32, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "loa_upload_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "filename": { "description": "Name of LOA document.", "example": "document.pdf", "type": "string" } + }, + "type": "object" + } + } + } + ] + }, + "load-balancer": { + "properties": { + "adaptive_routing": { "$ref": "#/components/schemas/adaptive_routing" }, + "country_pools": { "$ref": "#/components/schemas/country_pools" }, + "created_on": { "$ref": "#/components/schemas/timestamp" }, + "default_pools": { "$ref": "#/components/schemas/default_pools" }, + "description": { "$ref": "#/components/schemas/load-balancer_components-schemas-description" }, + "enabled": { "$ref": "#/components/schemas/load-balancer_components-schemas-enabled" }, + "fallback_pool": { "$ref": "#/components/schemas/fallback_pool" }, + "id": { "$ref": "#/components/schemas/load-balancer_components-schemas-identifier" }, + "location_strategy": { "$ref": "#/components/schemas/location_strategy" }, + "modified_on": { "$ref": "#/components/schemas/timestamp" }, + "name": { "$ref": "#/components/schemas/load-balancer_components-schemas-name" }, + "pop_pools": { "$ref": "#/components/schemas/pop_pools" }, + "proxied": { "$ref": "#/components/schemas/proxied-ZJJb2RTk" }, + "random_steering": { "$ref": "#/components/schemas/random_steering" }, + "region_pools": { "$ref": "#/components/schemas/region_pools" }, + "rules": { "$ref": "#/components/schemas/components-schemas-rules" }, + "session_affinity": { "$ref": "#/components/schemas/session_affinity" }, + "session_affinity_attributes": { "$ref": "#/components/schemas/session_affinity_attributes" }, + "session_affinity_ttl": { "$ref": "#/components/schemas/session_affinity_ttl" }, + "steering_policy": { "$ref": "#/components/schemas/steering_policy" }, + "ttl": { "$ref": "#/components/schemas/ttl-vFKh1wOV" } + }, + "type": "object" + }, + "load-balancer-ZLoHsRks": { + "properties": { + "adaptive_routing": { "$ref": "#/components/schemas/adaptive_routing" }, + "country_pools": { "$ref": "#/components/schemas/country_pools" }, + "created_on": { "$ref": "#/components/schemas/timestamp" }, + "default_pools": { "$ref": "#/components/schemas/default_pools" }, + "description": { "$ref": "#/components/schemas/components-schemas-description-UH5FN4sh" }, + "enabled": { "$ref": "#/components/schemas/components-schemas-enabled-tktxdyPy" }, + "fallback_pool": { "$ref": "#/components/schemas/fallback_pool" }, + "id": { "$ref": "#/components/schemas/load-balancer_components-schemas-identifier" }, + "location_strategy": { "$ref": "#/components/schemas/location_strategy" }, + "modified_on": { "$ref": "#/components/schemas/timestamp" }, + "name": { "$ref": "#/components/schemas/components-schemas-name-h5gI0ndx" }, + "pop_pools": { "$ref": "#/components/schemas/pop_pools" }, + "proxied": { "$ref": "#/components/schemas/proxied-ZGed5Tdg" }, + "random_steering": { "$ref": "#/components/schemas/random_steering" }, + "region_pools": { "$ref": "#/components/schemas/region_pools" }, + "rules": { "$ref": "#/components/schemas/rules-8L4eu614" }, + "session_affinity": { "$ref": "#/components/schemas/session_affinity" }, + "session_affinity_attributes": { "$ref": "#/components/schemas/session_affinity_attributes" }, + "session_affinity_ttl": { "$ref": "#/components/schemas/session_affinity_ttl" }, + "steering_policy": { "$ref": "#/components/schemas/steering_policy" }, + "ttl": { "$ref": "#/components/schemas/ttl-0jCBhfJ2" } + }, + "type": "object" + }, + "load-balancer_components-schemas-description": { + "description": "Object description.", + "example": "Load Balancer for www.example.com", + "type": "string" + }, + "load-balancer_components-schemas-enabled": { + "default": true, + "description": "Whether to enable (the default) this load balancer.", + "example": true, + "type": "boolean" + }, + "load-balancer_components-schemas-identifier": { "example": "699d98642c564d2e855e9661899b7252" }, + "load-balancer_components-schemas-name": { + "description": "The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will not be used.", + "example": "www.example.com", + "type": "string" + }, + "load-balancer_components-schemas-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/load-balancer-ZLoHsRks" }, "type": "array" } + } + } + ] + }, + "load-balancer_components-schemas-single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/load-balancer-ZLoHsRks" } } } + ] + }, + "load_shedding": { + "description": "Configures load shedding policies and percentages for the pool.", + "properties": { + "default_percent": { + "default": 0, + "description": "The percent of traffic to shed from the pool, according to the default policy. Applies to new sessions and traffic without session affinity.", + "maximum": 100, + "minimum": 0, + "type": "number" + }, + "default_policy": { + "default": "random", + "description": "The default policy to use when load shedding. A random policy randomly sheds a given percent of requests. A hash policy computes a hash over the CF-Connecting-IP address and sheds all requests originating from a percent of IPs.", + "enum": ["random", "hash"], + "type": "string" + }, + "session_percent": { + "default": 0, + "description": "The percent of existing sessions to shed from the pool, according to the session policy.", + "maximum": 100, + "minimum": 0, + "type": "number" + }, + "session_policy": { + "default": "hash", + "description": "Only the hash policy is supported for existing sessions (to avoid exponential decay).", + "enum": ["hash"], + "type": "string" + } + }, + "type": "object" + }, + "location": { + "description": "Location, provided by the CSR", + "example": "Somewhere", + "readOnly": true, + "type": "string" + }, + "location_strategy": { + "description": "Controls location-based steering for non-proxied requests. See `steering_policy` to learn how steering is affected.", + "properties": { + "mode": { + "default": "pop", + "description": "Determines the authoritative location when ECS is not preferred, does not exist in the request, or its GeoIP lookup is unsuccessful.\n- `\"pop\"`: Use the Cloudflare PoP location.\n- `\"resolver_ip\"`: Use the DNS resolver GeoIP location. If the GeoIP lookup is unsuccessful, use the Cloudflare PoP location.", + "enum": ["pop", "resolver_ip"], + "example": "resolver_ip", + "type": "string" + }, + "prefer_ecs": { + "default": "proximity", + "description": "Whether the EDNS Client Subnet (ECS) GeoIP should be preferred as the authoritative location.\n- `\"always\"`: Always prefer ECS.\n- `\"never\"`: Never prefer ECS.\n- `\"proximity\"`: Prefer ECS only when `steering_policy=\"proximity\"`.\n- `\"geo\"`: Prefer ECS only when `steering_policy=\"geo\"`.", + "enum": ["always", "never", "proximity", "geo"], + "example": "always", + "type": "string" + } + }, + "type": "object" + }, + "locations": { + "properties": { + "client_default": { "$ref": "#/components/schemas/client-default" }, + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "doh_subdomain": { "$ref": "#/components/schemas/subdomain" }, + "ecs_support": { "$ref": "#/components/schemas/ecs-support" }, + "id": { "$ref": "#/components/schemas/schemas-uuid" }, + "ip": { "$ref": "#/components/schemas/ip" }, + "name": { "$ref": "#/components/schemas/schemas-name" }, + "networks": { "$ref": "#/components/schemas/network" }, + "updated_at": { "$ref": "#/components/schemas/timestamp" } + }, + "type": "object" + }, + "lockdowns_components-schemas-description": { + "description": "An informative summary of the rule.", + "example": "Restrict access to these endpoints to requests from a known IP address", + "maxLength": 1024, + "type": "string" + }, + "lockdowns_components-schemas-id": { + "description": "The unique identifier of the Zone Lockdown rule.", + "example": "372e67954025e0ba6aaa6d586b9e0b59", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "lockdowns_components-schemas-priority": { + "description": "The priority of the rule to control the processing order. A lower number indicates higher priority. If not provided, any rules with a configured priority will be processed before rules without a priority.", + "example": 5, + "type": "number" + }, + "locked": { + "description": "Shows whether a registrar lock is in place for a domain.", + "example": false, + "type": "boolean" + }, + "logging": { + "description": "An object configuring the rule's logging behavior.", + "example": { "enabled": true }, + "properties": { + "enabled": { + "description": "Whether to generate a log when the rule matches.", + "example": true, + "type": "boolean" + } + }, + "type": "object" + }, + "login_design": { + "properties": { + "background_color": { + "description": "The background color on your login page.", + "example": "#c5ed1b", + "type": "string" + }, + "footer_text": { + "description": "The text at the bottom of your login page.", + "example": "This is an example description.", + "type": "string" + }, + "header_text": { + "description": "The text at the top of your login page.", + "example": "This is an example description.", + "type": "string" + }, + "logo_path": { + "description": "The URL of the logo on your login page.", + "example": "https://example.com/logo.png", + "type": "string" + }, + "text_color": { "description": "The text color on your login page.", "example": "#c5ed1b", "type": "string" } + } + }, + "logo_url": { + "description": "The image URL for the logo shown in the App Launcher dashboard.", + "example": "https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg", + "type": "string" + }, + "logpull_options": { + "description": "Configuration string. It specifies things like requested fields and timestamp formats. If migrating from the logpull api, copy the url (full url or just the query string) of your call here, and logpush will keep on making this call for you, setting start and end times appropriately.", + "example": "fields=RayID,ClientIP,EdgeStartTimestamp\u0026timestamps=rfc3339", + "format": "uri-reference", + "maxLength": 4096, + "nullable": true, + "type": "string" + }, + "logpush": { "description": "Whether Logpush is turned on for the Worker.", "example": false, "type": "boolean" }, + "logpush_field_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { + "properties": { + "result": { + "items": { + "nullable": true, + "properties": { "key": { "example": "value", "type": "string" } }, + "type": "object" + }, + "type": "object" + } + } + } + ] + }, + "logpush_job": { + "nullable": true, + "properties": { + "dataset": { "$ref": "#/components/schemas/dataset" }, + "destination_conf": { "$ref": "#/components/schemas/destination_conf" }, + "enabled": { "$ref": "#/components/schemas/enabled-A6pti18n" }, + "error_message": { "$ref": "#/components/schemas/error_message" }, + "frequency": { "$ref": "#/components/schemas/frequency" }, + "id": { "$ref": "#/components/schemas/id-Un5diNDY" }, + "last_complete": { "$ref": "#/components/schemas/last_complete" }, + "last_error": { "$ref": "#/components/schemas/last_error" }, + "logpull_options": { "$ref": "#/components/schemas/logpull_options" }, + "name": { "$ref": "#/components/schemas/name-rRqaJzmt" } + }, + "type": "object" + }, + "logpush_job_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/logpush_job" }, "type": "array" } } } + ] + }, + "logpush_job_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/logpush_job" } } } + ] + }, + "logs": { + "anyOf": [{ "type": "string" }, { "type": "object" }], + "example": "{\"ClientIP\":\"192.0.2.1\",\"RayID\":\"41ddf1740f67442d\",\"EdgeStartTimestamp\":1526810289280000000}\n{\"ClientIP\":\"192.0.2.1\",\"RayID\":\"41ddf1740f67442d\",\"EdgeStartTimestamp\":1526810289280000000}\n{\"ClientIP\":\"192.0.2.1\",\"RayID\":\"41ddf1740f67442d\",\"EdgeStartTimestamp\":1526810289280000000}" + }, + "longitude": { + "description": "The longitude of the data center containing the origins used in this pool in decimal degrees. If this is set, latitude must also be set.", + "type": "number" + }, + "mac_address": { "description": "The device mac address.", "example": "00-00-5E-00-53-00", "type": "string" }, + "managed_headers_components-schemas-enabled": { + "description": "When true, the Managed Transform is enabled.", + "example": true, + "type": "boolean" + }, + "managed_headers_components-schemas-id": { + "description": "Human-readable identifier of the Managed Transform.", + "example": "add_cf-bot-score_header", + "type": "string" + }, + "manufacturer": { "description": "The device manufacturer name.", "example": "My phone corp", "type": "string" }, + "match": { + "description": "Determines which traffic the rate limit counts towards the threshold.", + "oneOf": [ + { + "properties": { + "headers": { + "items": { + "properties": { + "name": { "$ref": "#/components/schemas/header_name" }, + "op": { "$ref": "#/components/schemas/header_op" }, + "value": { "$ref": "#/components/schemas/header_value" } + }, + "type": "object" + }, + "type": "array" + }, + "request": { + "properties": { + "methods": { "$ref": "#/components/schemas/methods" }, + "schemes": { "$ref": "#/components/schemas/schemes" }, + "url": { "$ref": "#/components/schemas/schemas-url" } + }, + "type": "object" + }, + "response": { + "properties": { "origin_traffic": { "$ref": "#/components/schemas/origin_traffic" } }, + "type": "object" + } + }, + "type": "object" + } + ], + "type": "object" + }, + "match-gWGZ7MOw": { + "description": "The conditions that the client must match to run the rule.", + "items": { "$ref": "#/components/schemas/match_item" }, + "type": "array" + }, + "match_item": { "properties": { "platform": { "$ref": "#/components/schemas/platform" } }, "type": "object" }, + "maxDurationSeconds": { + "description": "The maximum duration in seconds for a video upload. Can be set for a video that is not yet uploaded to limit its duration. Uploads that exceed the specified duration will fail during processing. A value of `-1` means the value is unknown.", + "maximum": 21600, + "minimum": 1, + "type": "integer" + }, + "max_age": { + "description": "The maximum number of seconds the results of a preflight request can be cached.", + "example": -1, + "maximum": 86400, + "minimum": -1, + "type": "number" + }, + "max_estimated_time_minutes": { "type": "integer" }, + "max_retries": { "example": 3, "type": "number" }, + "max_rtt_ms": { "description": "Maximum RTT in ms.", "type": "number" }, + "max_ttl": { "default": 15, "description": "Max TTL.", "maximum": 64, "minimum": 0, "type": "integer" }, + "max_upload": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { + "description": "identifier of the zone setting.", + "enum": ["max_upload"], + "example": "max_upload" + }, + "value": { "$ref": "#/components/schemas/max_upload_value" } + } + } + ], + "description": "Maximum size of an allowable upload.", + "title": "Max Upload" + }, + "max_upload_value": { + "default": 100, + "description": "Value of the zone setting.\nNotes: The size depends on the plan level of the zone. (Enterprise = 500, Business = 200, Pro = 100, Free = 100)", + "enum": [100, 200, 500], + "type": "number" + }, + "max_wait_time_ms": { "example": 5000, "type": "number" }, + "maximum_cache_ttl": { + "default": 900, + "description": "Maximum DNS Cache TTL.", + "example": 900, + "maximum": 36000, + "minimum": 30, + "type": "number" + }, + "mean_rtt_ms": { "description": "Mean RTT in ms.", "type": "number" }, + "mechanism": { + "description": "The mechanism to which the notification has been dispatched.", + "example": "test@example.com", + "type": "string" + }, + "mechanism_type": { + "description": "The type of mechanism to which the notification has been dispatched. This can be email/pagerduty/webhook based on the mechanism configured.", + "enum": ["email", "pagerduty", "webhook"], + "example": "email", + "type": "string" + }, + "mechanisms": { + "additionalProperties": { + "items": { "properties": { "id": { "$ref": "#/components/schemas/uuid-s0SXln0q" } }, "type": "object" }, + "type": "array" + }, + "description": "List of IDs that will be used when dispatching a notification. IDs for email type will be the email address.", + "example": { + "email": [{ "id": "test@example.com" }], + "pagerduty": [{ "id": "e8133a15-00a4-4d69-aec1-32f70c51f6e5" }], + "webhooks": [{ "id": "14cc1190-5d2b-4b98-a696-c424cb2ad05f" }] + }, + "type": "object" + }, + "media_metadata": { + "description": "A user modifiable key-value store used to reference other systems of record for managing videos.", + "example": {}, + "type": "object" + }, + "media_state": { + "description": "Specifies the processing status of the video.", + "enum": ["pendingupload", "downloading", "queued", "inprogress", "ready", "error"], + "example": "inprogress", + "readOnly": true, + "type": "string" + }, + "media_status": { + "description": "Specifies a detailed status for a video. If the `state` is `inprogress` or `error`, the `step` field returns `encoding` or `manifest`. If the `state` is `inprogress`, `pctComplete` returns a number between 0 and 100 to indicate the approximate percent of completion. If the `state` is `error`, `errorReasonCode` and `errorReasonText` provide additional details.", + "properties": { + "errorReasonCode": { "$ref": "#/components/schemas/errorReasonCode" }, + "errorReasonText": { "$ref": "#/components/schemas/errorReasonText" }, + "pctComplete": { "$ref": "#/components/schemas/pctComplete" }, + "state": { "$ref": "#/components/schemas/media_state" } + }, + "readOnly": true + }, + "member": { + "properties": { + "code": { "$ref": "#/components/schemas/code" }, + "id": { "$ref": "#/components/schemas/membership_components-schemas-identifier" }, + "roles": { + "description": "Roles assigned to this member.", + "items": { "$ref": "#/components/schemas/role" }, + "type": "array" + }, + "status": { "readOnly": true }, + "user": { + "properties": { + "email": { "$ref": "#/components/schemas/email-sNyq81Xd" }, + "first_name": { "$ref": "#/components/schemas/first_name" }, + "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" }, + "last_name": { "$ref": "#/components/schemas/last_name" }, + "two_factor_authentication_enabled": { "$ref": "#/components/schemas/two_factor_authentication_enabled" } + }, + "readOnly": true, + "required": ["email"], + "type": "object" + } + }, + "required": ["id", "user", "status", "roles"], + "type": "object" + }, + "member_components-schemas-name": { + "description": "Member Name.", + "example": "John Smith", + "maxLength": 100, + "nullable": true, + "type": "string" + }, + "membership": { + "properties": { + "account": { "$ref": "#/components/schemas/schemas-account" }, + "api_access_enabled": { "$ref": "#/components/schemas/api_access_enabled" }, + "code": { "$ref": "#/components/schemas/code" }, + "id": { "$ref": "#/components/schemas/membership_components-schemas-identifier" }, + "permissions": { + "allOf": [{ "$ref": "#/components/schemas/permissions" }], + "description": "All access permissions for the user at the account.", + "readOnly": true + }, + "roles": { "$ref": "#/components/schemas/roles" }, + "status": { "$ref": "#/components/schemas/schemas-status-uJZPVtIE" } + }, + "type": "object" + }, + "membership_components-schemas-identifier": { + "description": "Membership identifier tag.", + "example": "4536bcfad5faccb111b47003c79917fa", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "memberships": { + "description": "Zones and Accounts which will be assigned IPs on this Address Map. A zone membership will take priority over an account membership.", + "items": { "$ref": "#/components/schemas/address-maps-membership-upHJKSmv" }, + "type": "array" + }, + "messages": { + "example": [], + "items": { + "properties": { "code": { "minimum": 1000, "type": "integer" }, "message": { "type": "string" } }, + "required": ["code", "message"], + "type": "object", + "uniqueItems": true + }, + "type": "array" + }, + "metadata": { + "description": "User modifiable key-value store. Can be used for keeping references to another system of record for managing images. Metadata must not exceed 1024 bytes.", + "example": { "key": "value" }, + "type": "object" + }, + "method": { + "description": "The HTTP method used to access the endpoint.", + "enum": ["GET", "POST", "HEAD", "OPTIONS", "PUT", "DELETE", "CONNECT", "PATCH", "TRACE"], + "example": "GET", + "type": "string" + }, + "method-guvmKTdR": { + "default": "GET", + "description": "The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.", + "example": "GET", + "type": "string" + }, + "methods": { + "description": "The HTTP methods to match. You can specify a subset (for example, `['POST','PUT']`) or all methods (`['_ALL_']`). This field is optional when creating a rate limit.", + "example": ["GET", "POST"], + "items": { + "description": "An HTTP method or `_ALL_` to indicate all methods.", + "enum": ["GET", "POST", "PUT", "DELETE", "PATCH", "HEAD", "_ALL_"], + "example": "GET", + "type": "string" + }, + "type": "array" + }, + "metrics": { + "description": "A comma-separated list of metrics to query.", + "example": "queryCount,uncachedCount", + "type": "string" + }, + "min_rtt_ms": { "description": "Minimum RTT in ms.", "type": "number" }, + "min_tls_version": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { + "description": "ID of the zone setting.", + "enum": ["min_tls_version"], + "example": "min_tls_version" + }, + "value": { "$ref": "#/components/schemas/min_tls_version_value" } + } + } + ], + "default": "1.0", + "description": "Only accepts HTTPS requests that use at least the TLS protocol version specified. For example, if TLS 1.1 is selected, TLS 1.0 connections will be rejected, while 1.1, 1.2, and 1.3 (if enabled) will be permitted.", + "title": "Zone Minimum TLS Version value" + }, + "min_tls_version_value": { + "default": "1.0", + "description": "Value of the zone setting.", + "enum": ["1.0", "1.1", "1.2", "1.3"], + "type": "string" + }, + "minify": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { "description": "Zone setting identifier.", "enum": ["minify"], "example": "minify" }, + "value": { "$ref": "#/components/schemas/minify_value" } + } + } + ], + "description": "Automatically minify certain assets for your website. Refer to [Using Cloudflare Auto Minify](https://support.cloudflare.com/hc/en-us/articles/200168196) for more information.", + "title": "Auto-Minify Assets" + }, + "minify_value": { + "description": "Value of the zone setting.", + "properties": { + "css": { + "default": "off", + "description": "Automatically minify all CSS files for your website.", + "enum": ["on", "off"] + }, + "html": { + "default": "off", + "description": "Automatically minify all HTML files for your website.", + "enum": ["on", "off"] + }, + "js": { + "default": "off", + "description": "Automatically minify all JavaScript files for your website.", + "enum": ["on", "off"] + } + }, + "type": "object" + }, + "minimum_cache_ttl": { + "default": 60, + "description": "Minimum DNS Cache TTL.", + "example": 60, + "maximum": 36000, + "minimum": 30, + "type": "number" + }, + "minimum_origins": { + "default": 1, + "description": "The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and will failover to the next available pool.", + "type": "integer" + }, + "mirage": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { "description": "ID of the zone setting.", "enum": ["mirage"], "example": "mirage" }, + "value": { "$ref": "#/components/schemas/mirage_value" } + } + } + ], + "description": "Automatically optimize image loading for website visitors on mobile\ndevices. Refer to [our blog post](http://blog.cloudflare.com/mirage2-solving-mobile-speed)\nfor more information.\n", + "title": "Mirage Image Optimization" + }, + "mirage_value": { + "default": "off", + "description": "Value of the zone setting.", + "enum": ["on", "off"], + "type": "string" + }, + "miscategorization": { + "properties": { + "content_adds": { "description": "Content category IDs to add.", "example": [82] }, + "content_removes": { "description": "Content category IDs to remove.", "example": [155] }, + "indicator_type": { "enum": ["domain", "ipv4", "ipv6", "url"], "example": "domain" }, + "ip": { "description": "Provide only if indicator_type is `ipv4` or `ipv6`." }, + "security_adds": { "description": "Security category IDs to add.", "example": [117, 131] }, + "security_removes": { "description": "Security category IDs to remove.", "example": [83] }, + "url": { + "description": "Provide only if indicator_type is `domain` or `url`. Example if indicator_type is `domain`: `example.com`. Example if indicator_type is `url`: `https://example.com/news/`.", + "type": "string" + } + } + }, + "mnm_config": { + "properties": { + "default_sampling": { "$ref": "#/components/schemas/mnm_config_default_sampling" }, + "name": { "$ref": "#/components/schemas/mnm_config_name" }, + "router_ips": { "$ref": "#/components/schemas/mnm_config_router_ips" } + }, + "required": ["name", "default_sampling", "router_ips"], + "type": "object" + }, + "mnm_config_default_sampling": { + "default": 1, + "description": "Fallback sampling rate of flow messages being sent in packets per second. This should match the packet sampling rate configured on the router.", + "minimum": 1, + "type": "number" + }, + "mnm_config_name": { + "description": "The account name.", + "example": "cloudflare user's account", + "type": "string" + }, + "mnm_config_router_ip": { + "description": "IPv4 CIDR of the router sourcing flow data. Only /32 addresses are currently supported.", + "example": "203.0.113.1/32", + "type": "string" + }, + "mnm_config_router_ips": { "items": { "$ref": "#/components/schemas/mnm_config_router_ip" }, "type": "array" }, + "mnm_config_single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/mnm_config" } }, "type": "object" } + ] + }, + "mnm_rule": { + "nullable": true, + "properties": { + "automatic_advertisement": { "$ref": "#/components/schemas/mnm_rule_automatic_advertisement" }, + "bandwidth_threshold": { "$ref": "#/components/schemas/mnm_rule_bandwidth_threshold" }, + "duration": { "$ref": "#/components/schemas/mnm_rule_duration" }, + "id": { "$ref": "#/components/schemas/rule_identifier" }, + "name": { "$ref": "#/components/schemas/mnm_rule_name" }, + "packet_threshold": { "$ref": "#/components/schemas/mnm_rule_packet_threshold" }, + "prefixes": { "$ref": "#/components/schemas/mnm_rule_ip_prefixes" } + }, + "required": ["name", "prefixes", "automatic_advertisement", "duration"], + "type": "object" + }, + "mnm_rule_advertisable_response": { + "nullable": true, + "properties": { + "automatic_advertisement": { "$ref": "#/components/schemas/mnm_rule_automatic_advertisement" } + }, + "required": ["automatic_advertisement"], + "type": "object" + }, + "mnm_rule_advertisement_single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { "result": { "$ref": "#/components/schemas/mnm_rule_advertisable_response" } }, + "type": "object" + } + ] + }, + "mnm_rule_automatic_advertisement": { + "description": "Toggle on if you would like Cloudflare to automatically advertise the IP Prefixes within the rule via Magic Transit when the rule is triggered. Only available for users of Magic Transit.", + "example": "false", + "nullable": true, + "type": "boolean" + }, + "mnm_rule_bandwidth_threshold": { + "description": "The number of bits per second for the rule. When this value is exceeded for the set duration, an alert notification is sent. Minimum of 1 and no maximum.", + "example": 1000, + "minimum": 1, + "type": "number" + }, + "mnm_rule_duration": { + "default": "60s", + "description": "The amount of time that the rule threshold must be exceeded to send an alert notification. The minimum is 60 seconds and maximum is 21600 seconds. The format is XhYmZs where X, Y, and Z durations are optional; however at least one unit must be provided.", + "example": "1h2m3s", + "type": "string" + }, + "mnm_rule_ip_prefix": { + "description": "The IP prefixes that are monitored for this rule. Must be a CIDR range like 203.0.113.0/24. Max 5000 different CIDR ranges.", + "example": "203.0.113.1/32", + "type": "string" + }, + "mnm_rule_ip_prefixes": { "items": { "$ref": "#/components/schemas/mnm_rule_ip_prefix" }, "type": "array" }, + "mnm_rule_name": { + "description": "The name of the rule. Must be unique. Supports characters A-Z, a-z, 0-9, underscore (_), dash (-), period (.), and tilde (~). You can’t have a space in the rule name. Max 256 characters.", + "example": "my_rule_1", + "type": "string" + }, + "mnm_rule_packet_threshold": { + "description": "The number of packets per second for the rule. When this value is exceeded for the set duration, an alert notification is sent. Minimum of 1 and no maximum.", + "example": 10000, + "minimum": 1, + "type": "number" + }, + "mnm_rules_collection_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/mnm_rule" }, "nullable": true, "type": "array" } + } + } + ] + }, + "mnm_rules_single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/mnm_rule" } }, "type": "object" } + ] + }, + "mobile_redirect": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { + "description": "Identifier of the zone setting.", + "enum": ["mobile_redirect"], + "example": "mobile_redirect" + }, + "value": { "$ref": "#/components/schemas/mobile_redirect_value" } + } + } + ], + "description": "Automatically redirect visitors on mobile devices to a mobile-optimized subdomain. Refer to [Understanding Cloudflare Mobile Redirect](https://support.cloudflare.com/hc/articles/200168336) for more information.", + "title": "Mobile Redirect" + }, + "mobile_redirect_value": { + "description": "Value of the zone setting.", + "properties": { + "mobile_subdomain": { + "description": "Which subdomain prefix you wish to redirect visitors on mobile devices to (subdomain must already exist).", + "example": "m", + "minLength": 1, + "nullable": true, + "type": "string" + }, + "status": { + "default": "off", + "description": "Whether or not mobile redirect is enabled.", + "enum": ["on", "off"] + }, + "strip_uri": { + "default": false, + "description": "Whether to drop the current page path and redirect to the mobile subdomain URL root, or keep the path and redirect to the same page on the mobile subdomain.", + "example": false, + "type": "boolean" + } + }, + "type": "object" + }, + "mode": { + "description": "The action to perform.", + "enum": ["simulate", "ban", "challenge", "js_challenge", "managed_challenge"], + "example": "challenge", + "type": "string" + }, + "mode_allow_traditional": { + "description": "When set to `on`, the current rule will be used when evaluating the request. Applies to traditional (allow) WAF rules.", + "enum": ["on", "off"], + "example": "on", + "type": "string" + }, + "mode_anomaly": { + "description": "When set to `on`, the current WAF rule will be used when evaluating the request. Applies to anomaly detection WAF rules.", + "enum": ["on", "off"], + "example": "on", + "type": "string" + }, + "mode_deny_traditional": { + "description": "The action that the current WAF rule will perform when triggered. Applies to traditional (deny) WAF rules.", + "enum": ["default", "disable", "simulate", "block", "challenge"], + "example": "block", + "type": "string" + }, + "model": { "description": "The device model name.", "example": "MyPhone(pro-X)", "type": "string" }, + "modified": { + "description": "When the Application was last modified.", + "example": "2014-01-02T02:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "modified-5P46cImn": { + "description": "The date and time the media item was last modified.", + "example": "2014-01-02T02:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "modified-Hq0wyeit": { + "description": "The date and time the destination address was last modified.", + "example": "2014-01-02T02:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "modified_at_nullable": { + "description": "Last time the advertisement status was changed. This field is only not 'null' if on demand is enabled.", + "example": "2014-01-01T05:20:00.12345Z", + "format": "date-time", + "nullable": true, + "type": "string" + }, + "modified_on": { + "description": "When the route was last modified.", + "example": "2017-06-14T05:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "modified_on-6lsEa3Mx": { + "description": "When the script was last modified.", + "example": "2017-01-01T00:00:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "modified_on-JpSxLOr6": { + "description": "When DNSSEC was last modified.", + "example": "2014-01-01T05:20:00Z", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "modified_on-bJDfxiY8": { + "description": "Last time the token was modified.", + "example": "2018-07-02T05:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "modified_on-t5RPC3jV": { + "description": "When the certificate was last modified.", + "example": "2014-01-01T05:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "modified_on-uPCC7iXw": { + "description": "Last modification of DNS Firewall cluster.", + "example": "2014-01-01T05:20:00.12345Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "modified_on-zM0Z89yx": { + "description": "last time this setting was modified.", + "example": "2014-01-01T05:20:00.12345Z", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "modified_rules_count": { + "default": 0, + "description": "The number of rules within the group that have been modified from their default configuration.", + "example": 2, + "readOnly": true, + "type": "number" + }, + "modified_tunnels_collection_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "modified": { "example": true, "type": "boolean" }, + "modified_gre_tunnels": { "items": { "$ref": "#/components/schemas/gre-tunnel" }, "type": "array" } + } + } + } + } + ] + }, + "modify_request": { + "properties": { + "description": { "$ref": "#/components/schemas/web3-hostname_components-schemas-description" }, + "dnslink": { "$ref": "#/components/schemas/dnslink" } + }, + "type": "object" + }, + "monitor": { + "properties": { + "allow_insecure": { "$ref": "#/components/schemas/allow_insecure" }, + "created_on": { "$ref": "#/components/schemas/timestamp" }, + "description": { "$ref": "#/components/schemas/monitor_components-schemas-description" }, + "expected_body": { "$ref": "#/components/schemas/expected_body" }, + "expected_codes": { "$ref": "#/components/schemas/expected_codes" }, + "follow_redirects": { "$ref": "#/components/schemas/follow_redirects" }, + "header": { "$ref": "#/components/schemas/header" }, + "id": { "$ref": "#/components/schemas/monitor_components-schemas-identifier" }, + "interval": { "$ref": "#/components/schemas/interval-IFpdxmAf" }, + "method": { "$ref": "#/components/schemas/schemas-method" }, + "modified_on": { "$ref": "#/components/schemas/timestamp" }, + "path": { "$ref": "#/components/schemas/path-N56b8ntG" }, + "port": { "$ref": "#/components/schemas/schemas-port" }, + "retries": { "$ref": "#/components/schemas/retries" }, + "timeout": { "$ref": "#/components/schemas/schemas-timeout" }, + "type": { "$ref": "#/components/schemas/monitor_components-schemas-type" } + }, + "type": "object" + }, + "monitor-FBAH67XY": { + "properties": { + "allow_insecure": { "$ref": "#/components/schemas/allow_insecure" }, + "created_on": { "$ref": "#/components/schemas/timestamp" }, + "description": { "$ref": "#/components/schemas/description-Jd6AMFjR" }, + "expected_body": { "$ref": "#/components/schemas/expected_body" }, + "expected_codes": { "$ref": "#/components/schemas/expected_codes" }, + "follow_redirects": { "$ref": "#/components/schemas/follow_redirects" }, + "header": { "$ref": "#/components/schemas/header" }, + "id": { "$ref": "#/components/schemas/identifier-FZThz4k7" }, + "interval": { "$ref": "#/components/schemas/interval-hA6swy38" }, + "method": { "$ref": "#/components/schemas/method-guvmKTdR" }, + "modified_on": { "$ref": "#/components/schemas/timestamp" }, + "path": { "$ref": "#/components/schemas/path-I0p9X4oI" }, + "port": { "$ref": "#/components/schemas/port-WXwz9tIV" }, + "retries": { "$ref": "#/components/schemas/retries" }, + "timeout": { "$ref": "#/components/schemas/timeout" }, + "type": { "$ref": "#/components/schemas/type-gTI6cLgq" } + }, + "type": "object" + }, + "monitor_components-schemas-description": { + "description": "Object description.", + "example": "Login page monitor", + "type": "string" + }, + "monitor_components-schemas-identifier": { "example": "f1aba936b94213e5b8dca0c0dbf1f9cc" }, + "monitor_components-schemas-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/monitor" }, "type": "array" } } } + ] + }, + "monitor_components-schemas-response_collection-2": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/components-schemas-monitor" }, "type": "array" } + } + } + ] + }, + "monitor_components-schemas-response_collection-hQYwgX5c": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "items": { "$ref": "#/components/schemas/components-schemas-monitor-vfiRsl5D" }, + "type": "array" + } + } + } + ] + }, + "monitor_components-schemas-single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/components-schemas-monitor-vfiRsl5D" } } } + ] + }, + "monitor_components-schemas-type": { + "default": "http", + "description": "The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'.", + "enum": ["http", "https", "tcp", "udp_icmp", "icmp_ping", "smtp"], + "example": "https", + "type": "string" + }, + "mtls-management_components-schemas-certificate_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "items": { "$ref": "#/components/schemas/components-schemas-certificateObject-Eyk3On6c" }, + "type": "array" + } + } + }, + { + "properties": { + "result_info": { + "properties": { + "count": { "example": 1 }, + "page": { "example": 1 }, + "per_page": { "example": 50 }, + "total_count": { "example": 1 }, + "total_pages": { "example": 1 } + }, + "type": "object" + } + } + } + ] + }, + "mtls-management_components-schemas-certificate_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "allOf": [{ "$ref": "#/components/schemas/components-schemas-certificateObject-Eyk3On6c" }], + "type": "object" + } + } + } + ] + }, + "mtls-management_components-schemas-expires_on": { + "description": "When the certificate expires.", + "example": "2122-10-29T16:59:47Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "mtls-management_components-schemas-identifier": { + "description": "Certificate identifier tag.", + "example": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60", + "maxLength": 36, + "readOnly": true, + "type": "string" + }, + "mtls-management_components-schemas-name": { + "description": "Optional unique name for the certificate. Only used for human readability.", + "example": "example_ca_cert", + "type": "string" + }, + "mtls-management_components-schemas-status": { + "description": "Certificate deployment status for the given service.", + "example": "pending_deployment", + "type": "string" + }, + "mtls-management_components-schemas-uploaded_on": { + "description": "This is the time the certificate was uploaded.", + "example": "2022-11-22T17:32:30.467938Z", + "format": "date-time", + "type": "string" + }, + "mtu": { + "default": 1476, + "description": "Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value is 576.", + "type": "integer" + }, + "multiple_route_delete_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "deleted": { "example": true, "type": "boolean" }, + "deleted_routes": { "type": "object" } + } + } + } + } + ] + }, + "multiple_route_modified_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "modified": { "example": true, "type": "boolean" }, + "modified_routes": { "items": { "$ref": "#/components/schemas/route" }, "type": "array" } + } + } + } + } + ] + }, + "name": { "description": "The name of the List.", "example": "Admin Serial Numbers", "type": "string" }, + "name-0M1mwjDs": { + "default": "", + "description": "A short description of the watermark profile.", + "example": "Marketing Videos", + "readOnly": true, + "type": "string" + }, + "name-51RmM5yT": { + "description": "A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed.", + "example": "server-1", + "type": "string" + }, + "name-LiICrXvM": { + "description": "The domain name", + "example": "example.com", + "maxLength": 253, + "pattern": "^([a-zA-Z0-9][\\-a-zA-Z0-9]*\\.)+[\\-a-zA-Z0-9]{2,20}$", + "type": "string" + }, + "name-Pky1OOiR": { + "description": "A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.", + "example": "primary-dc-1", + "type": "string" + }, + "name-SScjQrIN": { + "description": "DNS Firewall Cluster Name.", + "example": "My Awesome DNS Firewall cluster", + "maxLength": 160, + "type": "string" + }, + "name-VvYEM0tR": { + "description": "The keyless SSL name.", + "example": "example.com Keyless SSL", + "maxLength": 180, + "readOnly": true, + "type": "string" + }, + "name-YGUm4gr7": { "description": "Zone name.", "example": "www.example.com.", "type": "string" }, + "name-jYNmruXY": { + "description": "A unique name to identify the waiting room. Only alphanumeric characters, hyphens and underscores are allowed.", + "example": "production_webinar", + "type": "string" + }, + "name-pG4STmz5": { + "description": "Token name.", + "example": "readonly token", + "maxLength": 120, + "type": "string" + }, + "name-rRqaJzmt": { + "description": "Optional human readable job name. Not unique. Cloudflare suggests that you set this to a meaningful string, like the domain name, to make it easier to identify your job.", + "example": "example.com", + "maxLength": 512, + "nullable": true, + "pattern": "^[a-zA-Z0-9\\-\\.]*$", + "type": "string" + }, + "name-wyyCMADI": { + "description": "The name of the Device Posture Rule.", + "example": "Admin Serial Numbers", + "type": "string" + }, + "name-xThA5RuS": { + "description": "DNS record name (or @ for the zone apex).", + "example": "example.com", + "maxLength": 255, + "type": "string" + }, + "name-xgxcxGi8": { + "description": "The name of your Zero Trust organization.", + "example": "Widget Corps Internal Applications", + "type": "string" + }, + "name-z6BHq9UH": { + "description": "The name of the tunnel. The name cannot contain spaces or special characters, must be 15 characters or less, and cannot share a name with another GRE tunnel.", + "example": "GRE_1", + "type": "string" + }, + "name_servers": { + "description": "List of name servers.", + "example": ["preston.ns.cloudflare.com", "oli.ns.cloudflare.com"], + "items": { "type": "string" }, + "type": "array" + }, + "name_write": { + "description": "The keyless SSL name.", + "example": "example.com Keyless SSL", + "maxLength": 180, + "name": "name", + "type": "string" + }, + "namespace": { + "properties": { + "id": { "$ref": "#/components/schemas/namespace_identifier" }, + "supports_url_encoding": { + "description": "True if keys written on the URL will be URL-decoded before storing. For example, if set to \"true\", a key written on the URL as \"%3F\" will be stored as \"?\".", + "example": true, + "readOnly": true, + "type": "boolean" + }, + "title": { "$ref": "#/components/schemas/namespace_title" } + }, + "required": ["id", "title"], + "type": "object" + }, + "namespace_identifier": { + "description": "Namespace identifier tag.", + "example": "0f2ac74b498b48028cb68387c421e279", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "namespace_title": { + "description": "A human-readable string name for a Namespace.", + "example": "My Own Namespace", + "type": "string" + }, + "negative_cache_ttl": { + "description": "Negative DNS Cache TTL.", + "example": 900, + "maximum": 36000, + "minimum": 30, + "nullable": true, + "type": "number" + }, + "nel": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { "description": "Zone setting identifier.", "enum": ["nel"], "example": "nel" }, + "value": { "$ref": "#/components/schemas/nel_value" } + } + } + ], + "description": "Enable Network Error Logging reporting on your zone. (Beta) ", + "title": "Network Error Logging" + }, + "nel_value": { + "description": "Value of the zone setting.", + "properties": { "enabled": { "default": false, "example": false, "type": "boolean" } }, + "type": "object" + }, + "network": { + "description": "A list of network ranges that requests from this location would originate from.", + "items": { + "description": "The IPv4 address or IPv4 CIDR. IPv4 CIDRs are limited to a maximum of /24.", + "example": "192.0.2.1/32", + "type": "string" + }, + "type": "array" + }, + "neverRequireSignedURLs": { + "default": false, + "description": "Indicates whether the variant can access an image without a signature, regardless of image access control.", + "example": true, + "type": "boolean" + }, + "new-project-response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { "properties": { "result": { "type": "object" } } } + ] + }, + "new_custom_entry": { + "description": "A custom entry create payload", + "properties": { + "enabled": { "description": "Whether the entry is enabled or not.", "example": true, "type": "boolean" }, + "name": { "description": "The name of the entry.", "example": "Credit card (Visa)", "type": "string" }, + "pattern": { "$ref": "#/components/schemas/pattern" } + }, + "required": ["name", "enabled", "pattern"], + "title": "Custom entry", + "type": "object" + }, + "new_custom_entry-PxvT1kkf": { + "description": "A custom entry create payload", + "properties": { + "enabled": { "description": "Whether the entry is enabled or not.", "example": true, "type": "boolean" }, + "name": { "description": "The name of the entry.", "example": "Credit card (Visa)", "type": "string" }, + "pattern": { "$ref": "#/components/schemas/components-schemas-pattern" } + }, + "required": ["name", "enabled", "pattern"], + "title": "Custom entry", + "type": "object" + }, + "new_custom_profile": { + "properties": { + "allowed_match_count": { "$ref": "#/components/schemas/allowed_match_count" }, + "description": { + "description": "The description of the profile.", + "example": "A standard CVV card number", + "type": "string" + }, + "entries": { + "description": "The entries for this profile.", + "items": { "$ref": "#/components/schemas/new_custom_entry-PxvT1kkf" }, + "type": "array" + }, + "name": { "description": "The name of the profile.", "example": "Generic CVV Card Number", "type": "string" } + }, + "type": "object" + }, + "new_users_per_minute": { + "description": "Sets the number of new users that will be let into the route every minute. This value is used as baseline for the number of users that are let in per minute. So it is possible that there is a little more or little less traffic coming to the route based on the traffic patterns at that time around the world.", + "maximum": 2147483647, + "minimum": 200, + "type": "integer" + }, + "next_event_prequeue_start_time": { + "description": "An ISO 8601 timestamp that marks when the next event will begin queueing.", + "example": "2021-09-28T15:00:00.000Z", + "nullable": true, + "type": "string" + }, + "next_event_start_time": { + "description": "An ISO 8601 timestamp that marks when the next event will start.", + "example": "2021-09-28T15:00:00.000Z", + "nullable": true, + "type": "string" + }, + "nexthop": { + "description": "The next-hop IP Address for the static route.", + "example": "203.0.113.1", + "type": "string" + }, + "node_result": { + "example": { + "asn": "AS13335", + "ip": "1.1.1.1", + "max_latency_ms": 0.034, + "mean_latency_ms": 0.021, + "min_latency_ms": 0.014, + "name": "one.one.one.one", + "packet_count": 3, + "std_dev_latency_ms": 0.011269427669584647 + }, + "properties": { + "asn": { "$ref": "#/components/schemas/schemas-asn" }, + "ip": { "$ref": "#/components/schemas/traceroute_components-schemas-ip" }, + "labels": { "$ref": "#/components/schemas/labels" }, + "max_rtt_ms": { "$ref": "#/components/schemas/max_rtt_ms" }, + "mean_rtt_ms": { "$ref": "#/components/schemas/mean_rtt_ms" }, + "min_rtt_ms": { "$ref": "#/components/schemas/min_rtt_ms" }, + "name": { "$ref": "#/components/schemas/traceroute_components-schemas-name" }, + "packet_count": { "$ref": "#/components/schemas/packet_count" }, + "std_dev_rtt_ms": { "$ref": "#/components/schemas/std_dev_rtt_ms" } + }, + "type": "object" + }, + "not_before": { + "description": "The time before which the token MUST NOT be accepted for processing.", + "example": "2018-07-01T05:20:00Z", + "format": "date-time", + "type": "string" + }, + "notes": { + "description": "An informative summary of the rule, typically used as a reminder or explanation.", + "example": "This rule is enabled because of an event that occurred on date X.", + "type": "string" + }, + "notificationUrl": { + "description": "The URL where webhooks will be sent.", + "example": "https://example.com", + "format": "uri", + "type": "string" + }, + "notification_email": { + "description": "The email address to send health status notifications to. This can be an individual mailbox or a mailing list. Multiple emails can be supplied as a comma delimited list.", + "example": "someone@example.com,sometwo@example.com", + "type": "string" + }, + "notification_filter": { + "description": "Filter pool and origin health notifications by resource type or health status. Use null to reset.", + "example": { "origin": { "disable": true }, "pool": { "healthy": false } }, + "nullable": true, + "properties": { + "origin": { "$ref": "#/components/schemas/filter_options" }, + "pool": { "$ref": "#/components/schemas/filter_options" } + }, + "type": "object" + }, + "ns_name": { + "description": "The FQDN of the name server.", + "example": "ns1.example.com", + "format": "hostname", + "type": "string" + }, + "num_items": { "description": "The number of items in the list.", "example": 10, "type": "number" }, + "num_referencing_filters": { + "description": "The number of [filters](#filters) referencing the list.", + "example": 2, + "type": "number" + }, + "object": { + "properties": { + "hasStoredData": { + "description": "Whether the Durable Object has stored data.", + "example": true, + "readOnly": true, + "type": "boolean" + }, + "id": { + "description": "ID of the Durable Object.", + "example": "fe7803fc55b964e09d94666545aab688d360c6bda69ba349ced1e5f28d2fc2c8", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "occurred_at": { + "description": "When the billing item was created.", + "example": "2014-03-01T12:21:59.3456Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "oidc": { + "allOf": [ + { "$ref": "#/components/schemas/identity-provider" }, + { + "properties": { + "config": { + "allOf": [ + { "$ref": "#/components/schemas/generic-oauth-config" }, + { + "properties": { + "auth_url": { + "description": "The authorization_endpoint URL of your IdP", + "example": "https://accounts.google.com/o/oauth2/auth", + "type": "string" + }, + "certs_url": { + "description": "The jwks_uri endpoint of your IdP to allow the IdP keys to sign the tokens", + "example": "https://www.googleapis.com/oauth2/v3/certs", + "type": "string" + }, + "scopes": { + "description": "OAuth scopes", + "example": ["openid", "email", "profile"], + "items": { "type": "string" }, + "type": "array" + }, + "token_url": { + "description": "The token_endpoint URL of your IdP", + "example": "https://accounts.google.com/o/oauth2/token", + "type": "string" + } + }, + "type": "object" + } + ] + } + }, + "type": "object" + } + ], + "title": "Generic OAuth", + "type": "object" + }, + "okta": { + "allOf": [ + { "$ref": "#/components/schemas/identity-provider" }, + { + "properties": { + "config": { + "allOf": [ + { "$ref": "#/components/schemas/generic-oauth-config" }, + { + "properties": { + "okta_account": { + "description": "Your okta account url", + "example": "https://dev-abc123.oktapreview.com", + "type": "string" + } + }, + "type": "object" + } + ] + } + }, + "type": "object" + } + ], + "title": "Okta", + "type": "object" + }, + "okta_group_rule": { + "description": "Matches an Okta group.\nRequires an Okta identity provider.", + "properties": { + "okta": { + "properties": { + "connection_id": { + "description": "The ID of your Okta identity provider.", + "example": "ea85612a-29c8-46c2-bacb-669d65136971", + "type": "string" + }, + "email": { + "description": "The email of the Okta group.", + "example": "devs@cloudflare.com", + "type": "string" + } + }, + "required": ["email", "connection_id"], + "type": "object" + } + }, + "required": ["okta"], + "title": "Okta group", + "type": "object" + }, + "on_demand_enabled": { + "description": "Whether advertisement of the prefix to the Internet may be dynamically enabled or disabled.", + "example": true, + "type": "boolean" + }, + "on_demand_locked": { + "description": "Whether advertisement status of the prefix is locked, meaning it cannot be changed.", + "example": false, + "type": "boolean" + }, + "oneTimeUploadExpiry": { + "description": "The date and time when the video upload URL is no longer valid for direct user uploads.", + "example": "2014-01-02T02:20:00Z", + "format": "date-time", + "type": "string" + }, + "onelogin": { + "allOf": [ + { "$ref": "#/components/schemas/identity-provider" }, + { + "properties": { + "config": { + "allOf": [ + { "$ref": "#/components/schemas/generic-oauth-config" }, + { + "properties": { + "onelogin_account": { + "description": "Your OneLogin account url", + "example": "https://mycompany.onelogin.com", + "type": "string" + } + }, + "type": "object" + } + ] + } + }, + "type": "object" + } + ], + "title": "OneLogin", + "type": "object" + }, + "opacity": { + "default": 1, + "description": "The translucency of the image. A value of `0.0` makes the image completely transparent, and `1.0` makes the image completely opaque. Note that if the image is already semi-transparent, setting this to `1.0` will not make the image completely opaque.", + "example": 0.75, + "maximum": 1, + "minimum": 0, + "readOnly": true, + "type": "number" + }, + "openapi": { + "description": "A OpenAPI 3.0.0 compliant schema.", + "example": { + "info": { "title": "OpenAPI JSON schema for www.example.com", "version": "1.0" }, + "openapi": "3.0.0", + "paths": { + "... Further paths ...": {}, + "/api/v1/users/{var1}": { + "get": { + "parameters": [{ "in": "path", "name": "var1", "required": true, "schema": { "type": "string" } }] + } + } + }, + "servers": [{ "url": "www.example.com" }] + }, + "type": "object" + }, + "openapiwiththresholds": { + "description": "A OpenAPI 3.0.0 compliant schema.", + "example": { + "info": { "title": "OpenAPI JSON schema for www.example.com", "version": "1.0" }, + "openapi": "3.0.0", + "paths": { + "... Further paths ...": {}, + "/api/v1/users/{var1}": { + "get": { + "parameters": [{ "in": "path", "name": "var1", "required": true, "schema": { "type": "string" } }] + } + } + }, + "servers": [{ "url": "www.example.com" }] + }, + "type": "object" + }, + "operation": { + "properties": { + "endpoint": { "$ref": "#/components/schemas/endpoint" }, + "features": { "$ref": "#/components/schemas/features" }, + "host": { "$ref": "#/components/schemas/host-nm3Leu3G" }, + "last_updated": { "$ref": "#/components/schemas/timestamp" }, + "method": { "$ref": "#/components/schemas/method" }, + "operation_id": { "$ref": "#/components/schemas/uuid-s0SXln0q" } + }, + "required": ["operation_id", "method", "host", "endpoint", "last_updated"], + "type": "object" + }, + "operation_id": { + "description": "The unique operation ID of the asynchronous action.", + "example": "4da8780eeb215e6cb7f48dd981c4ea02", + "readOnly": true, + "type": "string" + }, + "opportunistic_encryption": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { + "description": "ID of the zone setting.", + "enum": ["opportunistic_encryption"], + "example": "opportunistic_encryption" + }, + "value": { "$ref": "#/components/schemas/opportunistic_encryption_value" } + } + } + ], + "description": "Enables the Opportunistic Encryption feature for a zone.", + "title": "Enable Opportunistic Encryption for a zone" + }, + "opportunistic_encryption_value": { + "default": "on", + "description": "Value of the zone setting.\nNotes: Default value depends on the zone's plan level.", + "enum": ["on", "off"], + "type": "string" + }, + "opportunistic_onion": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { + "description": "ID of the zone setting.", + "enum": ["opportunistic_onion"], + "example": "opportunistic_onion" + }, + "value": { "$ref": "#/components/schemas/opportunistic_onion_value" } + } + } + ], + "default": "off", + "description": "Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes.", + "title": "Zone Enable Onion Routing" + }, + "opportunistic_onion_value": { + "default": "off", + "description": "Value of the zone setting.\nNotes: Default value depends on the zone's plan level.", + "enum": ["on", "off"], + "type": "string" + }, + "options": { + "description": "Allows you to define image resizing sizes for different use cases.", + "properties": { + "fit": { "$ref": "#/components/schemas/fit" }, + "height": { "$ref": "#/components/schemas/height" }, + "metadata": { "$ref": "#/components/schemas/schemas-metadata" }, + "width": { "$ref": "#/components/schemas/width" } + }, + "required": ["fit", "metadata", "width", "height"], + "type": "object" + }, + "orange_to_orange": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { + "description": "ID of the zone setting.", + "enum": ["orange_to_orange"], + "example": "orange_to_orange" + }, + "value": { "$ref": "#/components/schemas/orange_to_orange_value" } + } + } + ], + "description": "Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also on Cloudflare.", + "title": "Orange to Orange" + }, + "orange_to_orange_value": { + "default": "on", + "description": "Value of the zone setting.", + "enum": ["on", "off"], + "type": "string" + }, + "organization": { + "description": "Organization, provided by the CSR", + "example": "Organization", + "readOnly": true, + "type": "string" + }, + "organization-8ZC4Qebn": { + "properties": { + "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" }, + "name": { "$ref": "#/components/schemas/schemas-name-Usb6SCq8" }, + "permissions": { "$ref": "#/components/schemas/schemas-permissions" }, + "roles": { + "description": "List of roles that a user has within an organization.", + "items": { "example": "All Privileges - Super Administrator", "maxLength": 120, "type": "string" }, + "readOnly": true, + "type": "array" + }, + "status": { "$ref": "#/components/schemas/components-schemas-status-bVKpIIc1" } + }, + "type": "object" + }, + "organization_components-schemas-identifier": { + "description": "Organization identifier tag.", + "example": "01a7362d577a6c3019a474fd6f485823", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "organization_invite": { + "allOf": [ + { "$ref": "#/components/schemas/base-bSfRyaRZ" }, + { + "properties": { + "organization_is_enforcing_twofactor": { + "default": false, + "description": "Current status of two-factor enforcement on the organization.", + "example": true, + "type": "boolean" + }, + "status": { + "description": "Current status of the invitation.", + "enum": ["pending", "accepted", "rejected", "canceled", "left", "expired"], + "example": "accepted", + "type": "string" + } + } + } + ] + }, + "organizational_unit": { + "description": "Organizational Unit, provided by the CSR", + "example": "Organizational Unit", + "readOnly": true, + "type": "string" + }, + "organizations": { + "properties": { + "auth_domain": { "$ref": "#/components/schemas/auth_domain" }, + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "is_ui_read_only": { "$ref": "#/components/schemas/is_ui_read_only" }, + "login_design": { "$ref": "#/components/schemas/login_design" }, + "name": { "$ref": "#/components/schemas/name-xgxcxGi8" }, + "ui_read_only_toggle_reason": { "$ref": "#/components/schemas/ui_read_only_toggle_reason" }, + "updated_at": { "$ref": "#/components/schemas/timestamp" }, + "user_seat_expiration_inactive_time": { "$ref": "#/components/schemas/user_seat_expiration_inactive_time" } + }, + "type": "object" + }, + "organizations-ARhl3PEA": { + "properties": { + "auth_domain": { "$ref": "#/components/schemas/auth_domain" }, + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "is_ui_read_only": { "$ref": "#/components/schemas/is_ui_read_only" }, + "login_design": { "$ref": "#/components/schemas/login_design" }, + "name": { "$ref": "#/components/schemas/organizations_components-schemas-name" }, + "updated_at": { "$ref": "#/components/schemas/timestamp" } + }, + "type": "object" + }, + "organizations_components-schemas-name": { + "description": "The name of your Zero Trust organization.", + "example": "Widget Corps Internal Applications", + "type": "string" + }, + "organizations_components-schemas-single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/organizations-ARhl3PEA" } } } + ] + }, + "origin": { + "description": "Your origin hostname that requests to your custom hostnames will be sent to.", + "example": "fallback.example.com", + "maxLength": 255, + "type": "string" + }, + "origin-D5vqwwTi": { + "properties": { + "address": { "$ref": "#/components/schemas/address-95deJOax" }, + "disabled_at": { "$ref": "#/components/schemas/disabled_at" }, + "enabled": { "$ref": "#/components/schemas/schemas-enabled-ItkBt4kJ" }, + "header": { "$ref": "#/components/schemas/schemas-header" }, + "name": { "$ref": "#/components/schemas/schemas-name-Tf4rbdAh" }, + "virtual_network_id": { "$ref": "#/components/schemas/virtual_network_id" }, + "weight": { "$ref": "#/components/schemas/weight-6YtMahm8" } + }, + "type": "object" + }, + "origin-rules_components-schemas-rule": { + "properties": { + "action": { "example": "route" }, + "action_parameters": { "$ref": "#/components/schemas/schemas-action_parameters" }, + "description": { "example": "change the host header, origin, and SNI" }, + "expression": { "example": "http.cookie contains \"something\"" }, + "id": { "example": "3a03d665bac047339bb530ecb439a90d" }, + "version": { "example": "1" } + } + }, + "origin_components-schemas-enabled": { + "default": true, + "description": "Whether to enable (the default) this origin within the pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool.", + "example": true, + "type": "boolean" + }, + "origin_components-schemas-name": { + "description": "A human-identifiable name for the origin.", + "example": "app-server-1", + "type": "string" + }, + "origin_dns": { + "description": "The name and type of DNS record for the Spectrum application.", + "properties": { + "name": { "$ref": "#/components/schemas/origin_dns_name" }, + "ttl": { "$ref": "#/components/schemas/dns_ttl" }, + "type": { "$ref": "#/components/schemas/origin_dns_type" } + }, + "type": "object" + }, + "origin_dns_name": { + "description": "The name of the DNS record associated with the origin.", + "example": "origin.example.com", + "format": "hostname", + "type": "string" + }, + "origin_dns_type": { + "description": "The type of DNS record associated with the origin. \"\" is used to specify a combination of A/AAAA records.", + "enum": ["", "A", "AAAA", "SRV"], + "example": "", + "type": "string" + }, + "origin_error_page_pass_thru": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { + "description": "ID of the zone setting.", + "enum": ["origin_error_page_pass_thru"], + "example": "origin_error_page_pass_thru" + }, + "value": { "$ref": "#/components/schemas/origin_error_page_pass_thru_value" } + } + } + ], + "default": "off", + "description": "Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones.", + "title": "Error Pages On" + }, + "origin_error_page_pass_thru_value": { + "default": "off", + "description": "Value of the zone setting.", + "enum": ["on", "off"], + "type": "string" + }, + "origin_health_data": { + "description": "The origin ipv4/ipv6 address or domain name mapped to it's health data.", + "example": { "failure_reason": "No failures", "healthy": true, "response_code": 200, "rtt": "66ms" }, + "properties": { + "failure_reason": { "type": "string" }, + "healthy": { "type": "boolean" }, + "response_code": { "type": "number" }, + "rtt": { "type": "string" } + }, + "type": "object" + }, + "origin_healthy": { + "default": true, + "description": "If true, filter events where the origin status is healthy. If false, filter events where the origin status is unhealthy.", + "example": true, + "type": "boolean" + }, + "origin_ips": { + "example": ["192.0.2.1", "198.51.100.1", "2001:DB8:100::CF"], + "items": { + "anyOf": [ + { + "description": "Origin DNS Server IPv4 Address.", + "example": "192.0.2.1", + "format": "ipv4", + "type": "string" + }, + { + "description": "Origin DNS Server IPv6 Address.", + "example": "2001:DB8:100::CF", + "format": "ipv6", + "type": "string" + } + ] + }, + "type": "array" + }, + "origin_max_http_version": { + "allOf": [ + { + "properties": { + "id": { + "description": "Identifier of the zone setting.", + "enum": ["origin_max_http_version"], + "example": "origin_max_http_version" + }, + "modified_on": { + "description": "last time this setting was modified.", + "example": "2014-01-01T05:20:00.12345Z", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + } + }, + "required": ["id"] + } + ], + "description": "The highest HTTP version Cloudflare will attempt to use with your origin. This setting allows Cloudflare to make HTTP/2 requests to your origin. (Refer to [Enable HTTP/2 to Origin](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/), for more information.).", + "title": "Origin Max HTTP version" + }, + "origin_port": { + "anyOf": [{ "type": "integer" }, { "type": "string" }], + "description": "The destination port at the origin. Only specified in conjunction with origin_dns. May use an integer to specify a single origin port, for example `1000`, or a string to specify a range of origin ports, for example `\"1000-2000\"`.\nNotes: If specifying a port range, the number of ports in the range must match the number of ports specified in the \"protocol\" field.", + "example": 22, + "maximum": 65535, + "minimum": 1 + }, + "origin_steering": { + "description": "Configures origin steering for the pool. Controls how origins are selected for new sessions and traffic without session affinity.", + "properties": { + "policy": { + "default": "random", + "description": "The type of origin steering policy to use, either \"random\" or \"hash\" (based on CF-Connecting-IP).", + "enum": ["random", "hash"], + "type": "string" + } + }, + "type": "object" + }, + "origin_traffic": { + "description": "When true, only the uncached traffic served from your origin servers will count towards rate limiting. In this case, any cached traffic served by Cloudflare will not count towards rate limiting. This field is optional.\nNotes: This field is deprecated. Instead, use response headers and set \"origin_traffic\" to \"false\" to avoid legacy behaviour interacting with the \"response_headers\" property.", + "type": "boolean" + }, + "original_url": { + "description": "URI to original variant for an image.", + "example": "https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/original", + "format": "uri", + "readOnly": true, + "type": "string" + }, + "origins": { + "description": "The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.", + "items": { "$ref": "#/components/schemas/schemas-origin" }, + "type": "array" + }, + "origins-BzaDTSuG": { + "description": "The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.", + "items": { "$ref": "#/components/schemas/origin-D5vqwwTi" }, + "type": "array" + }, + "os_distro_name": { "description": "The Linux distro name.", "example": "ubuntu", "type": "string" }, + "os_distro_revision": { "description": "The Linux distro revision.", "example": "1.0.0", "type": "string" }, + "os_version": { "description": "The operating system version.", "example": "10.0.0", "type": "string" }, + "output": { + "properties": { + "enabled": { "$ref": "#/components/schemas/output_enabled" }, + "streamKey": { "$ref": "#/components/schemas/output_streamKey" }, + "uid": { "$ref": "#/components/schemas/output_identifier" }, + "url": { "$ref": "#/components/schemas/output_url" } + } + }, + "output_enabled": { + "default": true, + "description": "When enabled, live video streamed to the associated live input will be sent to the output URL. When disabled, live video will not be sent to the output URL, even when streaming to the associated live input. Use this to control precisely when you start and stop simulcasting to specific destinations like YouTube and Twitch.", + "example": true, + "type": "boolean" + }, + "output_identifier": { + "description": "A unique identifier for the output.", + "example": "baea4d9c515887b80289d5c33cf01145", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "output_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/output" }, "type": "array" } } } + ] + }, + "output_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/output" } } } + ] + }, + "output_streamKey": { + "description": "The streamKey used to authenticate against an output's target.", + "example": "uzya-f19y-g2g9-a2ee-51j2", + "readOnly": true, + "type": "string" + }, + "output_url": { + "description": "The URL an output uses to restream.", + "example": "rtmp://a.rtmp.youtube.com/live2", + "readOnly": true, + "type": "string" + }, + "override": { + "properties": { + "description": { "$ref": "#/components/schemas/overrides_components-schemas-description" }, + "groups": { "$ref": "#/components/schemas/groups-fQOB8cgI" }, + "id": { "$ref": "#/components/schemas/overrides_components-schemas-id" }, + "paused": { "$ref": "#/components/schemas/paused-jas4Z8f1" }, + "priority": { "$ref": "#/components/schemas/components-schemas-priority" }, + "rewrite_action": { "$ref": "#/components/schemas/rewrite_action" }, + "rules": { "$ref": "#/components/schemas/rules-YnuEBjzV" }, + "urls": { "$ref": "#/components/schemas/urls" } + } + }, + "override_codes_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "properties": { "disable_for_time": { "$ref": "#/components/schemas/disable_for_time" } }, + "type": "object" + } + } + } + ] + }, + "override_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "items": { + "allOf": [ + { "$ref": "#/components/schemas/override" }, + { "required": ["id", "paused", "urls", "priority"], "type": "object" } + ] + }, + "type": "array" + } + }, + "required": ["result"], + "type": "object" + } + ] + }, + "override_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { "result": { "$ref": "#/components/schemas/override" } }, + "required": ["result"], + "type": "object" + } + ] + }, + "overrides_components-schemas-description": { + "description": "An informative summary of the current URI-based WAF override.", + "example": "Enable Cloudflare Magento ruleset for shop.example.com", + "maxLength": 1024, + "nullable": true, + "type": "string" + }, + "overrides_components-schemas-id": { + "description": "The unique identifier of the WAF override.", + "example": "de677e5818985db1285d0e80225f06e5", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "ownership_challenge": { + "description": "Ownership challenge token to prove destination ownership.", + "example": "00000000000000000000", + "maxLength": 4096, + "pattern": "^[a-zA-Z0-9/\\+\\.\\-_]*$", + "type": "string" + }, + "ownership_verification": { + "description": "This is a record which can be placed to activate a hostname.", + "oneOf": [ + { + "properties": { + "name": { + "description": "DNS Name for record.", + "example": "_cf-custom-hostname.app.example.com", + "type": "string" + }, + "type": { "description": "DNS Record type.", "enum": ["txt"], "example": "txt" }, + "value": { + "description": "Content for the record.", + "example": "5cc07c04-ea62-4a5a-95f0-419334a875a4", + "type": "string" + } + }, + "type": "object" + } + ], + "type": "object" + }, + "ownership_verification_http": { + "description": "This presents the token to be served by the given http url to activate a hostname.", + "oneOf": [ + { + "properties": { + "http_body": { + "description": "Token to be served.", + "example": "5cc07c04-ea62-4a5a-95f0-419334a875a4", + "type": "string" + }, + "http_url": { + "description": "The HTTP URL that will be checked during custom hostname verification and where the customer should host the token.", + "example": "http://custom.test.com/.well-known/cf-custom-hostname-challenge/0d89c70d-ad9f-4843-b99f-6cc0252067e9", + "type": "string" + } + }, + "type": "object" + } + ], + "type": "object" + }, + "p50": { + "description": "The p50 quantile of requests (in period_seconds).", + "readOnly": true, + "type": "integer" + }, + "p90": { + "description": "The p90 quantile of requests (in period_seconds).", + "readOnly": true, + "type": "integer" + }, + "p99": { + "description": "The p99 quantile of requests (in period_seconds).", + "readOnly": true, + "type": "integer" + }, + "package": { + "oneOf": [ + { "$ref": "#/components/schemas/package_definition" }, + { "$ref": "#/components/schemas/anomaly_package" } + ], + "type": "object" + }, + "package_components-schemas-description": { + "description": "A summary of the purpose/function of the WAF package.", + "example": "null", + "readOnly": true, + "type": "string" + }, + "package_components-schemas-identifier": { + "description": "The unique identifier of a WAF package.", + "example": "a25a9a7e9c00afc1fb2e0245519d725b", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "package_components-schemas-name": { + "description": "The name of the WAF package.", + "example": "USER", + "readOnly": true, + "type": "string" + }, + "package_components-schemas-status": { + "default": "active", + "description": "When set to `active`, indicates that the WAF package will be applied to the zone.", + "enum": ["active"], + "readOnly": true, + "type": "string" + }, + "package_definition": { + "properties": { + "description": { "$ref": "#/components/schemas/package_components-schemas-description" }, + "detection_mode": { "$ref": "#/components/schemas/detection_mode" }, + "id": { "$ref": "#/components/schemas/package_components-schemas-identifier" }, + "name": { "$ref": "#/components/schemas/package_components-schemas-name" }, + "status": { "$ref": "#/components/schemas/package_components-schemas-status" }, + "zone_id": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + "required": ["id", "name", "description", "detection_mode", "zone_id"], + "title": "Traditional WAF package" + }, + "package_response_collection": { + "anyOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/package" }, "type": "array" } } } + ] + }, + "package_response_single": { + "oneOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } } } + ] + }, + "packet_count": { "description": "Number of packets with a response from this node.", "type": "integer" }, + "packet_type": { + "default": "icmp", + "description": "Type of packet sent.", + "enum": ["icmp", "tcp", "udp", "gre", "gre+icmp"], + "example": "icmp", + "type": "string" + }, + "packets_lost": { "description": "Number of packets where no response was received.", "type": "integer" }, + "packets_per_ttl": { + "default": 3, + "description": "Number of packets sent at each TTL.", + "maximum": 10, + "minimum": 0, + "type": "integer" + }, + "packets_sent": { "description": "Number of packets sent with specified TTL.", "type": "integer" }, + "packets_ttl": { "description": "The time to live (TTL).", "type": "integer" }, + "padding": { + "default": 0.05, + "description": "The whitespace between the adjacent edges (determined by position) of the video and the image. `0.0` indicates no padding, and `1.0` indicates a fully padded video width or length, as determined by the algorithm.", + "example": 0.1, + "maximum": 1, + "minimum": 0, + "readOnly": true, + "type": "number" + }, + "page": { "description": "Current page within paginated list of results.", "example": 1, "type": "number" }, + "page-rule": { + "properties": { + "actions": { "$ref": "#/components/schemas/actions" }, + "created_on": { "$ref": "#/components/schemas/created_on-kB9fypz8" }, + "id": { "$ref": "#/components/schemas/schemas-identifier" }, + "modified_on": { "$ref": "#/components/schemas/schemas-modified_on-DUFYxWOX" }, + "priority": { "$ref": "#/components/schemas/priority-21tFu5p5" }, + "status": { "$ref": "#/components/schemas/status-cnKVAn0b" }, + "targets": { "$ref": "#/components/schemas/targets" } + }, + "required": ["id", "targets", "actions", "priority", "status", "modified_on", "created_on"], + "type": "object" + }, + "pagerduty": { + "properties": { + "id": { "$ref": "#/components/schemas/uuid-s0SXln0q" }, + "name": { "$ref": "#/components/schemas/pagerduty_components-schemas-name" } + }, + "type": "object" + }, + "pagerduty_components-schemas-name": { + "description": "The name of the pagerduty service.", + "example": "My PagerDuty Service", + "type": "string" + }, + "pagerduty_components-schemas-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/pagerduty" }, "type": "array" } } } + ] + }, + "pagerule_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-api-response-common" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/page-rule" }, "type": "array" } } } + ] + }, + "pagerule_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single-ktIvFt8K" }, + { "properties": { "result": { "type": "object" } } } + ] + }, + "pagerule_settings_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-api-response-common" }, + { "properties": { "result": { "$ref": "#/components/schemas/settings" } } } + ] + }, + "pageviews": { + "description": "Breakdown of totals for pageviews.", + "properties": { + "all": { "description": "The total number of pageviews served within the time range.", "type": "integer" }, + "search_engine": { + "description": "A variable list of key/value pairs representing the search engine and number of hits.", + "example": { "baidubot": 1345, "bingbot": 5372, "googlebot": 35272, "pingdom": 13435 }, + "type": "object" + } + }, + "type": "object" + }, + "parameter_schemas": { + "properties": { + "parameter_schemas": { + "properties": { + "last_updated": { "$ref": "#/components/schemas/timestamp" }, + "parameter_schemas": { "$ref": "#/components/schemas/parameter_schemas_definition" } + }, + "type": "object" + } + }, + "readOnly": true, + "required": ["parameter_schemas", "last_updated"], + "type": "object" + }, + "parameter_schemas_definition": { + "description": "An operation schema object containing a response.", + "example": { + "parameters": [ + { + "description": "Sufficient requests have been observed for this parameter to provide high confidence in this parameter schema.", + "in": "path", + "name": "var1", + "required": true, + "schema": { "maximum": 10, "minimum": 1, "type": "integer" } + } + ], + "responses": null + }, + "properties": { + "parameters": { + "description": "An array containing the learned parameter schemas.", + "example": [ + { + "description": "Sufficient requests have been observed for this parameter to provide high confidence in this parameter schema.", + "in": "path", + "name": "var1", + "required": true, + "schema": { "maximum": 10, "minimum": 1, "type": "integer" } + } + ], + "items": {}, + "readOnly": true, + "type": "array" + }, + "responses": { + "description": "An empty response object. This field is required to yield a valid operation schema.", + "readOnly": true, + "type": "object" + } + }, + "readOnly": true, + "type": "object" + }, + "passive-dns-by-ip": { + "properties": { + "count": { + "description": "Total results returned based on your search parameters.", + "example": 1, + "type": "number" + }, + "page": { "description": "Current page within paginated list of results.", "example": 1, "type": "number" }, + "per_page": { "description": "Number of results per page of results.", "example": 20, "type": "number" }, + "reverse_records": { + "description": "Reverse DNS look-ups observed during the time period.", + "items": { + "properties": { + "first_seen": { + "description": "First seen date of the DNS record during the time period.", + "example": "2021-04-01", + "format": "date", + "type": "string" + }, + "hostname": { "description": "Hostname that the IP was observed resolving to." }, + "last_seen": { + "description": "Last seen date of the DNS record during the time period.", + "example": "2021-04-30", + "format": "date", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + } + }, + "passive-dns-by-ip_components-schemas-single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/passive-dns-by-ip" } } } + ] + }, + "patch": { + "description": "Update enablement of Argo Smart Routing", + "properties": { "value": { "$ref": "#/components/schemas/schemas-value" } }, + "required": ["value"], + "type": "object" + }, + "patch_pools_notification_email": { + "description": "The email address to send health status notifications to. This field is now deprecated in favor of Cloudflare Notifications for Load Balancing, so only resetting this field with an empty string `\"\"` is accepted.", + "enum": ["\"\""], + "example": "", + "type": "string" + }, + "patch_rule": { + "properties": { + "action": { "$ref": "#/components/schemas/rule_action" }, + "description": { "$ref": "#/components/schemas/rule_description" }, + "enabled": { "$ref": "#/components/schemas/rule_enabled" }, + "expression": { "$ref": "#/components/schemas/rule_expression" }, + "position": { "$ref": "#/components/schemas/rule_position" } + }, + "required": ["action", "expression"] + }, + "path": { + "default": "/", + "description": "Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported.", + "example": "/shop/checkout", + "type": "string" + }, + "path-I0p9X4oI": { + "default": "/", + "description": "The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors.", + "example": "/health", + "type": "string" + }, + "path-N56b8ntG": { + "default": "/", + "description": "The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors.", + "example": "/health", + "type": "string" + }, + "path_cookie_attribute": { + "default": false, + "description": "Enables cookie paths to scope an application's JWT to the application path. If disabled, the JWT will scope to the hostname by default", + "example": true, + "type": "boolean" + }, + "pattern": { + "description": "A pattern that matches an entry", + "properties": { + "regex": { "description": "The regex pattern.", "example": "^4[0-9]{6,14}$", "type": "string" }, + "validation": { + "description": "Validation algorithm for the pattern. This algorithm will get run on potential matches, and if it returns false, the entry will not be matched.", + "enum": ["luhn"], + "example": "luhn", + "type": "string" + } + }, + "required": ["regex"], + "title": "Pattern", + "type": "object" + }, + "pattern-prw776lg": { "example": "example.net/*", "title": "Route pattern", "type": "string" }, + "paused": { + "default": false, + "description": "Indicates whether the zone is only using Cloudflare DNS services. A\ntrue value means the zone will not receive security or performance\nbenefits.\n", + "readOnly": true, + "type": "boolean" + }, + "paused-jas4Z8f1": { + "description": "When true, indicates that the WAF package is currently paused.", + "type": "boolean" + }, + "pcaps_byte_limit": { + "description": "The maximum number of bytes to capture. This field only applies to `full` packet captures.", + "example": 500000, + "maximum": 1000000000, + "minimum": 1, + "type": "number" + }, + "pcaps_collection_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "items": { + "anyOf": [ + { "$ref": "#/components/schemas/pcaps_response_simple" }, + { "$ref": "#/components/schemas/pcaps_response_full" } + ] + }, + "type": "array" + } + } + } + ] + }, + "pcaps_colo_name": { + "description": "The name of the data center used for the packet capture. This can be a specific colo (ord02) or a multi-colo name (ORD). This field only applies to `full` packet captures.", + "example": "ord02", + "type": "string" + }, + "pcaps_destination_conf": { + "description": "The full URI for the bucket. This field only applies to `full` packet captures.", + "example": "s3://pcaps-bucket?region=us-east-1", + "type": "string" + }, + "pcaps_error_message": { + "description": "An error message that describes why the packet capture failed. This field only applies to `full` packet captures.", + "example": "No packets matched the filter in the time limit given. Please modify the filter or try again.", + "type": "string" + }, + "pcaps_filter_v1": { + "description": "The packet capture filter. When this field is empty, all packets are captured.", + "properties": { + "destination_address": { + "description": "The destination IP address of the packet.", + "example": "1.2.3.4", + "type": "string" + }, + "destination_port": { "description": "The destination port of the packet.", "example": 80, "type": "number" }, + "protocol": { "description": "The protocol number of the packet.", "example": 6, "type": "number" }, + "source_address": { + "description": "The source IP address of the packet.", + "example": "1.2.3.4", + "type": "string" + }, + "source_port": { "description": "The source port of the packet.", "example": 123, "type": "number" } + }, + "type": "object" + }, + "pcaps_id": { + "description": "The ID for the packet capture.", + "example": "66802ca5668e47a2b82c2e6746e45037", + "maxLength": 32, + "minLength": 32, + "type": "string" + }, + "pcaps_ownership_challenge": { + "description": "The ownership challenge filename stored in the bucket.", + "example": "ownership-challenge-9883874ecac311ec8475433579a6bf5f.txt", + "type": "string" + }, + "pcaps_ownership_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "items": { "$ref": "#/components/schemas/pcaps_ownership_response" }, + "nullable": true, + "type": "array" + } + } + } + ] + }, + "pcaps_ownership_request": { + "properties": { "destination_conf": { "$ref": "#/components/schemas/pcaps_destination_conf" } }, + "required": ["destination_conf"], + "type": "object" + }, + "pcaps_ownership_response": { + "properties": { + "destination_conf": { "$ref": "#/components/schemas/pcaps_destination_conf" }, + "filename": { "$ref": "#/components/schemas/pcaps_ownership_challenge" }, + "id": { + "description": "The bucket ID associated with the packet captures API.", + "example": "9883874ecac311ec8475433579a6bf5f", + "maxLength": 32, + "minLength": 32, + "type": "string" + }, + "status": { + "description": "The status of the ownership challenge. Can be pending, success or failed.", + "enum": ["pending", "success", "failed"], + "example": "success", + "type": "string" + }, + "submitted": { + "description": "The RFC 3339 timestamp when the bucket was added to packet captures API.", + "example": "2020-01-01T08:00:00Z", + "type": "string" + }, + "validated": { + "description": "The RFC 3339 timestamp when the bucket was validated.", + "example": "2020-01-01T08:00:00Z", + "type": "string" + } + }, + "required": ["id", "status", "submitted", "destination_conf", "filename"], + "type": "object" + }, + "pcaps_ownership_single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { "properties": { "result": { "$ref": "#/components/schemas/pcaps_ownership_response" } } } + ] + }, + "pcaps_ownership_validate_request": { + "properties": { + "destination_conf": { "$ref": "#/components/schemas/pcaps_destination_conf" }, + "ownership_challenge": { "$ref": "#/components/schemas/pcaps_ownership_challenge" } + }, + "required": ["destination_conf", "ownership_challenge"], + "type": "object" + }, + "pcaps_packet_limit": { + "description": "The limit of packets contained in a packet capture.", + "example": 10000, + "maximum": 10000, + "minimum": 1, + "type": "number" + }, + "pcaps_request_full": { + "properties": { + "byte_limit": { "$ref": "#/components/schemas/pcaps_byte_limit" }, + "colo_name": { "$ref": "#/components/schemas/pcaps_colo_name" }, + "destination_conf": { "$ref": "#/components/schemas/pcaps_destination_conf" }, + "filter_v1": { "$ref": "#/components/schemas/pcaps_filter_v1" }, + "packet_limit": { "$ref": "#/components/schemas/pcaps_packet_limit" }, + "system": { "$ref": "#/components/schemas/pcaps_system" }, + "time_limit": { "$ref": "#/components/schemas/pcaps_time_limit" }, + "type": { "$ref": "#/components/schemas/pcaps_type" } + }, + "required": ["time_limit", "type", "system", "colo_name", "destination_conf"], + "type": "object" + }, + "pcaps_request_pcap": { + "anyOf": [ + { "$ref": "#/components/schemas/pcaps_request_simple" }, + { "$ref": "#/components/schemas/pcaps_request_full" } + ] + }, + "pcaps_request_simple": { + "properties": { + "filter_v1": { "$ref": "#/components/schemas/pcaps_filter_v1" }, + "packet_limit": { "$ref": "#/components/schemas/pcaps_packet_limit" }, + "system": { "$ref": "#/components/schemas/pcaps_system" }, + "time_limit": { "$ref": "#/components/schemas/pcaps_time_limit" }, + "type": { "$ref": "#/components/schemas/pcaps_type" } + }, + "required": ["time_limit", "packet_limit", "type", "system"], + "type": "object" + }, + "pcaps_response_full": { + "properties": { + "byte_limit": { "$ref": "#/components/schemas/pcaps_byte_limit" }, + "colo_name": { "$ref": "#/components/schemas/pcaps_colo_name" }, + "destination_conf": { "$ref": "#/components/schemas/pcaps_destination_conf" }, + "error_message": { "$ref": "#/components/schemas/pcaps_error_message" }, + "filter_v1": { "$ref": "#/components/schemas/pcaps_filter_v1" }, + "id": { "$ref": "#/components/schemas/pcaps_id" }, + "status": { "$ref": "#/components/schemas/pcaps_status" }, + "submitted": { "$ref": "#/components/schemas/pcaps_submitted" }, + "system": { "$ref": "#/components/schemas/pcaps_system" }, + "time_limit": { "$ref": "#/components/schemas/pcaps_time_limit" }, + "type": { "$ref": "#/components/schemas/pcaps_type" } + }, + "type": "object" + }, + "pcaps_response_simple": { + "properties": { + "filter_v1": { "$ref": "#/components/schemas/pcaps_filter_v1" }, + "id": { "$ref": "#/components/schemas/pcaps_id" }, + "status": { "$ref": "#/components/schemas/pcaps_status" }, + "submitted": { "$ref": "#/components/schemas/pcaps_submitted" }, + "system": { "$ref": "#/components/schemas/pcaps_system" }, + "time_limit": { "$ref": "#/components/schemas/pcaps_time_limit" }, + "type": { "$ref": "#/components/schemas/pcaps_type" } + }, + "type": "object" + }, + "pcaps_single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "anyOf": [ + { "$ref": "#/components/schemas/pcaps_response_simple" }, + { "$ref": "#/components/schemas/pcaps_response_full" } + ] + } + } + } + ] + }, + "pcaps_status": { + "description": "The status of the packet capture request.", + "enum": [ + "unknown", + "success", + "pending", + "running", + "conversion_pending", + "conversion_running", + "complete", + "failed" + ], + "example": "success", + "type": "string" + }, + "pcaps_submitted": { + "description": "The RFC 3339 timestamp when the packet capture was created.", + "example": "2020-01-01T08:00:00Z", + "type": "string" + }, + "pcaps_system": { + "description": "The system used to collect packet captures.", + "enum": ["magic-transit"], + "example": "magic-transit", + "type": "string" + }, + "pcaps_time_limit": { + "description": "The packet capture duration in seconds.", + "example": 300, + "maximum": 300, + "minimum": 1, + "type": "number" + }, + "pcaps_type": { + "description": "The type of packet capture. `Simple` captures sampled packets, and `full` captures entire payloads and non-sampled packets.", + "enum": ["simple", "full"], + "example": "simple", + "type": "string" + }, + "pctComplete": { + "description": "Indicates the size of the entire upload in bytes. The value must be a non-negative integer.", + "maximum": 100, + "minimum": 0, + "readOnly": true, + "type": "string" + }, + "peer": { + "properties": { + "id": { "$ref": "#/components/schemas/components-schemas-identifier" }, + "ip": { "$ref": "#/components/schemas/ip-anO5UL8J" }, + "ixfr_enable": { "$ref": "#/components/schemas/ixfr_enable" }, + "name": { "$ref": "#/components/schemas/components-schemas-name-0v75iZSQ" }, + "port": { "$ref": "#/components/schemas/port" }, + "tsig_id": { "$ref": "#/components/schemas/tsig_id" } + }, + "required": ["id", "name"], + "type": "object" + }, + "peers": { + "description": "A list of peer tags.", + "example": ["23ff594956f20c2a721606e94745a8aa", "00920f38ce07c2e2f4df50b1f61d4194"], + "items": {}, + "type": "array" + }, + "pem": { + "description": "The signing key in PEM format.", + "example": "LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQpNSUlFcGdJQkFBS0NBUUVBMFRqd2pPaVpXbUo0M3ZmM1RvNERvWG1YV3RKR05HeVhmaHl0dExhQmdGMStFUVdRCkRLaG9LYm9hS21xakNBc21za3V0YkxVN1BVOGRrUU5ER1p3S3VWczA4elNaNGt4aTR0RWdQUFp5dDdkWEMrbFkKUllveXJBR0Y0QVhoeTMyOWJIQ1AxSWxyQkIvQWtHZ25kTEFndW54WTByUmdjdk96aWF3NktKeEZuYzJVSzBXVQo4YjBwNEtLSEdwMUtMOWRrMFdUOGRWWXFiZVJpSmpDbFVFbWg4eXY5Q2xPVmFTNEt4aVg2eFRRNERadzZEYUpmCklWM1F0Tmd2cG1ieWxOSmFQSG5zc3JodDJHS1A5NjJlS2poUVJsaWd2SFhKTE9uSm9KZkxlSUVIWitpeFdmY1QKRE1IOTJzR3ZvdzFET2p4TGlDTjF6SEsraDdiTG9YVGlMZ2M0a3dJREFRQUJBb0lCQVFEQ0lCclNJMTlteGNkdwoycExVaUdCR0N4T3NhVDVLbGhkYUpESG9ZdzUxbEVuTWNXVGUyY01NTkdqaXdsN1NyOFlQMkxmcERaOFJtNzdMCk5rT2tGMnk3M3l5YUhFeEw5S1FyMys0Um9ubCtqTlp2YnV0QVdxSDVodEE0dER4MUd3NE85OEg4YWlTcGh1eWQKRUliTGRrQm54OGlDZUdxbFBnbHZ6Q1dLV0xVZlhGbXplMkF5UjBzaWMyYXZRLzZyclYwb3pDdGQ1T0Vod093agphaCs3N1dZV1l0bkEraDhXZVZreWcvdG44UTJJOXo5ZVJYdlZxR2sxMDZLcWRtZFdiU2tIZzA4cFRUSGhVM2paCnMvZGNjdEdOMWFFanlUQWY0QzdHT2lrcUd1MGFTaW1aeDFOM2RWQzBobngySjJtdlhNQ0VtZ0g3TjVnZUxWUFAKOWdkQjdBQkJBb0dCQU5sT2hGQVhaTHV6Y0Ftczl1K3AxM05STWRFOHpIK2ZFaFBrbk9zZ21Xb3VqUzkxQTRtZgpuK01oN3d5bTZoVU1DbDk2WUNMNGtPM0RUMmlYWlRqTXZuMHBoVEx1MXNYcGxWNDJuamRnZGd3cFBEM0FnL1Y5ClVvV2hxdVhoa1I3RFpsUGg5Nmk1aEE0M1BvbTVPQm9BektJbEcrT3ZKUkhhZEVveC9jSmZScFd2QW9HQkFQWjUKNnNmWDdESElCNEtBczRmMWRuNGZJUkMweUF2WVdCL1R3UzZHUWVoNFRFbDVuSkQwWk9ZRVdUbVVBK3pPanZTNApuM09tZ2xNQTU5SGd1ZW13QXVRcEtwWFBOcFUvTERJaThtNnpmTUpvL3E5M0NOQlFQZngzZGh4ZVh4OXE2Mzg3Cm84QWxkOE42RGs4TThjRis3SlNaeUVJODJzLzdpdGRseXA2bFdLaGRBb0dCQUtnU0VrUGYxQWxZdjA2OGVFRGwKRzc0VkRuTEdrMlFobzltKzk1N2psOFNJUEtwMzFrU2JNUTU3TUdpWXNIT1czRzc4TjE3VTRVTUR6R2NZc1RFOQpLaGVrQldGZldMMjU2OHp5Y1d4akx1bzQrbDdJaDBkWHBudTBqbms5L1AvT0lWYS9iczBRcnhKUHFBN2RNb2JxCkYxdFJXRURCTmVxWkMxaFhVZTBEdzVRQkFvR0JBSjdBQ2NNcnhKcVBycDZVakkyK1FOS2M5Q3dSZEdPRXRjWFMKR3JQL2owWE83YnZKVTFsZHYvc1N3L0U4NzRZL3lIM0F5QnF5SFhDZXZiRkZZQmt1MzczYThlM0pwK3RhNC9scQozdUVFUkEvbmxscW5mWXJHbEJZZlQzaVlKQVpWVkZiL3I4bWJtRmJVTDVFazBqV0JyWmxNcjFwU1hkRGx3QmhhCkhMWXY0em1WQW9HQkFLQmw0cFNnbkNSTEJMUU9jWjhXQmhRSjAwZDZieFNrTGNpZ0xUNFJvY3RwNTY1SHJPMDAKSVFLdElTaEg1a2s3SVRHdUYvOERXZEN2djBMYnhvZVBJc2NFaStTaXk5WDZwWENPaS8xa2FyYVU5U3BpZ3czago3YjVlUVV0UlovTkIycVJwc3EzMEdCUENqanhudEVmK2lqelhUS0xNRndyUDhBMTlQNzRONGVTMAotLS0tLUVORCBSU0EgUFJJVkFURSBLRVktLS0tLQo=", + "readOnly": true, + "type": "string" + }, + "per_page": { + "default": 20, + "description": "Maximum number of results per page.", + "maximum": 50, + "minimum": 5, + "type": "number" + }, + "period": { + "description": "The time in seconds (an integer value) to count matching traffic. If the count exceeds the configured threshold within this period, Cloudflare will perform the configured action.", + "example": 900, + "maximum": 86400, + "minimum": 10, + "type": "number" + }, + "period_seconds": { + "description": "The period over which this threshold is suggested.", + "readOnly": true, + "type": "integer" + }, + "permission_group": { + "description": "A named group of permissions that map to a group of operations against resources.", + "properties": { + "id": { + "description": "Identifier of the group.", + "example": "6d7f2f5f5b1d4a0e9081fdc98d432fd1", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Name of the group.", + "example": "Load Balancers Write", + "readOnly": true, + "type": "string" + } + }, + "required": ["id"], + "type": "object" + }, + "permission_groups": { + "description": "A set of permission groups that are specified to the policy.", + "example": [ + { "id": "c8fed203ed3043cba015a93ad1616f1f", "name": "Zone Read" }, + { "id": "82e64a83756745bbbb1c9c2701bf816b", "name": "DNS Read" } + ], + "items": { "$ref": "#/components/schemas/permission_group" }, + "type": "array" + }, + "permissions": { + "example": { "analytics": { "read": true, "write": false }, "zones": { "read": true, "write": true } }, + "properties": { + "analytics": { "$ref": "#/components/schemas/grants" }, + "billing": { "$ref": "#/components/schemas/grants" }, + "cache_purge": { "$ref": "#/components/schemas/grants" }, + "dns": { "$ref": "#/components/schemas/grants" }, + "dns_records": { "$ref": "#/components/schemas/grants" }, + "lb": { "$ref": "#/components/schemas/grants" }, + "logs": { "$ref": "#/components/schemas/grants" }, + "organization": { "$ref": "#/components/schemas/grants" }, + "ssl": { "$ref": "#/components/schemas/grants" }, + "waf": { "$ref": "#/components/schemas/grants" }, + "zone_settings": { "$ref": "#/components/schemas/grants" }, + "zones": { "$ref": "#/components/schemas/grants" } + }, + "type": "object" + }, + "phase": { + "description": "The phase of the ruleset.", + "example": "http_request_firewall_managed", + "pattern": "^[a-z_]+$", + "type": "string" + }, + "phishing-url-info": { + "properties": { + "categorizations": { + "description": "List of categorizations applied to this submission.", + "items": { + "properties": { + "category": { "description": "Name of the category applied.", "example": "PHISHING", "type": "string" }, + "verification_status": { + "description": "Result of human review for this categorization.", + "example": "confirmed", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "model_results": { + "description": "List of model results for completed scans.", + "items": { + "properties": { + "model_name": { + "description": "Name of the model.", + "example": "MACHINE_LEARNING_v2", + "type": "string" + }, + "model_score": { + "description": "Score output by the model for this submission.", + "example": 0.024, + "type": "number" + } + }, + "type": "object" + }, + "type": "array" + }, + "rule_matches": { + "description": "List of signatures that matched against site content found when crawling the URL.", + "items": { + "properties": { + "banning": { "description": "For internal use.", "type": "boolean" }, + "blocking": { "description": "For internal use.", "type": "boolean" }, + "description": { + "description": "Description of the signature that matched.", + "example": "Match frequently used social followers phishing kit", + "type": "string" + }, + "name": { + "description": "Name of the signature that matched.", + "example": "phishkit.social_followers", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "scan_status": { + "description": "Status of the most recent scan found.", + "properties": { + "last_processed": { + "description": "Timestamp of when the submission was processed.", + "example": "Wed, 26 Oct 2022 16:04:51 GMT", + "type": "string" + }, + "scan_complete": { "description": "For internal use.", "type": "boolean" }, + "status_code": { + "description": "Status code that the crawler received when loading the submitted URL.", + "type": "integer" + }, + "submission_id": { "description": "ID of the most recent submission.", "type": "integer" } + }, + "type": "object" + }, + "screenshot_download_signature": { "description": "For internal use.", "type": "string" }, + "screenshot_path": { "description": "For internal use.", "type": "string" }, + "url": { "description": "URL that was submitted.", "example": "https://www.cloudflare.com", "type": "string" } + } + }, + "phishing-url-info_components-schemas-single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/phishing-url-info" } } } + ] + }, + "phishing-url-submit": { + "properties": { + "excluded_urls": { + "description": "URLs that were excluded from scanning because their domain is in our no-scan list.", + "items": { + "properties": { + "url": { + "description": "URL that was excluded.", + "example": "https://developers.cloudflare.com", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "skipped_urls": { + "description": "URLs that were skipped because the same URL is currently being scanned", + "items": { + "properties": { + "url": { + "description": "URL that was skipped.", + "example": "https://www.cloudflare.com/developer-week/", + "type": "string" + }, + "url_id": { + "description": "ID of the submission of that URL that is currently scanning.", + "example": 2, + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + }, + "submitted_urls": { + "description": "URLs that were successfully submitted for scanning.", + "items": { + "properties": { + "url": { + "description": "URL that was submitted.", + "example": "https://www.cloudflare.com", + "type": "string" + }, + "url_id": { + "description": "ID assigned to this URL submission. Used to retrieve scanning results.", + "example": 1, + "type": "integer" + } + }, + "type": "object" + }, + "type": "array" + } + } + }, + "phishing-url-submit_components-schemas-single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/phishing-url-submit" } } } + ] + }, + "pingone": { + "allOf": [ + { "$ref": "#/components/schemas/identity-provider" }, + { + "properties": { + "config": { + "allOf": [ + { "$ref": "#/components/schemas/generic-oauth-config" }, + { + "properties": { + "ping_env_id": { + "description": "Your PingOne environment identifier", + "example": "342b5660-0c32-4936-a5a4-ce21fae57b0a", + "type": "string" + } + }, + "type": "object" + } + ] + } + }, + "type": "object" + } + ], + "title": "PingOne", + "type": "object" + }, + "plan_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/schemas-rate-plan" }, "type": "array" } + }, + "type": "object" + } + ] + }, + "platform": { "enum": ["windows", "mac", "linux", "android", "ios"], "example": "windows", "type": "string" }, + "playback": { + "properties": { + "dash": { + "description": "DASH Media Presentation Description for the video.", + "example": "https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/manifest/video.mpd", + "readOnly": true, + "type": "string" + }, + "hls": { + "description": "The HLS manifest for the video.", + "example": "https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/manifest/video.m3u8", + "readOnly": true, + "type": "string" + } + }, + "readOnly": true, + "type": "object" + }, + "playback_rtmps": { + "description": "Details for playback from an live input using RTMPS.", + "properties": { + "streamKey": { "$ref": "#/components/schemas/playback_rtmps_stream_key" }, + "url": { "$ref": "#/components/schemas/playback_rtmps_url" } + }, + "type": "object" + }, + "playback_rtmps_stream_key": { + "description": "The secret key to use for playback via RTMPS.", + "example": "2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada", + "readOnly": true, + "type": "string" + }, + "playback_rtmps_url": { + "description": "The URL used to play live video over RTMPS.", + "example": "rtmps://live.cloudflare.com:443/live/", + "readOnly": true, + "type": "string" + }, + "playback_srt": { + "description": "Details for playback from an live input using SRT.", + "properties": { + "passphrase": { "$ref": "#/components/schemas/playback_srt_stream_passphrase" }, + "streamId": { "$ref": "#/components/schemas/playback_srt_stream_id" }, + "url": { "$ref": "#/components/schemas/playback_srt_url" } + }, + "type": "object" + }, + "playback_srt_stream_id": { + "description": "The identifier of the live input to use for playback via SRT.", + "example": "f256e6ea9341d51eea64c9454659e576", + "readOnly": true, + "type": "string" + }, + "playback_srt_stream_passphrase": { + "description": "The secret key to use for playback via SRT.", + "example": "2fb3cb9f17e68a2568d6ebed8d5505eak3ceaf8c9b1f395e1b76b79332497cada", + "readOnly": true, + "type": "string" + }, + "playback_srt_url": { + "description": "The URL used to play live video over SRT.", + "example": "rtmps://live.cloudflare.com:443/live/", + "readOnly": true, + "type": "string" + }, + "playback_webrtc": { + "description": "Details for playback from a live input using WebRTC.", + "properties": { "url": { "$ref": "#/components/schemas/playback_webrtc_url" } }, + "type": "object" + }, + "playback_webrtc_url": { + "description": "The URL used to play live video over WebRTC.", + "example": "https://customer-m033z5x00ks6nunl.cloudflarestream.com/b236bde30eb07b9d01318940e5fc3edake34a3efb3896e18f2dc277ce6cc993ad/webRTC/play", + "readOnly": true, + "type": "string" + }, + "policies": { + "properties": { + "approval_groups": { "$ref": "#/components/schemas/approval_groups" }, + "approval_required": { "$ref": "#/components/schemas/approval_required" }, + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "decision": { "$ref": "#/components/schemas/decision" }, + "exclude": { "$ref": "#/components/schemas/schemas-exclude" }, + "id": { "$ref": "#/components/schemas/components-schemas-uuid" }, + "include": { "$ref": "#/components/schemas/include" }, + "name": { "$ref": "#/components/schemas/policies_components-schemas-name" }, + "precedence": { "$ref": "#/components/schemas/precedence-GXhj5toi" }, + "purpose_justification_prompt": { "$ref": "#/components/schemas/purpose_justification_prompt" }, + "purpose_justification_required": { "$ref": "#/components/schemas/purpose_justification_required" }, + "require": { "$ref": "#/components/schemas/schemas-require" }, + "updated_at": { "$ref": "#/components/schemas/timestamp" } + }, + "type": "object" + }, + "policies-iecjppBc": { + "description": "List of access policies assigned to the token.", + "items": { "$ref": "#/components/schemas/access-policy" }, + "type": "array" + }, + "policies_components-schemas-description": { + "description": "Optional description for the Notification policy.", + "example": "Something describing the policy.", + "type": "string" + }, + "policies_components-schemas-enabled": { + "default": true, + "description": "Whether or not the Notification policy is enabled.", + "example": true, + "type": "boolean" + }, + "policies_components-schemas-id_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { "id": { "$ref": "#/components/schemas/components-schemas-uuid" } }, + "type": "object" + } + } + } + ] + }, + "policies_components-schemas-id_response-2": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { "properties": { "id": { "$ref": "#/components/schemas/uuid-s0SXln0q" } }, "type": "object" } + } + } + ] + }, + "policies_components-schemas-name": { + "description": "The name of the Access policy.", + "example": "Allow devs", + "type": "string" + }, + "policies_components-schemas-name-2": { + "description": "Name of the policy.", + "example": "SSL Notification Event Policy", + "type": "string" + }, + "policies_components-schemas-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/policies" }, "type": "array" } } } + ] + }, + "policies_components-schemas-response_collection-2": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/components-schemas-policies" }, "type": "array" } + } + } + ] + }, + "policies_components-schemas-response_collection-MqgLqMjN": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/schemas-policies" }, "type": "array" } + } + } + ] + }, + "policies_components-schemas-single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/policies" } } } + ] + }, + "policies_components-schemas-single_response-2": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/components-schemas-policies" } } } + ] + }, + "policies_components-schemas-single_response-XqehVx27": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/schemas-policies" } } } + ] + }, + "policy": { + "description": "Specify the policy that determines the region where your private key will be held locally. HTTPS connections to any excluded data center will still be fully encrypted, but will incur some latency while Keyless SSL is used to complete the handshake with the nearest allowed data center. Any combination of countries, specified by their two letter country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) can be chosen, such as 'country: IN', as well as 'region: EU' which refers to the EU region. If there are too few data centers satisfying the policy, it will be rejected.", + "example": "(country: US) or (region: EU)", + "type": "string" + }, + "policy_check_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "app_state": { + "properties": { + "app_uid": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" }, + "aud": { + "example": "737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe389", + "type": "string" + }, + "hostname": { "example": "test.com", "type": "string" }, + "name": { "example": "Test App", "type": "string" }, + "policies": { + "example": [ + { + "decision": "allow", + "exclude": [], + "include": [{ "_type": "email", "email": "testuser@gmail.com" }], + "precedence": 0, + "require": [], + "status": "Success" + } + ], + "items": {}, + "type": "array" + }, + "status": { "example": "Success", "type": "string" } + }, + "type": "object" + }, + "user_identity": { + "properties": { + "account_id": { "example": "41ecfbb341f033e52b46742756aabb8b", "type": "string" }, + "device_sessions": { "example": {}, "type": "object" }, + "email": { "example": "testuser@gmail.com", "type": "string" }, + "geo": { "properties": { "country": { "example": "US", "type": "string" } }, "type": "object" }, + "iat": { "type": "integer" }, + "id": { "example": "1164449231815010287495", "type": "string" }, + "is_gateway": { "example": false, "type": "boolean" }, + "is_warp": { "example": false, "type": "boolean" }, + "name": { "example": "Test User", "type": "string" }, + "user_uuid": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" }, + "version": { "type": "integer" } + }, + "type": "object" + } + }, + "type": "object" + } + } + } + ] + }, + "policy_check_response-nLfQoCS8": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "app_state": { + "properties": { + "app_uid": { "$ref": "#/components/schemas/uuid-s0SXln0q" }, + "aud": { + "example": "737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe389", + "type": "string" + }, + "hostname": { "example": "test.com", "type": "string" }, + "name": { "example": "Test App", "type": "string" }, + "policies": { + "example": [ + { + "decision": "allow", + "exclude": [], + "include": [{ "_type": "email", "email": "testuser@gmail.com" }], + "precedence": 0, + "require": [], + "status": "Success" + } + ], + "items": {}, + "type": "array" + }, + "status": { "example": "Success", "type": "string" } + }, + "type": "object" + }, + "user_identity": { + "properties": { + "account_id": { "example": "41ecfbb341f033e52b46742756aabb8b", "type": "string" }, + "device_sessions": { "example": {}, "type": "object" }, + "email": { "example": "testuser@gmail.com", "type": "string" }, + "geo": { "properties": { "country": { "example": "US", "type": "string" } }, "type": "object" }, + "iat": { "type": "integer" }, + "id": { "example": "1164449231815010287495", "type": "string" }, + "is_gateway": { "example": false, "type": "boolean" }, + "is_warp": { "example": false, "type": "boolean" }, + "name": { "example": "Test User", "type": "string" }, + "user_uuid": { "$ref": "#/components/schemas/uuid-s0SXln0q" }, + "version": { "type": "integer" } + }, + "type": "object" + } + }, + "type": "object" + } + } + } + ] + }, + "policy_with_permission_groups": { + "properties": { + "effect": { "$ref": "#/components/schemas/effect" }, + "id": { "$ref": "#/components/schemas/identifier-ECDhGQVO" }, + "permission_groups": { "$ref": "#/components/schemas/permission_groups" }, + "resources": { "$ref": "#/components/schemas/resources" } + }, + "required": ["id", "effect", "resources", "permission_groups"], + "title": "policy_with_permission_groups" + }, + "polish": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { "description": "ID of the zone setting.", "enum": ["polish"], "example": "polish" }, + "value": { "$ref": "#/components/schemas/polish_value" } + } + } + ], + "description": "Removes metadata and compresses your images for faster page load times. Basic (Lossless): Reduce the size of PNG, JPEG, and GIF files - no impact on visual quality. Basic + JPEG (Lossy): Further reduce the size of JPEG files for faster image loading. Larger JPEGs are converted to progressive images, loading a lower-resolution image first and ending in a higher-resolution version. Not recommended for hi-res photography sites.", + "title": "Polish Image Optimization" + }, + "polish_value": { + "default": "off", + "description": "Value of the zone setting.", + "enum": ["off", "lossless", "lossy"], + "type": "string" + }, + "pool": { + "properties": { + "check_regions": { "$ref": "#/components/schemas/check_regions-fqlLEr38" }, + "created_on": { "$ref": "#/components/schemas/timestamp" }, + "description": { "$ref": "#/components/schemas/pool_components-schemas-description" }, + "disabled_at": { "$ref": "#/components/schemas/schemas-disabled_at" }, + "enabled": { "$ref": "#/components/schemas/pool_components-schemas-enabled" }, + "id": { "$ref": "#/components/schemas/pool_components-schemas-identifier" }, + "latitude": { "$ref": "#/components/schemas/latitude" }, + "load_shedding": { "$ref": "#/components/schemas/load_shedding" }, + "longitude": { "$ref": "#/components/schemas/longitude" }, + "minimum_origins": { "$ref": "#/components/schemas/minimum_origins" }, + "modified_on": { "$ref": "#/components/schemas/timestamp" }, + "monitor": { "$ref": "#/components/schemas/schemas-monitor" }, + "name": { "$ref": "#/components/schemas/pool_components-schemas-name" }, + "notification_email": { "$ref": "#/components/schemas/notification_email" }, + "notification_filter": { "$ref": "#/components/schemas/notification_filter" }, + "origin_steering": { "$ref": "#/components/schemas/origin_steering" }, + "origins": { "$ref": "#/components/schemas/origins" } + }, + "type": "object" + }, + "pool-Dw5V2rGp": { + "properties": { + "check_regions": { "$ref": "#/components/schemas/check_regions-q46IR1gk" }, + "created_on": { "$ref": "#/components/schemas/timestamp" }, + "description": { "$ref": "#/components/schemas/schemas-description-XvtZaN2T" }, + "disabled_at": { "$ref": "#/components/schemas/schemas-disabled_at" }, + "enabled": { "$ref": "#/components/schemas/enabled-WoQtkwsn" }, + "id": { "$ref": "#/components/schemas/schemas-identifier-LDS3pdXe" }, + "latitude": { "$ref": "#/components/schemas/latitude" }, + "load_shedding": { "$ref": "#/components/schemas/load_shedding" }, + "longitude": { "$ref": "#/components/schemas/longitude" }, + "minimum_origins": { "$ref": "#/components/schemas/minimum_origins" }, + "modified_on": { "$ref": "#/components/schemas/timestamp" }, + "monitor": { "$ref": "#/components/schemas/schemas-monitor" }, + "name": { "$ref": "#/components/schemas/name-Pky1OOiR" }, + "notification_email": { "$ref": "#/components/schemas/notification_email" }, + "notification_filter": { "$ref": "#/components/schemas/notification_filter" }, + "origin_steering": { "$ref": "#/components/schemas/origin_steering" }, + "origins": { "$ref": "#/components/schemas/origins-BzaDTSuG" } + }, + "type": "object" + }, + "pool_components-schemas-description": { + "description": "A human-readable description of the pool.", + "example": "Primary data center - Provider XYZ", + "type": "string" + }, + "pool_components-schemas-enabled": { + "default": true, + "description": "Whether to enable (the default) or disable this pool. Disabled pools will not receive traffic and are excluded from health checks. Disabling a pool will cause any load balancers using it to failover to the next pool (if any).", + "example": false, + "type": "boolean" + }, + "pool_components-schemas-identifier": { "example": "17b5962d775c646f3f9725cbc7a53df4" }, + "pool_components-schemas-name": { + "description": "A short name (tag) for the pool. Only alphanumeric characters, hyphens, and underscores are allowed.", + "example": "primary-dc-1", + "type": "string" + }, + "pool_components-schemas-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/pool" }, "type": "array" } } } + ] + }, + "pool_components-schemas-single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/pool" } } } + ] + }, + "pool_name": { "description": "The name for the pool to filter.", "example": "primary-dc", "type": "string" }, + "pop_pools": { + "description": "(Enterprise only): A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding country_pool, then region_pool mapping if it exists else to default_pools.", + "example": { + "LAX": ["de90f38ced07c2e2f4df50b1f61d4194", "9290f38c5d07c2e2f4df57b1f61d4196"], + "LHR": ["abd90f38ced07c2e2f4df50b1f61d4194", "f9138c5d07c2e2f4df57b1f61d4196"], + "SJC": ["00920f38ce07c2e2f4df50b1f61d4194"] + }, + "type": "object" + }, + "popularity_rank": { + "description": "Global Cloudflare 100k ranking for the last 30 days, if available for the hostname. The top ranked domain is 1, the lowest ranked domain is 100,000.", + "type": "integer" + }, + "port": { + "description": "DNS port of primary or secondary nameserver, depending on what zone this peer is linked to.", + "example": 53, + "type": "number" + }, + "port-0Rcq4sy6": { + "default": 24008, + "description": "The keyless SSL port used to commmunicate between Cloudflare and the client's Keyless SSL server.", + "example": 24008, + "maxLength": 65535, + "type": "number" + }, + "port-WXwz9tIV": { + "default": 0, + "description": "Port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).", + "type": "integer" + }, + "port-z0PISaVA": { + "default": 24008, + "description": "The keyless SSL port used to communicate between Cloudflare and the client's Keyless SSL server.", + "example": 24008, + "maxLength": 65535, + "type": "number" + }, + "position": { + "default": "upperRight", + "description": "The location of the image. Valid positions are: `upperRight`, `upperLeft`, `lowerLeft`, `lowerRight`, and `center`. Note that `center` ignores the `padding` parameter.", + "example": "center", + "readOnly": true, + "type": "string" + }, + "precedence": { + "description": "Precedence sets the ordering of the rules. Lower values indicate higher precedence. At each processing phase, applicable rules are evaluated in ascending order of this value.", + "type": "integer" + }, + "precedence-3goMFnFD": { + "description": "The order of execution for this policy. Must be unique for each policy.", + "type": "integer" + }, + "precedence-GXhj5toi": { + "description": "The order of execution for this policy. Must be unique for each policy.", + "type": "integer" + }, + "precedence-HZLvpi3q": { + "description": "The precedence of the policy. Lower values indicate higher precedence. Policies will be evaluated in ascending order of this field.", + "example": 100, + "type": "number" + }, + "predefined_entry": { + "description": "A predefined entry that matches a profile", + "properties": { + "enabled": { "description": "Whether the entry is enabled or not.", "example": true, "type": "boolean" }, + "id": { "$ref": "#/components/schemas/entry_id-A2p6ZYit" }, + "name": { "description": "The name of the entry.", "example": "Credit card (Visa)", "type": "string" }, + "profile_id": { "description": "ID of the parent profile" } + }, + "title": "Predefined entry", + "type": "object" + }, + "predefined_profile": { + "properties": { + "allowed_match_count": { "$ref": "#/components/schemas/allowed_match_count" }, + "entries": { + "description": "The entries for this profile.", + "items": { "$ref": "#/components/schemas/predefined_entry" }, + "type": "array" + }, + "id": { "$ref": "#/components/schemas/profile_id-JwqwymCp" }, + "name": { "description": "The name of the profile.", "example": "Generic CVV Card Number", "type": "string" }, + "type": { + "description": "The type of the profile.", + "enum": ["predefined"], + "example": "predefined", + "type": "string" + } + }, + "title": "Predefined profile", + "type": "object" + }, + "predefined_profile_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "allOf": [{ "$ref": "#/components/schemas/predefined_profile" }] } } } + ] + }, + "prefetch_preload": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { + "description": "ID of the zone setting.", + "enum": ["prefetch_preload"], + "example": "prefetch_preload" + }, + "value": { "$ref": "#/components/schemas/prefetch_preload_value" } + } + } + ], + "default": "off", + "description": "Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones.", + "title": "Prefetch preload" + }, + "prefetch_preload_value": { + "default": "off", + "description": "Value of the zone setting.", + "enum": ["on", "off"], + "type": "string" + }, + "prefix": { + "description": "IP Prefix in Classless Inter-Domain Routing format.", + "example": "192.0.2.0/24", + "type": "string" + }, + "preview": { + "description": "The video's preview page URI. This field is omitted until encoding is complete.", + "example": "https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/watch", + "format": "uri", + "readOnly": true, + "type": "string" + }, + "preview_id": { "example": "f1aba936b94213e5b8dca0c0dbf1f9cc" }, + "preview_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { "preview_url": { "$ref": "#/components/schemas/preview_url" } }, + "type": "object" + } + } + } + ] + }, + "preview_response-Cnz4PS5L": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "pools": { + "additionalProperties": true, + "example": { + "abwlnp5jbqn45ecgxd03erbgtxtqai0d": "WNAM Datacenter", + "ve8h9lrcip5n5bbga9yqmdws28ay5d0l": "EEU Datacenter" + }, + "type": "object", + "x-patternProperties": { "^[a-z0-9]{32}$": { "type": "string" } } + }, + "preview_id": { "$ref": "#/components/schemas/monitor_components-schemas-identifier" } + }, + "type": "object" + } + } + } + ] + }, + "preview_response-ZWQ9Fl0k": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "pools": { + "additionalProperties": { + "description": "The pool name associated with the pool ID.", + "type": "string" + }, + "description": "Monitored pool IDs mapped to their respective names.", + "example": { + "abwlnp5jbqn45ecgxd03erbgtxtqai0d": "WNAM Datacenter", + "ve8h9lrcip5n5bbga9yqmdws28ay5d0l": "EEU Datacenter" + }, + "type": "object" + }, + "preview_id": { "$ref": "#/components/schemas/identifier-FZThz4k7" } + }, + "type": "object" + } + } + } + ] + }, + "preview_result": { + "additionalProperties": true, + "description": "Resulting health data from a preview operation.", + "example": { + "abwlnp5jbqn45ecgxd03erbgtxtqai0d": { + "healthy": true, + "origins": [{ "originone.example.com.": { "$ref": "#/components/schemas/origin_health_data/example" } }] + } + }, + "type": "object" + }, + "preview_result-FY42S4cy": { + "additionalProperties": { + "properties": { + "healthy": { "type": "boolean" }, + "origins": { + "items": { + "additionalProperties": { "$ref": "#/components/schemas/origin_health_data" }, + "maxProperties": 1, + "minProperties": 1, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "description": "Resulting health data from a preview operation.", + "example": { + "abwlnp5jbqn45ecgxd03erbgtxtqai0d": { + "healthy": true, + "origins": [ + { + "originone.example.com.": { + "failure_reason": "No failures", + "healthy": true, + "response_code": 200, + "rtt": "66ms" + } + } + ] + } + }, + "type": "object" + }, + "preview_result_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "$ref": "#/components/schemas/preview_result" } + ] + }, + "preview_result_response-181bkyJU": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/preview_result-FY42S4cy" } } } + ] + }, + "preview_url": { + "description": "URL where the custom waiting room page can temporarily be previewed.", + "example": "http://waitingrooms.dev/preview/35af8c12-6d68-4608-babb-b53435a5ddfb", + "type": "string" + }, + "price": { + "description": "The price of the subscription that will be billed, in US dollars.", + "example": 20, + "readOnly": true, + "type": "number" + }, + "priority": { "description": "Priority of the static route.", "type": "integer" }, + "priority-21tFu5p5": { + "default": 1, + "description": "The priority of the rule, used to define which Page Rule is processed over another. A higher number indicates a higher priority. For example, if you have a catch-all Page Rule (rule A: `/images/*`) but want a more specific Page Rule to take precedence (rule B: `/images/special/*`), specify a higher priority for rule B so it overrides rule A.", + "type": "integer" + }, + "priority-Cl6RAKfI": { + "default": 20, + "description": "The order/priority in which the certificate will be used in a request. The higher priority will break ties across overlapping 'legacy_custom' certificates, but 'legacy_custom' certificates will always supercede 'sni_custom' certificates.", + "example": 1, + "type": "number" + }, + "priority-eLZLlpCp": { + "default": 20, + "description": "The order/priority in which the certificate will be used in a request. The higher priority will break ties across overlapping 'legacy_custom' certificates, but 'legacy_custom' certificates will always supercede 'sni_custom' certificates.", + "example": 1, + "type": "number" + }, + "priority-hJRwn9f1": { + "description": "Required for MX, SRV and URI records; unused by other record types. Records with lower priorities are preferred.", + "example": 10, + "maximum": 65535, + "minimum": 0, + "type": "number" + }, + "privacy": { + "description": "Privacy option controls redacting WHOIS information.", + "example": true, + "type": "boolean" + }, + "privacy_pass": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { "description": "ID of the zone setting.", "enum": ["privacy_pass"], "example": "privacy_pass" }, + "value": { "$ref": "#/components/schemas/privacy_pass_value" } + } + } + ], + "description": "Privacy Pass is a browser extension developed by the Privacy Pass Team to improve the browsing experience for your visitors. Enabling Privacy Pass will reduce the number of CAPTCHAs shown to your visitors. (https://support.cloudflare.com/hc/en-us/articles/115001992652-Privacy-Pass).", + "title": "Privacy Pass" + }, + "privacy_pass_value": { + "default": "on", + "description": "Value of the zone setting.", + "enum": ["on", "off"], + "type": "string" + }, + "private_key": { + "description": "The zone's private key.", + "example": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n", + "type": "string" + }, + "probe_zone": { + "description": "Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors.", + "example": "example.com", + "type": "string" + }, + "products": { + "items": { + "description": "A list of products to bypass for a request when using the `bypass` action.", + "enum": ["zoneLockdown", "uaBlock", "bic", "hot", "securityLevel", "rateLimit", "waf"], + "example": "waf", + "type": "string" + }, + "type": "array" + }, + "profile_id": { + "allOf": [{ "$ref": "#/components/schemas/uuid-lbOWhPVX" }], + "description": "The ID for this profile", + "example": "384e129d-25bd-403c-8019-bc19eb7a8a5f" + }, + "profile_id-JwqwymCp": { + "allOf": [{ "$ref": "#/components/schemas/uuid-s0SXln0q" }], + "description": "The ID for this profile", + "example": "384e129d-25bd-403c-8019-bc19eb7a8a5f" + }, + "profiles": { + "anyOf": [ + { "$ref": "#/components/schemas/predefined_profile" }, + { "$ref": "#/components/schemas/custom_profile" }, + { "$ref": "#/components/schemas/integration_profile" } + ] + }, + "profiles-JBe4cw2h": { + "anyOf": [ + { "$ref": "#/components/schemas/predefined_profile" }, + { "$ref": "#/components/schemas/custom_profile" } + ] + }, + "profiles_components-schemas-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/profiles-JBe4cw2h" }, "type": "array" } + } + } + ] + }, + "project-patch": { + "example": { + "deployment_configs": { + "production": { + "compatibility_date": "2022-01-01", + "compatibility_flags": ["url_standard"], + "env_vars": { + "BUILD_VERSION": { "value": "3.3" }, + "delete_this_env_var": null, + "secret_var": { "type": "secret_text", "value": "A_CMS_API_TOKEN" } + } + } + } + } + }, + "project-response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { "properties": { "result": { "$ref": "#/components/schemas/projects" } } } + ] + }, + "project_name": { + "description": "Name of the project.", + "example": "this-is-my-project-01", + "pattern": "^[a-z0-9][a-z0-9-]*$", + "type": "string" + }, + "projects": { + "properties": { + "build_config": { "$ref": "#/components/schemas/build_config" }, + "canonical_deployment": { + "description": "Most recent deployment to the repo.", + "oneOf": [{ "nullable": true }, { "$ref": "#/components/schemas/deployments" }], + "readOnly": true + }, + "created_on": { + "description": "When the project was created.", + "example": "2017-01-01T00:00:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "deployment_configs": { "$ref": "#/components/schemas/deployment_configs" }, + "domains": { + "description": "A list of associated custom domains for the project.", + "example": ["customdomain.com", "customdomain.org"], + "items": {}, + "readOnly": true, + "type": "array" + }, + "id": { + "description": "Id of the project.", + "example": "7b162ea7-7367-4d67-bcde-1160995d5", + "readOnly": true, + "type": "string" + }, + "latest_deployment": { + "description": "Most recent deployment to the repo.", + "oneOf": [{ "nullable": true }, { "$ref": "#/components/schemas/deployments" }], + "readOnly": true + }, + "name": { "description": "Name of the project.", "example": "NextJS Blog", "type": "string" }, + "production_branch": { + "description": "Production branch of the project. Used to identify production deployments.", + "example": "main", + "type": "string" + }, + "source": { "readOnly": true }, + "subdomain": { + "description": "The Cloudflare subdomain associated with the project.", + "example": "helloworld.pages.dev", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "projects-response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { + "properties": { + "result_info": { + "properties": { + "count": { "example": 1 }, + "page": { "example": 1 }, + "per_page": { "example": 100 }, + "total_count": { "example": 1 } + }, + "type": "object" + } + } + }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/deployments" }, "type": "array" } } } + ] + }, + "properties": { + "description": "Requests information about certain properties.", + "example": ["auth_id_characteristics"], + "items": { "enum": ["auth_id_characteristics"], "example": "auth_id_characteristics", "type": "string" }, + "type": "array", + "uniqueItems": true + }, + "properties-name": { + "description": "Account name", + "example": "Demo Account", + "maxLength": 100, + "type": "string" + }, + "protocol": { + "description": "The port configuration at Cloudflare’s edge. May specify a single port, for example `\"tcp/1000\"`, or a range of ports, for example `\"tcp/1000-2000\"`.", + "example": "tcp/22", + "type": "string" + }, + "provider_name": { + "description": "The name of provider. Usually cloudflare.", + "example": "Cloudflare", + "type": "string" + }, + "proxied": { + "description": "Whether the record is receiving the performance and security benefits of Cloudflare.", + "example": false, + "type": "boolean" + }, + "proxied-ZGed5Tdg": { + "default": false, + "description": "Whether the hostname should be gray clouded (false) or orange clouded (true).", + "example": true, + "type": "boolean" + }, + "proxied-ZJJb2RTk": { + "default": false, + "description": "Whether the hostname should be gray clouded (false) or orange clouded (true).", + "example": true, + "type": "boolean" + }, + "proxy-endpoints": { + "properties": { + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "id": { "$ref": "#/components/schemas/schemas-uuid" }, + "ips": { "$ref": "#/components/schemas/ips" }, + "name": { "$ref": "#/components/schemas/proxy-endpoints_components-schemas-name" }, + "subdomain": { "$ref": "#/components/schemas/schemas-subdomain" }, + "updated_at": { "$ref": "#/components/schemas/timestamp" } + }, + "type": "object" + }, + "proxy-endpoints_components-schemas-name": { + "description": "The name of the Proxy Endpoint.", + "example": "Devops team", + "type": "string" + }, + "proxy-endpoints_components-schemas-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { "result": { "items": { "$ref": "#/components/schemas/proxy-endpoints" }, "type": "array" } } + } + ] + }, + "proxy-endpoints_components-schemas-single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/proxy-endpoints" } } } + ] + }, + "proxy_protocol": { + "default": "off", + "description": "Enables Proxy Protocol to the origin. Refer to [Enable Proxy protocol](https://developers.cloudflare.com/spectrum/getting-started/proxy-protocol/) for implementation details on PROXY Protocol V1, PROXY Protocol V2, and Simple Proxy Protocol.", + "enum": ["off", "v1", "v2", "simple"], + "example": "off", + "type": "string" + }, + "proxy_read_timeout": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { + "description": "ID of the zone setting.", + "enum": ["proxy_read_timeout"], + "example": "proxy_read_timeout" + }, + "value": { "$ref": "#/components/schemas/proxy_read_timeout_value" } + } + } + ], + "description": "Maximum time between two read operations from origin.", + "title": "Proxy Read Timeout" + }, + "proxy_read_timeout_value": { + "default": 100, + "description": "Value of the zone setting.\nNotes: Value must be between 1 and 6000", + "type": "number" + }, + "pseudo_ipv4": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { + "default": "pseudo_ipv4", + "description": "Value of the Pseudo IPv4 setting.", + "enum": ["pseudo_ipv4"] + }, + "value": { "$ref": "#/components/schemas/pseudo_ipv4_value" } + } + } + ], + "description": "The value set for the Pseudo IPv4 setting.", + "title": "Pseudo IPv4 Value" + }, + "pseudo_ipv4_value": { + "default": "off", + "description": "Value of the Pseudo IPv4 setting.", + "enum": ["off", "add_header", "overwrite_header"], + "type": "string" + }, + "psk": { + "description": "A randomly generated or provided string for use in the IPsec tunnel.", + "example": "O3bwKSjnaoCxDoUxjcq4Rk8ZKkezQUiy", + "type": "string" + }, + "psk_generation_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "ipsec_tunnel_id": { "$ref": "#/components/schemas/identifier-5dNKLCP5" }, + "psk": { "$ref": "#/components/schemas/psk" }, + "psk_metadata": { "$ref": "#/components/schemas/psk_metadata" } + } + } + } + } + ] + }, + "psk_metadata": { + "description": "The PSK metadata that includes when the PSK was generated.", + "properties": { "last_generated_on": { "$ref": "#/components/schemas/schemas-modified_on" } }, + "type": "object" + }, + "public_key": { + "description": "Public key for DS record.", + "example": "oXiGYrSTO+LSCJ3mohc8EP+CzF9KxBj8/ydXJ22pKuZP3VAC3/Md/k7xZfz470CoRyZJ6gV6vml07IC3d8xqhA==", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "public_key-Qrh0Mu1M": { + "description": "The public key to add to your SSH server configuration.", + "example": "ecdsa-sha2-nistp256 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= open-ssh-ca@cloudflareaccess.org", + "readOnly": true, + "type": "string" + }, + "public_key-xgmH3SVX": { + "description": "The public key to add to your SSH server configuration.", + "example": "ecdsa-sha2-nistp256 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= open-ssh-ca@cloudflareaccess.org", + "readOnly": true, + "type": "string" + }, + "purpose_justification_prompt": { + "description": "A custom message that will appear on the purpose justification screen.", + "example": "Please enter a justification for entering this protected domain.", + "type": "string" + }, + "purpose_justification_required": { + "default": false, + "description": "Require users to enter a justification when they log in to the application.", + "example": true, + "type": "boolean" + }, + "query": { + "properties": { + "dimensions": { + "description": "Array of dimension names.", + "example": ["responseCode", "queryName"], + "items": { "description": "Dimension name.", "example": "responseCode", "type": "string" }, + "type": "array" + }, + "filters": { "$ref": "#/components/schemas/filters-6K6BiPDe" }, + "limit": { "$ref": "#/components/schemas/limit" }, + "metrics": { + "description": "Array of metric names.", + "example": ["queryCount", "responseTimeAvg"], + "items": { "description": "Metric name.", "example": "queries", "type": "string" }, + "type": "array" + }, + "since": { "$ref": "#/components/schemas/since" }, + "sort": { + "description": "Array of dimensions to sort by, where each dimension may be prefixed by - (descending) or + (ascending).", + "example": ["+responseCode", "-queryName"], + "items": { + "description": "Dimension name (may be prefixed by - (descending) or + (ascending).", + "example": "+responseCode", + "type": "string" + }, + "type": "array" + }, + "until": { "$ref": "#/components/schemas/until" } + }, + "required": ["dimensions", "metrics", "since", "until", "limit"], + "type": "object" + }, + "query-ju6G02HL": { + "description": "For specifying result metrics.", + "properties": { + "dimensions": { + "default": "[]", + "description": "Can be used to break down the data by given attributes.", + "items": { "description": "For drilling down on metrics.", "type": "string" }, + "type": "array" + }, + "filters": { + "default": "\"\"", + "description": "Used to filter rows by one or more dimensions. Filters can be combined using OR and AND boolean logic. AND takes precedence over OR in all the expressions. The OR operator is defined using a comma (,) or OR keyword surrounded by whitespace. The AND operator is defined using a semicolon (;) or AND keyword surrounded by whitespace. Note that the semicolon is a reserved character in URLs (rfc1738) and needs to be percent-encoded as %3B. Comparison options are: \n\nOperator | Name | URL Encoded\n--------------------------|---------------------------------|--------------------------\n== | Equals | %3D%3D\n!= | Does not equals | !%3D\n\u003e | Greater Than | %3E\n\u003c | Less Than | %3C\n\u003e= | Greater than or equal to | %3E%3D\n\u003c= | Less than or equal to | %3C%3D .", + "type": "string" + }, + "limit": { "default": 10000, "description": "Limit number of returned metrics.", "type": "integer" }, + "metrics": { + "description": "One or more metrics to compute.", + "items": { "description": "A quantitative measurement of KV usage.", "type": "string" }, + "type": "array" + }, + "since": { + "default": "\u003c6 hours ago\u003e", + "description": "Start of time interval to query, defaults to 6 hours before request received.", + "example": "2019-01-02T02:20:00Z", + "format": "date-time", + "type": "string" + }, + "sort": { + "default": "[]", + "description": "Array of dimensions or metrics to sort by, each dimension/metric may be prefixed by - (descending) or + (ascending).", + "items": {}, + "type": "array" + }, + "until": { + "default": "\u003cnow\u003e", + "description": "End of time interval to query, defaults to current time.", + "example": "2019-01-02T03:20:00Z", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "query_event": { + "properties": { + "custom_page_html": { "$ref": "#/components/schemas/event_custom_page_html" }, + "description": { "$ref": "#/components/schemas/event_description" }, + "disable_session_renewal": { "$ref": "#/components/schemas/event_disable_session_renewal" }, + "event_end_time": { "$ref": "#/components/schemas/event_end_time" }, + "event_start_time": { "$ref": "#/components/schemas/event_start_time" }, + "name": { "$ref": "#/components/schemas/event_name" }, + "new_users_per_minute": { "$ref": "#/components/schemas/event_new_users_per_minute" }, + "prequeue_start_time": { "$ref": "#/components/schemas/event_prequeue_start_time" }, + "queueing_method": { "$ref": "#/components/schemas/event_queueing_method" }, + "session_duration": { "$ref": "#/components/schemas/event_session_duration" }, + "shuffle_at_event_start": { "$ref": "#/components/schemas/event_shuffle_at_event_start" }, + "suspended": { "$ref": "#/components/schemas/event_suspended" }, + "total_active_users": { "$ref": "#/components/schemas/event_total_active_users" } + }, + "required": ["name", "event_start_time", "event_end_time"], + "type": "object" + }, + "query_healthcheck": { + "properties": { + "address": { "$ref": "#/components/schemas/address" }, + "check_regions": { "$ref": "#/components/schemas/check_regions" }, + "consecutive_fails": { "$ref": "#/components/schemas/consecutive_fails" }, + "consecutive_successes": { "$ref": "#/components/schemas/consecutive_successes" }, + "description": { "$ref": "#/components/schemas/description-hRvlp2wh" }, + "http_config": { "$ref": "#/components/schemas/http_config" }, + "interval": { "$ref": "#/components/schemas/interval" }, + "name": { "$ref": "#/components/schemas/name-51RmM5yT" }, + "retries": { "$ref": "#/components/schemas/retries" }, + "suspended": { "$ref": "#/components/schemas/suspended" }, + "tcp_config": { "$ref": "#/components/schemas/tcp_config" }, + "timeout": { "$ref": "#/components/schemas/timeout" }, + "type": { "$ref": "#/components/schemas/type-Eu3SX4l3" } + }, + "required": ["name", "address"], + "type": "object" + }, + "query_preview": { + "properties": { "custom_html": { "$ref": "#/components/schemas/custom_page_html" } }, + "required": ["custom_html"], + "type": "object" + }, + "query_response": { + "description": "The exact parameters/timestamps the analytics service used to return data.", + "properties": { + "since": { "$ref": "#/components/schemas/since-cRELaVYs" }, + "time_delta": { + "description": "The amount of time (in minutes) that each data point in the timeseries represents. The granularity of the time-series returned (e.g. each bucket in the time series representing 1-minute vs 1-day) is calculated by the API based on the time-range provided to the API.", + "type": "integer" + }, + "until": { "$ref": "#/components/schemas/until-HpHDrENT" } + }, + "readOnly": true, + "type": "object" + }, + "query_waitingroom": { + "properties": { + "cookie_attributes": { "$ref": "#/components/schemas/cookie_attributes" }, + "custom_page_html": { "$ref": "#/components/schemas/custom_page_html" }, + "default_template_language": { "$ref": "#/components/schemas/default_template_language" }, + "description": { "$ref": "#/components/schemas/description-DIf6mz41" }, + "disable_session_renewal": { "$ref": "#/components/schemas/disable_session_renewal" }, + "host": { "$ref": "#/components/schemas/host" }, + "json_response_enabled": { "$ref": "#/components/schemas/json_response_enabled" }, + "name": { "$ref": "#/components/schemas/name-jYNmruXY" }, + "new_users_per_minute": { "$ref": "#/components/schemas/new_users_per_minute" }, + "path": { "$ref": "#/components/schemas/path" }, + "queue_all": { "$ref": "#/components/schemas/queue_all" }, + "queueing_method": { "$ref": "#/components/schemas/queueing_method" }, + "session_duration": { "$ref": "#/components/schemas/session_duration" }, + "suspended": { "$ref": "#/components/schemas/suspended-qdpN2ZN2" }, + "total_active_users": { "$ref": "#/components/schemas/total_active_users" } + }, + "required": ["name", "host", "new_users_per_minute", "total_active_users"], + "type": "object" + }, + "queue": { + "properties": { + "consumers": { "readOnly": true }, + "consumers_total_count": { "readOnly": true }, + "created_on": { "readOnly": true }, + "modified_on": { "readOnly": true }, + "producers": { "readOnly": true }, + "producers_total_count": { "readOnly": true }, + "queue_id": { "readOnly": true }, + "queue_name": { "$ref": "#/components/schemas/queues_components-schemas-name" } + }, + "type": "object" + }, + "queue_all": { + "default": false, + "description": "If queue_all is `true`, all the traffic that is coming to a route will be sent to the waiting room. No new traffic can get to the route once this field is set and estimated time will become unavailable.", + "example": true, + "type": "boolean" + }, + "queue_created": { + "properties": { + "created_on": { "readOnly": true }, + "modified_on": { "readOnly": true }, + "queue_id": { "readOnly": true }, + "queue_name": { "$ref": "#/components/schemas/queues_components-schemas-name" } + }, + "type": "object" + }, + "queue_updated": { + "properties": { + "created_on": { "readOnly": true }, + "modified_on": { "readOnly": true }, + "queue_id": { "readOnly": true }, + "queue_name": { "$ref": "#/components/schemas/renamed_name" } + }, + "type": "object" + }, + "queueing_method": { + "default": "fifo", + "description": "Sets the queueing method used by the waiting room. Changing this parameter from the **default** queueing method is only available for the Waiting Room Advanced subscription. Regardless of the queueing method, if `queue_all` is enabled or an event is prequeueing, users in the waiting room will not be accepted to the origin. These users will always see a waiting room page that refreshes automatically. The valid queueing methods are:\n1. `fifo` **(default)**: First-In-First-Out queue where customers gain access in the order they arrived.\n2. `random`: Random queue where customers gain access randomly, regardless of arrival time.\n3. `passthrough`: Users will pass directly through the waiting room and into the origin website. As a result, any configured limits will not be respected while this is enabled. This method can be used as an alternative to disabling a waiting room (with `suspended`) so that analytics are still reported. This can be used if you wish to allow all traffic normally, but want to restrict traffic during a waiting room event, or vice versa.\n4. `reject`: Users will be immediately rejected from the waiting room. As a result, no users will reach the origin website while this is enabled. This can be used if you wish to reject all traffic while performing maintenance, block traffic during a specified period of time (an event), or block traffic while events are not occurring. Consider a waiting room used for vaccine distribution that only allows traffic during sign-up events, and otherwise blocks all traffic. For this case, the waiting room uses `reject`, and its events override this with `fifo`, `random`, or `passthrough`. When this queueing method is enabled and neither `queueAll` is enabled nor an event is prequeueing, the waiting room page **will not refresh automatically**.", + "enum": ["fifo", "random", "passthrough", "reject"], + "example": "fifo", + "type": "string" + }, + "queues_components-schemas-name": { "example": "example-queue", "type": "string" }, + "quota": { + "properties": { + "allocated": { "description": "Quantity Allocated.", "type": "integer" }, + "used": { "description": "Quantity Used.", "type": "integer" } + }, + "type": "object" + }, + "r2-single-bucket-operation-response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { "properties": { "result": { "type": "object" } } } + ] + }, + "railgun": { + "properties": { + "activated_on": { "$ref": "#/components/schemas/activated_on" }, + "activation_key": { "$ref": "#/components/schemas/activation_key" }, + "build": { "$ref": "#/components/schemas/build" }, + "created_on": { "$ref": "#/components/schemas/components-schemas-created_on" }, + "enabled": { "$ref": "#/components/schemas/railgun_components-schemas-enabled" }, + "id": { "$ref": "#/components/schemas/railgun_components-schemas-identifier" }, + "modified_on": { "$ref": "#/components/schemas/railgun_components-schemas-modified_on" }, + "name": { "$ref": "#/components/schemas/railgun_components-schemas-name" }, + "revision": { "$ref": "#/components/schemas/revision" }, + "status": { "$ref": "#/components/schemas/railgun_components-schemas-status" }, + "upgrade_info": { "$ref": "#/components/schemas/upgrade_info" }, + "version": { "$ref": "#/components/schemas/components-schemas-version" }, + "zones_connected": { "$ref": "#/components/schemas/zones_connected" } + }, + "required": [ + "id", + "name", + "status", + "enabled", + "zones_connected", + "build", + "version", + "revision", + "activation_key", + "activated_on", + "created_on", + "modified_on" + ], + "type": "object" + }, + "railgun_components-schemas-enabled": { + "default": false, + "description": "Flag to determine if the Railgun is accepting connections.", + "example": true, + "type": "boolean" + }, + "railgun_components-schemas-identifier": { + "description": "Railgun identifier tag.", + "example": "e928d310693a83094309acf9ead50448", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "railgun_components-schemas-identifier-2": { + "description": "Railgun connection identifier tag.", + "example": "e928d310693a83094309acf9ead50448", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "railgun_components-schemas-modified_on": { + "description": "When the Railgun was last modified.", + "example": "2014-01-01T05:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "railgun_components-schemas-name": { + "description": "Readable identifier of the Railgun.", + "example": "My Railgun.", + "maxLength": 160, + "type": "string" + }, + "railgun_components-schemas-status": { + "description": "Status of the Railgun.", + "enum": ["initializing", "active"], + "example": "active", + "readOnly": true, + "type": "string" + }, + "railgun_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/railgun" }, "type": "array" } } } + ] + }, + "railgun_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } } } + ] + }, + "railgun_response_single_id": { + "allOf": [ + { "$ref": "#/components/schemas/railgun_response_single" }, + { + "properties": { + "result": { + "properties": { "id": { "$ref": "#/components/schemas/railgun_components-schemas-identifier" } } + } + } + } + ] + }, + "random_steering": { + "description": "Configures pool weights for random steering. When steering_policy is 'random', a random pool is selected with probability proportional to these pool weights.", + "properties": { + "default_weight": { + "default": 1, + "description": "The default weight for pools in the load balancer that are not specified in the pool_weights map.", + "example": 0.2, + "maximum": 1, + "minimum": 0, + "multipleOf": 0.1, + "type": "number" + }, + "pool_weights": { + "description": "A mapping of pool IDs to custom weights. The weight is relative to other pools in the load balancer.", + "example": { "9290f38c5d07c2e2f4df57b1f61d4196": 0.5, "de90f38ced07c2e2f4df50b1f61d4194": 0.3 }, + "type": "object" + } + }, + "type": "object" + }, + "rate-limits": { "allOf": [{ "$ref": "#/components/schemas/ratelimit-OTTUtFnH" }], "type": "object" }, + "rate-limits_components-schemas-id": { + "description": "The unique identifier of the rate limit.", + "example": "372e67954025e0ba6aaa6d586b9e0b59", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "rate-plan": { + "properties": { + "components": { "$ref": "#/components/schemas/schemas-component_values" }, + "currency": { "$ref": "#/components/schemas/currency" }, + "duration": { "$ref": "#/components/schemas/duration" }, + "frequency": { "$ref": "#/components/schemas/schemas-frequency" }, + "id": { "$ref": "#/components/schemas/rate-plan_components-schemas-identifier" }, + "name": { "$ref": "#/components/schemas/rate-plan_components-schemas-name" } + }, + "type": "object" + }, + "rate-plan_components-schemas-identifier": { + "description": "Plan identifier tag.", + "example": "free", + "readOnly": true, + "type": "string" + }, + "rate-plan_components-schemas-name": { + "description": "The plan name.", + "example": "Free Plan", + "maxLength": 80, + "readOnly": true, + "type": "string" + }, + "rate_plan": { + "description": "The rate plan applied to the subscription.", + "properties": { + "currency": { + "description": "The currency applied to the rate plan subscription.", + "example": "USD", + "type": "string" + }, + "externally_managed": { + "description": "Whether this rate plan is managed externally from Cloudflare.", + "example": false, + "type": "boolean" + }, + "id": { "description": "The ID of the rate plan.", "example": "free" }, + "is_contract": { + "description": "Whether a rate plan is enterprise-based (or newly adopted term contract).", + "example": false, + "type": "boolean" + }, + "public_name": { + "description": "The full name of the rate plan.", + "example": "Business Plan", + "type": "string" + }, + "scope": { "description": "The scope that this rate plan applies to.", "example": "zone", "type": "string" }, + "sets": { + "description": "The list of sets this rate plan applies to.", + "items": { "type": "string" }, + "type": "array" + } + }, + "type": "object" + }, + "ratelimit": { + "description": "Ratelimit in queries per second per datacenter (applies to DNS queries sent to the origin nameservers configured on the cluster).", + "example": 600, + "maximum": 1000000000, + "minimum": 100, + "nullable": true, + "type": "number" + }, + "ratelimit-OTTUtFnH": { + "properties": { + "action": { "$ref": "#/components/schemas/schemas-action" }, + "bypass": { "$ref": "#/components/schemas/bypass" }, + "description": { "$ref": "#/components/schemas/components-schemas-description-Po1ZMHYz" }, + "disabled": { "$ref": "#/components/schemas/disabled" }, + "id": { "$ref": "#/components/schemas/rate-limits_components-schemas-id" }, + "match": { "$ref": "#/components/schemas/match" }, + "period": { "$ref": "#/components/schemas/period" }, + "threshold": { "$ref": "#/components/schemas/threshold" } + } + }, + "ratelimit_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { "result": { "items": { "$ref": "#/components/schemas/rate-limits" }, "type": "array" } }, + "type": "object" + } + ] + }, + "ratelimit_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } }, "type": "object" } + ] + }, + "ray_id": { + "description": "The unique identifier for the request to Cloudflare.", + "example": "187d944c61940c77", + "maxLength": 16, + "type": "string" + }, + "ray_identifier": { + "description": "Ray identifier.", + "example": "41ddf1740f67442d", + "maxLength": 16, + "readOnly": true, + "type": "string" + }, + "ready": { + "description": "Beta flag. Users can create a policy with a mechanism that is not ready, but we cannot guarantee successful delivery of notifications.", + "example": true, + "type": "boolean" + }, + "readyToStream": { + "description": "Indicates whether the video is ready for viewing.", + "example": true, + "readOnly": true, + "type": "boolean" + }, + "ref": { + "description": "A short reference tag. Allows you to select related firewall rules.", + "example": "MIR-31", + "maxLength": 50, + "type": "string" + }, + "references_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "description": "List of resources that reference a given monitor.", + "example": [ + { + "reference_type": "referrer", + "resource_id": "17b5962d775c646f3f9725cbc7a53df4", + "resource_name": "primary-dc-1", + "resource_type": "pool" + } + ], + "items": { + "properties": { + "reference_type": { "enum": ["*", "referral", "referrer"], "type": "string" }, + "resource_id": { "type": "string" }, + "resource_name": { "type": "string" }, + "resource_type": { "type": "string" } + }, + "type": "object" + }, + "type": "array" + } + } + } + ] + }, + "region_code": { + "description": "A list of Cloudflare regions. WNAM: Western North America, ENAM: Eastern North America, WEU: Western Europe, EEU: Eastern Europe, NSAM: Northern South America, SSAM: Southern South America, OC: Oceania, ME: Middle East, NAF: North Africa, SAF: South Africa, SAS: Southern Asia, SEAS: South East Asia, NEAS: North East Asia).", + "enum": ["WNAM", "ENAM", "WEU", "EEU", "NSAM", "SSAM", "OC", "ME", "NAF", "SAF", "SAS", "SEAS", "NEAS"], + "example": "WNAM", + "type": "string" + }, + "region_components-schemas-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } } } + ] + }, + "region_components-schemas-single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "description": "A list of countries and subdivisions mapped to a region.", + "example": { + "iso_standard": "Country and subdivision codes follow ISO 3166-1 alpha-2 and ISO 3166-2", + "regions": [ + { + "countries": [ + { + "country_code_a2": "CA", + "country_name": "Canada", + "country_subdivisions": [ + { "subdivision_code_a2": "AB", "subdivision_name": "Alberta" }, + { "subdivision_code_a2": "BC", "subdivision_name": "British Columbia" } + ] + }, + { "country_code_a2": "HT", "country_name": "Haiti" }, + { "country_code_a2": "MX", "country_name": "Mexico" }, + { + "country_code_a2": "US", + "country_name": "United States", + "country_subdivisions": [ + { "subdivision_code_a2": "AZ", "subdivision_name": "Arizona" }, + { "subdivision_code_a2": "CA", "subdivision_name": "California" }, + { "subdivision_code_a2": "CO", "subdivision_name": "Colorado" }, + { "subdivision_code_a2": "HI", "subdivision_name": "Hawaii" }, + { "subdivision_code_a2": "MN", "subdivision_name": "Minnesota" }, + { "subdivision_code_a2": "MO", "subdivision_name": "Missouri" }, + { "subdivision_code_a2": "NV", "subdivision_name": "Nevada" }, + { "subdivision_code_a2": "OR", "subdivision_name": "Oregon" }, + { "subdivision_code_a2": "TX", "subdivision_name": "Texas" }, + { "subdivision_code_a2": "UT", "subdivision_name": "Utah" }, + { "subdivision_code_a2": "WA", "subdivision_name": "Washington" } + ] + } + ], + "region_code": "WNAM" + } + ] + }, + "type": "object" + } + } + } + ] + }, + "region_pools": { + "description": "A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.", + "example": { + "ENAM": ["00920f38ce07c2e2f4df50b1f61d4194"], + "WNAM": ["de90f38ced07c2e2f4df50b1f61d4194", "9290f38c5d07c2e2f4df57b1f61d4196"] + }, + "type": "object" + }, + "regions": { + "description": "Comma-separated list of regions.", + "example": "eu", + "maxLength": 256, + "pattern": "^[a-z,]*$", + "type": "string" + }, + "registrant_contact": { + "allOf": [{ "$ref": "#/components/schemas/contacts" }], + "description": "Shows contact information for domain registrant." + }, + "registry_statuses": { + "description": "A comma-separated list of registry status codes. A full list of status codes can be found at [EPP Status Codes](https://www.icann.org/resources/pages/epp-status-codes-2014-06-16-en).", + "example": "ok,serverTransferProhibited", + "type": "string" + }, + "remote_config": { + "description": "If `true`, the tunnel can be configured remotely from the Zero Trust dashboard. If `false`, the tunnel must be configured locally on the origin machine.", + "example": true, + "type": "boolean" + }, + "renamed_name": { "example": "renamed-example-queue", "type": "string" }, + "report": { + "allOf": [ + { "$ref": "#/components/schemas/result" }, + { + "properties": { + "data": { + "items": { + "properties": { + "metrics": { + "description": "Array with one item per requested metric. Each item is a single value.", + "items": { "description": "Nominal metric value.", "type": "number" }, + "type": "array" + } + }, + "required": ["metrics"] + } + } + }, + "required": ["data"] + } + ] + }, + "report_bytime": { + "allOf": [ + { "$ref": "#/components/schemas/result" }, + { + "properties": { + "data": { + "items": { + "properties": { + "metrics": { + "description": "Array with one item per requested metric. Each item is an array of values, broken down by time interval.", + "items": { + "description": "Nominal metric values, broken down by time interval.", + "properties": { "items": { "description": "Nominal metric value.", "type": "number" } }, + "type": "array" + }, + "type": "array" + } + }, + "required": ["metrics"] + } + }, + "query": { + "properties": { "time_delta": { "$ref": "#/components/schemas/time_delta" } }, + "required": ["time_delta"], + "type": "object" + }, + "time_intervals": { + "description": "Array of time intervals in the response data. Each interval is represented as an array containing two values: the start time, and the end time.\n", + "items": { + "description": "Array with exactly two items, representing the start and end time (respectively) of this time interval.", + "items": { + "description": "Time value.", + "example": "2023-11-11T12:00:00Z", + "format": "date-time", + "type": "string" + }, + "type": "array" + }, + "type": "array" + } + }, + "required": ["time_intervals", "query", "data"] + } + ] + }, + "request-tracer": { "type": "object" }, + "request.ip": { + "description": "Client IP restrictions.", + "example": { + "in": ["123.123.123.0/24", "2606:4700::/32"], + "not_in": ["123.123.123.100/24", "2606:4700:4700::/48"] + }, + "properties": { + "in": { "$ref": "#/components/schemas/cidr_list" }, + "not_in": { "$ref": "#/components/schemas/cidr_list" } + }, + "type": "object" + }, + "request_list": { "items": { "$ref": "#/components/schemas/request_model" }, "type": "array" }, + "request_model": { + "properties": { + "enabled": { "$ref": "#/components/schemas/managed_headers_components-schemas-enabled" }, + "id": { "$ref": "#/components/schemas/managed_headers_components-schemas-id" } + }, + "type": "object" + }, + "request_type": { + "description": "Signature type desired on certificate (\"origin-rsa\" (rsa), \"origin-ecc\" (ecdsa), or \"keyless-certificate\" (for Keyless SSL servers).", + "enum": ["origin-rsa", "origin-ecc", "keyless-certificate"], + "example": "origin-rsa", + "type": "string" + }, + "requested_validity": { + "default": 5475, + "description": "The number of days for which the certificate should be valid.", + "enum": [7, 30, 90, 365, 730, 1095, 5475], + "example": 5475, + "type": "number" + }, + "requests": { + "description": "The estimated number of requests covered by these calculations.", + "readOnly": true, + "type": "integer" + }, + "requests_by_colo": { + "description": "Breakdown of totals for requests.", + "properties": { + "all": { "description": "Total number of requests served.", "type": "integer" }, + "cached": { "description": "Total number of cached requests served.", "type": "integer" }, + "country": { + "additionalProperties": true, + "description": "Key/value pairs where the key is a two-digit country code and the value is the number of requests served to that country.", + "example": { "AG": 37298, "GI": 293846, "US": 4181364 }, + "type": "object" + }, + "http_status": { + "description": "A variable list of key/value pairs where the key is a HTTP status code and the value is the number of requests with that code served.", + "example": { "200": 13496983, "301": 283, "400": 187936, "402": 1828, "404": 1293 }, + "type": "object" + }, + "uncached": { "description": "Total number of requests served from the origin.", "type": "integer" } + }, + "type": "object" + }, + "require": { + "description": "Rules evaluated with an AND logical operator. To match a policy, a user must meet all of the Require rules.", + "items": { "$ref": "#/components/schemas/rule" }, + "type": "array" + }, + "require-SpDpRST8": { + "description": "Rules evaluated with an AND logical operator. To match a policy, a user must meet all of the Require rules.", + "items": { "$ref": "#/components/schemas/rule_components-schemas-rule" }, + "type": "array" + }, + "requireAll": { "description": "Whether to check all disks for encryption.", "example": true, "type": "boolean" }, + "requireSignedURLs": { + "default": false, + "description": "Indicates whether the image can be a accessed only using it's UID. If set to true, a signed token needs to be generated with a signing key to view the image.", + "example": true, + "type": "boolean" + }, + "requireSignedURLs-9DKWYMwu": { + "default": false, + "description": "Indicates whether the video can be a accessed using the UID. When set to `true`, a signed token must be generated with a signing key to view the video.", + "example": true, + "readOnly": true, + "type": "boolean" + }, + "resolves_to_ref": { + "properties": { + "id": { "$ref": "#/components/schemas/stix_identifier" }, + "value": { "description": "IP address or domain name.", "example": "192.0.2.0", "type": "string" } + }, + "type": "object" + }, + "resolves_to_refs": { + "description": "Specifies a list of references to one or more IP addresses or domain names that the domain name currently resolves to.", + "items": { "$ref": "#/components/schemas/resolves_to_ref" }, + "type": "array" + }, + "resource_reference": { + "description": "A reference to a load balancer resource.", + "properties": { + "reference_type": { + "description": "When listed as a reference, the type (direction) of the reference.", + "enum": ["referral", "referrer"], + "type": "string" + }, + "references": { + "description": "A list of references to (referrer) or from (referral) this resource.", + "example": [ + { + "reference_type": "referrer", + "resource_id": "699d98642c564d2e855e9661899b7252", + "resource_name": "www.example.com", + "resource_type": "load_balancer" + }, + { + "reference_type": "referral", + "resource_id": "f1aba936b94213e5b8dca0c0dbf1f9cc", + "resource_name": "Login page monitor", + "resource_type": "monitor" + } + ], + "items": { "description": "A reference to a load balancer resource.", "type": "object" }, + "type": "array" + }, + "resource_id": { "example": "17b5962d775c646f3f9725cbc7a53df4" }, + "resource_name": { + "description": "The human-identifiable name of the resource.", + "example": "primary-dc-1", + "type": "string" + }, + "resource_type": { + "description": "The type of the resource.", + "enum": ["load_balancer", "monitor", "pool"], + "example": "pool", + "type": "string" + } + }, + "type": "object" + }, + "resources": { + "description": "A list of resource names that the policy applies to.", + "example": { + "com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43": "*", + "com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4": "*" + }, + "type": "object" + }, + "response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { "result": { "items": { "$ref": "#/components/schemas/domain-history" }, "type": "array" } } + } + ] + }, + "response_buffering": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { + "description": "ID of the zone setting.", + "enum": ["response_buffering"], + "example": "response_buffering" + }, + "value": { "$ref": "#/components/schemas/response_buffering_value" } + } + } + ], + "default": "off", + "description": "Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones.", + "title": "Response Buffering" + }, + "response_buffering_value": { + "default": "off", + "description": "Value of the zone setting.", + "enum": ["on", "off"], + "type": "string" + }, + "response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/lists" }, "type": "array" } } } + ] + }, + "response_collection-7voDH8b3": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/tsig" }, "type": "array" } } } + ] + }, + "response_collection-AZRlrYzF": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/waitingroom" }, "type": "array" } } } + ] + }, + "response_collection-Etn1LwEn": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/profiles" }, "type": "array" } } } + ] + }, + "response_collection-IG638TJE": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/monitor-FBAH67XY" }, "type": "array" } + } + } + ] + }, + "response_collection-MecJdTin": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/healthchecks" }, "type": "array" } } } + ] + }, + "response_collection-NcnbjEgN": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "type": "object" }, "type": "array" } }, "type": "object" } + ] + }, + "response_collection-Oi5s0tkV": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/device-posture-rules-gduy4mTZ" }, "type": "array" } + } + } + ] + }, + "response_collection-oP3HzZox": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "items": { + "anyOf": [ + { "$ref": "#/components/schemas/azureAD" }, + { "$ref": "#/components/schemas/centrify" }, + { "$ref": "#/components/schemas/facebook" }, + { "$ref": "#/components/schemas/github" }, + { "$ref": "#/components/schemas/google" }, + { "$ref": "#/components/schemas/google-apps" }, + { "$ref": "#/components/schemas/linkedin" }, + { "$ref": "#/components/schemas/oidc" }, + { "$ref": "#/components/schemas/okta" }, + { "$ref": "#/components/schemas/onelogin" }, + { "$ref": "#/components/schemas/pingone" }, + { "$ref": "#/components/schemas/saml" }, + { "$ref": "#/components/schemas/yandex" } + ] + }, + "type": "array" + } + }, + "type": "object" + } + ], + "type": "object" + }, + "response_collection-wEgS8Oby": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/ipam-prefixes" }, "type": "array" } } } + ] + }, + "response_collection_hostnames": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/settings-s418OBZp" }, "type": "array" } + } + } + ] + }, + "response_create": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "allOf": [ + { "type": "object" }, + { "properties": { "value": { "$ref": "#/components/schemas/value-V4GUo1Bz" } }, "type": "object" } + ] + } + }, + "type": "object" + } + ] + }, + "response_list": { "items": { "$ref": "#/components/schemas/response_model" }, "type": "array" }, + "response_model": { + "properties": { + "available": { "$ref": "#/components/schemas/available" }, + "enabled": { "$ref": "#/components/schemas/managed_headers_components-schemas-enabled" }, + "id": { "$ref": "#/components/schemas/managed_headers_components-schemas-id" } + }, + "type": "object" + }, + "response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } }, "type": "object" } + ] + }, + "response_single_origin_dns": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "argo_smart_routing": { "$ref": "#/components/schemas/argo_smart_routing" }, + "created_on": { "$ref": "#/components/schemas/created" }, + "dns": { "$ref": "#/components/schemas/dns" }, + "edge_ips": { "$ref": "#/components/schemas/edge_ips" }, + "id": { "$ref": "#/components/schemas/app_id-yTGvAfYO" }, + "ip_firewall": { "$ref": "#/components/schemas/ip_firewall" }, + "modified_on": { "$ref": "#/components/schemas/modified" }, + "origin_dns": { "$ref": "#/components/schemas/origin_dns" }, + "origin_port": { "$ref": "#/components/schemas/origin_port" }, + "protocol": { "$ref": "#/components/schemas/protocol" }, + "proxy_protocol": { "$ref": "#/components/schemas/proxy_protocol" }, + "tls": { "$ref": "#/components/schemas/tls" }, + "traffic_type": { "$ref": "#/components/schemas/traffic_type" } + } + } + } + } + ] + }, + "response_single_segment": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "expires_on": { "$ref": "#/components/schemas/expires_on-dkbMDCaD" }, + "id": { "$ref": "#/components/schemas/components-schemas-identifier-vS0Y8rdw" }, + "not_before": { "$ref": "#/components/schemas/not_before" }, + "status": { "$ref": "#/components/schemas/status-8gYjapkg" } + }, + "required": ["id", "status"] + } + }, + "type": "object" + } + ] + }, + "response_single_value": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/value-V4GUo1Bz" } }, "type": "object" } + ] + }, + "result": { + "properties": { + "data": { "$ref": "#/components/schemas/data" }, + "data_lag": { + "description": "Number of seconds between current time and last processed event, in another words how many seconds of data could be missing.", + "example": 60, + "minimum": 0, + "type": "number" + }, + "max": { + "description": "Maximum results for each metric (object mapping metric names to values). Currently always an empty object.", + "type": "object" + }, + "min": { + "description": "Minimum results for each metric (object mapping metric names to values). Currently always an empty object.", + "type": "object" + }, + "query": { "$ref": "#/components/schemas/query" }, + "rows": { + "description": "Total number of rows in the result.", + "example": 100, + "minimum": 0, + "type": "number" + }, + "totals": { + "description": "Total results for metrics across all data (object mapping metric names to values).", + "type": "object" + } + }, + "required": ["rows", "totals", "min", "max", "data_lag", "query", "data"], + "type": "object" + }, + "result-iSgQlUWZ": { + "description": "Metrics on Workers KV requests.", + "properties": { + "data": { + "items": { + "properties": { + "metrics": { "description": "List of metrics returned by the query.", "items": {}, "type": "array" } + }, + "required": ["metrics"], + "type": "object" + }, + "nullable": true, + "type": "array" + }, + "data_lag": { + "description": "Number of seconds between current time and last processed event, i.e. how many seconds of data could be missing.", + "example": 0, + "minimum": 0, + "type": "number" + }, + "max": { "description": "Maximum results for each metric." }, + "min": { "description": "Minimum results for each metric." }, + "query": { "$ref": "#/components/schemas/query-ju6G02HL" }, + "rows": { + "description": "Total number of rows in the result.", + "example": 2, + "minimum": 0, + "type": "number" + }, + "totals": { "description": "Total results for metrics across all data." } + }, + "required": ["rows", "data", "data_lag", "min", "max", "totals", "query"], + "type": "object" + }, + "result_info": { + "properties": { + "count": { + "description": "Total number of results for the requested service", + "example": 1, + "type": "number" + }, + "page": { "description": "Current page within paginated list of results", "example": 1, "type": "number" }, + "per_page": { "description": "Number of results per page of results", "example": 20, "type": "number" }, + "total_count": { + "description": "Total results available without any search parameters", + "example": 2000, + "type": "number" + } + }, + "type": "object" + }, + "retries": { + "default": 2, + "description": "The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.", + "type": "integer" + }, + "retries-w39sVXcQ": { + "default": 2, + "description": "Number of retries for fetching DNS responses from origin nameservers (not counting the initial attempt).", + "example": 2, + "maximum": 2, + "minimum": 0, + "type": "number" + }, + "revision": { + "description": "The revision of the Railgun receiver.", + "example": "123", + "readOnly": true, + "type": "string" + }, + "revoke_devices_request": { + "description": "A list of device ids to revoke.", + "items": { "$ref": "#/components/schemas/uuid-s0SXln0q" }, + "maxLength": 200, + "type": "array" + }, + "revoke_devices_request-zLb49AXe": { + "description": "A list of device ids to revoke.", + "items": { "$ref": "#/components/schemas/schemas-uuid-lt6l49Ob" }, + "maxLength": 200, + "type": "array" + }, + "revoked_at": { + "description": "When the device was revoked.", + "example": "2017-06-14T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "rewrite_action": { + "description": "Specifies that, when a WAF rule matches, its configured action will be replaced by the action configured in this object.", + "properties": { + "block": { "$ref": "#/components/schemas/waf_rewrite_action" }, + "challenge": { "example": "block" }, + "default": { "example": "block" }, + "disable": { "$ref": "#/components/schemas/waf_rewrite_action" }, + "simulate": { "example": "disable" } + }, + "type": "object" + }, + "risk_score": { + "description": "Hostname risk score, which is a value between 0 (lowest risk) to 1 (highest risk).", + "type": "number" + }, + "risk_types": { "example": [] }, + "rocket_loader": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { "description": "ID of the zone setting.", "enum": ["rocket_loader"], "example": "rocket_loader" }, + "value": { "$ref": "#/components/schemas/rocket_loader_value" } + } + } + ], + "description": "Rocket Loader is a general-purpose asynchronous JavaScript optimisation that prioritises rendering your content while loading your site's Javascript asynchronously. Turning on Rocket Loader will immediately improve a web page's rendering time sometimes measured as Time to First Paint (TTFP), and also the `window.onload` time (assuming there is JavaScript on the page). This can have a positive impact on your Google search ranking. When turned on, Rocket Loader will automatically defer the loading of all Javascript referenced in your HTML, with no configuration required. Refer to [Understanding Rocket Loader](https://support.cloudflare.com/hc/articles/200168056) for more information.", + "title": "Rocket Loader" + }, + "rocket_loader_value": { + "default": "off", + "description": "Value of the zone setting.", + "enum": ["on", "off"], + "type": "string" + }, + "role": { + "properties": { + "description": { + "description": "Description of role's permissions.", + "example": "Administrative access to the entire Account", + "readOnly": true, + "type": "string" + }, + "id": { "$ref": "#/components/schemas/role_components-schemas-identifier" }, + "name": { + "description": "Role name.", + "example": "Account Administrator", + "maxLength": 120, + "readOnly": true, + "type": "string" + }, + "permissions": { "$ref": "#/components/schemas/permissions" } + }, + "required": ["id", "name", "description", "permissions"], + "type": "object" + }, + "role_components-schemas-identifier": { + "description": "Role identifier tag.", + "example": "3536bcfad5faccb999b47003c79917fb", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "roles": { + "description": "List of role names for the user at the account.", + "items": { "example": "Account Administrator", "maxLength": 120, "type": "string" }, + "readOnly": true, + "type": "array" + }, + "route": { + "properties": { + "created_on": { "$ref": "#/components/schemas/created_on" }, + "description": { "$ref": "#/components/schemas/description-dSE9ExYP" }, + "id": { "$ref": "#/components/schemas/identifier-5dNKLCP5" }, + "modified_on": { "$ref": "#/components/schemas/modified_on" }, + "nexthop": { "$ref": "#/components/schemas/nexthop" }, + "prefix": { "$ref": "#/components/schemas/prefix" }, + "priority": { "$ref": "#/components/schemas/priority" }, + "scope": { "$ref": "#/components/schemas/scope" }, + "weight": { "$ref": "#/components/schemas/weight" } + }, + "required": ["prefix", "nexthop", "priority"], + "type": "object" + }, + "route-k62zYPUS": { + "properties": { + "modified_on": { + "description": "The timestamp of when the override was last modified.", + "example": "2014-01-01T05:20:00.12345Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { "description": "The type of route.", "enum": ["forward_url"], "example": "forward_url" }, + "value": { + "properties": { + "type": { + "description": "The response type for the URL redirect.", + "enum": ["temporary", "permanent"], + "example": "temporary" + }, + "url": { + "description": "The URL to redirect the request to.\nNotes: ${num} refers to the position of '*' in the constraint value.", + "example": "http://www.example.com/somewhere/$1/astring/$2/anotherstring/$3", + "type": "string" + } + } + } + }, + "type": "object" + }, + "route-no-id": { + "properties": { + "pattern": { "$ref": "#/components/schemas/pattern-prw776lg" }, + "script": { "$ref": "#/components/schemas/schemas-script_name" } + }, + "required": ["pattern"] + }, + "route-response-collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/routes" }, "type": "array" } } } + ] + }, + "route-response-single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/routes" } } } + ] + }, + "route_add_single_request": { + "properties": { + "description": { "$ref": "#/components/schemas/description-dSE9ExYP" }, + "nexthop": { "$ref": "#/components/schemas/nexthop" }, + "prefix": { "$ref": "#/components/schemas/prefix" }, + "priority": { "$ref": "#/components/schemas/priority" }, + "scope": { "$ref": "#/components/schemas/scope" }, + "weight": { "$ref": "#/components/schemas/weight" } + }, + "required": ["prefix", "nexthop", "priority"], + "type": "object" + }, + "route_delete_id": { + "allOf": [ + { "properties": { "id": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } }, "required": ["id"] } + ] + }, + "route_delete_many_request": { + "properties": { "routes": { "items": { "$ref": "#/components/schemas/route_delete_id" }, "type": "array" } }, + "required": ["routes"], + "type": "object" + }, + "route_deleted_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "deleted": { "example": true, "type": "boolean" }, + "deleted_route": { "type": "object" } + } + } + } + } + ] + }, + "route_modified_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "modified": { "example": true, "type": "boolean" }, + "modified_route": { "type": "object" } + } + } + } + } + ] + }, + "route_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { "result": { "items": { "$ref": "#/components/schemas/teamnet" }, "type": "array" } }, + "type": "object" + } + ] + }, + "route_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } }, "type": "object" } + ] + }, + "route_single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "properties": { "route": { "type": "object" } } } } } + ] + }, + "route_update_many_request": { + "properties": { + "routes": { "items": { "$ref": "#/components/schemas/route_update_single_request" }, "type": "array" } + }, + "required": ["routes"], + "type": "object" + }, + "route_update_request": { "allOf": [{ "$ref": "#/components/schemas/route_add_single_request" }] }, + "route_update_single_request": { + "allOf": [ + { "properties": { "id": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } }, "required": ["id"] }, + { "$ref": "#/components/schemas/route_add_single_request" } + ] + }, + "routes": { + "properties": { + "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" }, + "pattern": { "$ref": "#/components/schemas/pattern-prw776lg" }, + "script": { "$ref": "#/components/schemas/schemas-script_name" } + }, + "required": ["id", "pattern", "script"], + "type": "object" + }, + "routes_collection_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { "routes": { "items": { "$ref": "#/components/schemas/route" }, "type": "array" } } + } + } + } + ] + }, + "rule": { + "oneOf": [ + { "$ref": "#/components/schemas/email_rule" }, + { "$ref": "#/components/schemas/domain_rule" }, + { "$ref": "#/components/schemas/everyone_rule" }, + { "$ref": "#/components/schemas/ip_rule" }, + { "$ref": "#/components/schemas/ip_list_rule" }, + { "$ref": "#/components/schemas/certificate_rule" }, + { "$ref": "#/components/schemas/access_group_rule" }, + { "$ref": "#/components/schemas/azure_group_rule" }, + { "$ref": "#/components/schemas/github_organization_rule" }, + { "$ref": "#/components/schemas/gsuite_group_rule" }, + { "$ref": "#/components/schemas/okta_group_rule" }, + { "$ref": "#/components/schemas/saml_group_rule" } + ], + "type": "object" + }, + "rule-VtwDyToZ": { + "properties": { + "allowed_modes": { + "description": "The available actions that a rule can apply to a matched request.", + "example": ["whitelist", "block", "challenge", "js_challenge", "managed_challenge"], + "items": { "$ref": "#/components/schemas/schemas-mode" }, + "readOnly": true, + "type": "array" + }, + "configuration": { "$ref": "#/components/schemas/schemas-configuration" }, + "created_on": { + "description": "The timestamp of when the rule was created.", + "example": "2014-01-01T05:20:00.12345Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "id": { "$ref": "#/components/schemas/rule_components-schemas-identifier" }, + "mode": { "$ref": "#/components/schemas/schemas-mode" }, + "modified_on": { + "description": "The timestamp of when the rule was last modified.", + "example": "2014-01-01T05:20:00.12345Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "notes": { "$ref": "#/components/schemas/notes" } + }, + "required": ["id", "mode", "allowed_modes", "configuration"], + "type": "object" + }, + "rule-settings": { + "description": "Additional settings that modify the rule's action.", + "properties": { + "add_headers": { + "description": "Add custom headers to allowed requests, in the form of key-value pairs. Keys are header names, pointing to an array with its header value(s).", + "example": { "My-Next-Header": ["foo", "bar"], "X-Custom-Header-Name": ["somecustomvalue"] }, + "type": "object" + }, + "allow_child_bypass": { + "description": "Set by parent MSP accounts to enable their children to bypass this rule.", + "example": false, + "type": "boolean" + }, + "audit_ssh": { + "description": "Audit ssh action settings", + "properties": { + "command_logging": { "description": "Turn on SSH command logging.", "example": false, "type": "boolean" } + }, + "type": "object" + }, + "biso_admin_controls": { + "description": "Configure how browser isolation behaves.", + "properties": { + "dcp": { "description": "Disable copy-paste.", "example": false, "type": "boolean" }, + "dd": { "description": "Disable download.", "example": false, "type": "boolean" }, + "dk": { "description": "Disable keyboard usage.", "example": false, "type": "boolean" }, + "dp": { "description": "Disable printing.", "example": false, "type": "boolean" }, + "du": { "description": "Disable upload.", "example": false, "type": "boolean" } + }, + "type": "object" + }, + "block_page_enabled": { "description": "Enable the custom block page.", "example": true, "type": "boolean" }, + "block_reason": { + "description": "The text describing why this block occurred that will be displayed on the custom block page (if enabled).", + "example": "This website is a security risk", + "type": "string" + }, + "bypass_parent_rule": { + "description": "Set by children MSP accounts to bypass their parent's rules.", + "example": false, + "type": "boolean" + }, + "check_session": { + "description": "Configure how session check behaves.", + "properties": { + "duration": { + "description": "Configure how fresh the session needs to be to be considered valid.", + "example": "300s", + "type": "string" + }, + "enforce": { + "description": "Enable session enforcement for this fule.", + "example": true, + "type": "boolean" + } + }, + "type": "object" + }, + "egress": { + "description": "Configure how Proxy traffic egresses. Can be set for rules with Egress action and Egress filter. Can be omitted to indicate local egress via Warp IPs", + "properties": { + "ipv4": { + "description": "The IPv4 address to be used for egress.", + "example": "192.0.2.2", + "type": "string" + }, + "ipv4_fallback": { + "description": "The IPv4 address to be used for egress in the event of an error egressing with the primary IPv4. Can be '0.0.0.0' to indicate local egreass via Warp IPs.", + "example": "192.0.2.3", + "type": "string" + }, + "ipv6": { + "description": "The IPv6 range to be used for egress.", + "example": "2001:DB8::/64", + "type": "string" + } + }, + "type": "object" + }, + "insecure_disable_dnssec_validation": { + "description": "INSECURE - disable DNSSEC validation (for allow actions).", + "example": false, + "type": "boolean" + }, + "ip_categories": { + "description": "Include IPs in DNS resolver category blocks. By default categories only block on domain names.", + "example": true, + "type": "boolean" + }, + "l4override": { + "description": "Send matching traffic to the supplied destination IP address and port.", + "properties": { + "ip": { "description": "IPv4 or IPv6 address.", "example": "1.1.1.1", "type": "string" }, + "port": { "description": "A port number to use for TCP/UDP overrides.", "type": "integer" } + }, + "type": "object" + }, + "override_host": { + "description": "Override matching DNS queries with this.", + "example": "example.com", + "type": "string" + }, + "override_ips": { + "description": "Override matching DNS queries with this.", + "example": ["1.1.1.1", "2.2.2.2"], + "items": { "description": "IPv4 or IPv6 address.", "example": "1.1.1.1", "type": "string" }, + "type": "array" + }, + "payload_log": { + "description": "Configure DLP payload logging.", + "properties": { + "enabled": { + "description": "Enable DLP payload logging for this rule.", + "example": true, + "type": "boolean" + } + }, + "type": "object" + }, + "untrusted_cert": { + "description": "Configure behavior when an upstream cert is invalid / an SSL error occurs.", + "properties": { + "action": { + "description": "The action to perform upon seeing an untrusted certificate. Default action is error with HTTP code 526.", + "enum": ["pass_through", "block", "error"], + "example": "error", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "rule_action": { + "description": "The action to take when the expression matches.", + "enum": ["bypass_waiting_room"], + "example": "bypass_waiting_room", + "type": "string" + }, + "rule_action-nbqjzWP9": { + "description": "Actions pattern.", + "properties": { + "type": { + "description": "Type of supported action.", + "enum": ["forward", "worker"], + "example": "forward", + "type": "string" + }, + "value": { + "items": { + "description": "Value for action.", + "example": "destinationaddress@example.net", + "maxLength": 90, + "type": "string" + }, + "type": "array" + } + }, + "required": ["type", "value"], + "type": "object" + }, + "rule_actions": { + "description": "List actions patterns.", + "items": { "$ref": "#/components/schemas/rule_action-nbqjzWP9" }, + "type": "array" + }, + "rule_catchall-action": { + "description": "Action for the catch-all routing rule.", + "properties": { + "type": { + "description": "Type of action for catch-all rule.", + "enum": ["drop", "forward", "worker"], + "example": "forward", + "type": "string" + }, + "value": { + "items": { + "description": "Input value for action.", + "example": "destinationaddress@example.net", + "maxLength": 90, + "type": "string" + }, + "type": "array" + } + }, + "required": ["type"], + "type": "object" + }, + "rule_catchall-actions": { + "description": "List actions for the catch-all routing rule.", + "items": { "$ref": "#/components/schemas/rule_catchall-action" }, + "type": "array" + }, + "rule_catchall-matcher": { + "description": "Matcher for catch-all routing rule.", + "properties": { + "type": { + "description": "Type of matcher. Default is 'all'.", + "enum": ["all"], + "example": "all", + "type": "string" + } + }, + "required": ["type"], + "type": "object" + }, + "rule_catchall-matchers": { + "description": "List of matchers for the catch-all routing rule.", + "items": { "$ref": "#/components/schemas/rule_catchall-matcher" }, + "type": "array" + }, + "rule_collection_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/rule-VtwDyToZ" }, "type": "array" } } } + ] + }, + "rule_components-schemas-base": { + "properties": { + "description": { "$ref": "#/components/schemas/rule_components-schemas-description" }, + "group": { + "description": "The rule group to which the current WAF rule belongs.", + "properties": { + "id": { "$ref": "#/components/schemas/group_components-schemas-identifier" }, + "name": { "$ref": "#/components/schemas/group_components-schemas-name" } + }, + "readOnly": true, + "type": "object" + }, + "id": { "$ref": "#/components/schemas/rule_components-schemas-identifier-2" }, + "package_id": { "$ref": "#/components/schemas/package_components-schemas-identifier" }, + "priority": { "$ref": "#/components/schemas/schemas-priority" } + } + }, + "rule_components-schemas-base-2": { "allOf": [{ "$ref": "#/components/schemas/rule_components-schemas-base" }] }, + "rule_components-schemas-description": { + "description": "The public description of the WAF rule.", + "example": "SQL injection prevention for SELECT statements", + "readOnly": true, + "type": "string" + }, + "rule_components-schemas-identifier": { + "description": "The unique identifier of the IP Access rule.", + "example": "92f17202ed8bd63d69a66b86a49a8f6b", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "rule_components-schemas-identifier-2": { + "description": "The unique identifier of the WAF rule.", + "example": "f939de3be84e66e757adcdcb87908023", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "rule_components-schemas-rule": { + "oneOf": [ + { "$ref": "#/components/schemas/email_rule" }, + { "$ref": "#/components/schemas/domain_rule" }, + { "$ref": "#/components/schemas/everyone_rule" }, + { "$ref": "#/components/schemas/ip_rule" }, + { "$ref": "#/components/schemas/ip_list_rule" }, + { "$ref": "#/components/schemas/certificate_rule" }, + { "$ref": "#/components/schemas/access_group_rule" }, + { "$ref": "#/components/schemas/azure_group_rule" }, + { "$ref": "#/components/schemas/github_organization_rule" }, + { "$ref": "#/components/schemas/gsuite_group_rule" }, + { "$ref": "#/components/schemas/okta_group_rule" }, + { "$ref": "#/components/schemas/saml_group_rule" } + ], + "type": "object" + }, + "rule_description": { + "default": "", + "description": "The description of the rule.", + "example": "allow all traffic from 10.20.30.40", + "type": "string" + }, + "rule_enabled": { + "default": true, + "description": "When set to true, the rule is enabled.", + "example": true, + "type": "boolean" + }, + "rule_enabled-VMnvyEOL": { + "default": true, + "description": "Routing rule status.", + "enum": [true, false], + "example": true, + "type": "boolean" + }, + "rule_expression": { + "description": "Criteria defining when there is a match for the current rule.", + "example": "ip.src in {10.20.30.40}", + "type": "string" + }, + "rule_group_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/schemas-group" }, "type": "array" } } } + ] + }, + "rule_group_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } } } + ] + }, + "rule_id": { + "description": "The ID of the rule.", + "example": "25756b2dfe6e378a06b033b670413757", + "type": "string" + }, + "rule_identifier": { "example": "2890e6fa406311ed9b5a23f70f6fb8cf" }, + "rule_identifier-wpFBeqHF": { + "description": "Routing rule identifier.", + "example": "a7e6fb77503c41d8a7f3113c6918f10c", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "rule_matcher": { + "description": "Matching pattern to forward your actions.", + "properties": { + "field": { "description": "Field for type matcher.", "enum": ["to"], "example": "to", "type": "string" }, + "type": { "description": "Type of matcher.", "enum": ["literal"], "example": "literal", "type": "string" }, + "value": { + "description": "Value for matcher.", + "example": "test@example.com", + "maxLength": 90, + "type": "string" + } + }, + "required": ["type", "field", "value"], + "type": "object" + }, + "rule_matchers": { + "description": "Matching patterns to forward to your actions.", + "items": { "$ref": "#/components/schemas/rule_matcher" }, + "type": "array" + }, + "rule_name": { + "description": "Routing rule name.", + "example": "Send to user@example.net rule.", + "maxLength": 256, + "type": "string" + }, + "rule_position": { + "description": "Reorder the position of a rule", + "oneOf": [ + { + "properties": { + "index": { + "description": " Places the rule in the exact position specified by the integer number \u003cPOSITION_NUMBER\u003e. Position numbers start with 1. Existing rules in the ruleset from the specified position number onward are shifted one position (no rule is overwritten).", + "type": "integer" + } + }, + "type": "object" + }, + { + "properties": { + "before": { + "description": " Places the rule before rule \u003cRULE_ID\u003e. Use this argument with an empty rule ID value (\"\") to set the rule as the first rule in the ruleset.", + "example": "\u003cRULE_ID\u003e", + "type": "string" + } + }, + "type": "object" + }, + { + "properties": { + "after": { + "description": "Places the rule after rule \u003cRULE_ID\u003e. Use this argument with an empty rule ID value (\"\") to set the rule as the last rule in the ruleset.", + "example": "\u003cRULE_ID\u003e", + "type": "string" + } + }, + "type": "object" + } + ], + "type": "object" + }, + "rule_priority": { "default": 0, "description": "Priority of the routing rule.", "minimum": 0, "type": "number" }, + "rule_properties": { + "properties": { + "actions": { "$ref": "#/components/schemas/rule_actions" }, + "enabled": { "$ref": "#/components/schemas/rule_enabled-VMnvyEOL" }, + "matchers": { "$ref": "#/components/schemas/rule_matchers" }, + "name": { "$ref": "#/components/schemas/rule_name" }, + "priority": { "$ref": "#/components/schemas/rule_priority" }, + "tag": { "$ref": "#/components/schemas/rule_identifier-wpFBeqHF" } + }, + "type": "object" + }, + "rule_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/components-schemas-rule" }, "type": "array" } + } + } + ] + }, + "rule_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } } } + ] + }, + "rule_response_single-rvlRijjw": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/rules-lDrBq79x" } } } + ] + }, + "rule_result": { + "properties": { + "action": { "$ref": "#/components/schemas/rule_action" }, + "description": { "$ref": "#/components/schemas/rule_description" }, + "enabled": { "$ref": "#/components/schemas/rule_enabled" }, + "expression": { "$ref": "#/components/schemas/rule_expression" }, + "id": { "$ref": "#/components/schemas/rule_id" }, + "last_updated": { "$ref": "#/components/schemas/timestamp" }, + "version": { "$ref": "#/components/schemas/rule_version" } + }, + "type": "object" + }, + "rule_single_id_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { "id": { "$ref": "#/components/schemas/rule_components-schemas-identifier" } }, + "type": "object" + } + } + } + ] + }, + "rule_single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/rule-VtwDyToZ" } } } + ] + }, + "rule_version": { "description": "The version of the rule.", "example": "1", "type": "string" }, + "rules": { + "properties": { + "action": { "$ref": "#/components/schemas/action" }, + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "deleted_at": { "$ref": "#/components/schemas/deleted_at" }, + "description": { "$ref": "#/components/schemas/schemas-description" }, + "device_posture": { "$ref": "#/components/schemas/device_posture" }, + "enabled": { "$ref": "#/components/schemas/enabled" }, + "filters": { "$ref": "#/components/schemas/filters" }, + "id": { "$ref": "#/components/schemas/uuid" }, + "identity": { "$ref": "#/components/schemas/identity" }, + "name": { "$ref": "#/components/schemas/components-schemas-name" }, + "precedence": { "$ref": "#/components/schemas/precedence" }, + "rule_settings": { "$ref": "#/components/schemas/rule-settings" }, + "schedule": { "$ref": "#/components/schemas/schedule" }, + "traffic": { "$ref": "#/components/schemas/traffic" }, + "updated_at": { "$ref": "#/components/schemas/timestamp" } + }, + "type": "object" + }, + "rules-8L4eu614": { + "description": "BETA Field Not General Access: A list of rules for this load balancer to execute.", + "items": { + "additionalProperties": false, + "description": "A rule object containing conditions and overrides for this load balancer to evaluate.", + "properties": { + "condition": { + "description": "The condition expressions to evaluate. If the condition evaluates to true, the overrides or fixed_response in this rule will be applied. An empty condition is always true. For more details on condition expressions, please see https://developers.cloudflare.com/load-balancing/understand-basics/load-balancing-rules/expressions.", + "example": "http.request.uri.path contains \"/testing\"", + "type": "string" + }, + "disabled": { + "default": false, + "description": "Disable this specific rule. It will no longer be evaluated by this load balancer.", + "type": "boolean" + }, + "fixed_response": { + "description": "A collection of fields used to directly respond to the eyeball instead of routing to a pool. If a fixed_response is supplied the rule will be marked as terminates.", + "properties": { + "content_type": { + "description": "The http 'Content-Type' header to include in the response.", + "example": "application/json", + "maxLength": 32, + "type": "string" + }, + "location": { + "description": "The http 'Location' header to include in the response.", + "example": "www.example.com", + "maxLength": 2048, + "type": "string" + }, + "message_body": { + "description": "Text to include as the http body.", + "example": "Testing Hello", + "maxLength": 1024, + "type": "string" + }, + "status_code": { "description": "The http status code to respond with.", "type": "integer" } + }, + "type": "object" + }, + "name": { + "description": "Name of this rule. Only used for human readability.", + "example": "route the path /testing to testing datacenter.", + "maxLength": 200, + "type": "string" + }, + "overrides": { + "description": "A collection of overrides to apply to the load balancer when this rule's condition is true. All fields are optional.", + "properties": { + "adaptive_routing": { "$ref": "#/components/schemas/adaptive_routing" }, + "country_pools": { "$ref": "#/components/schemas/country_pools" }, + "default_pools": { "$ref": "#/components/schemas/default_pools" }, + "fallback_pool": { "$ref": "#/components/schemas/fallback_pool" }, + "location_strategy": { "$ref": "#/components/schemas/location_strategy" }, + "pop_pools": { "$ref": "#/components/schemas/pop_pools" }, + "random_steering": { "$ref": "#/components/schemas/random_steering" }, + "region_pools": { "$ref": "#/components/schemas/region_pools" }, + "session_affinity": { "$ref": "#/components/schemas/session_affinity" }, + "session_affinity_attributes": { "$ref": "#/components/schemas/session_affinity_attributes" }, + "session_affinity_ttl": { "$ref": "#/components/schemas/session_affinity_ttl" }, + "steering_policy": { "$ref": "#/components/schemas/steering_policy" }, + "ttl": { "$ref": "#/components/schemas/ttl-0jCBhfJ2" } + }, + "type": "object" + }, + "priority": { + "default": 0, + "description": "The order in which rules should be executed in relation to each other. Lower values are executed first. Values do not need to be sequential. If no value is provided for any rule the array order of the rules field will be used to assign a priority.", + "type": "integer" + }, + "terminates": { + "default": false, + "description": "If this rule's condition is true, this causes rule evaluation to stop after processing this rule.", + "type": "boolean" + } + }, + "type": "object" + }, + "type": "array" + }, + "rules-YnuEBjzV": { + "additionalProperties": { "allOf": [{ "$ref": "#/components/schemas/waf_action" }], "example": "default" }, + "description": "An object that allows you to override the action of specific WAF rules. Each key of this object must be the ID of a WAF rule, and each value must be a valid WAF action. Unless you are disabling a rule, ensure that you also enable the rule group that this WAF rule belongs to. When creating a new URI-based WAF override, you must provide a `groups` object or a `rules` object.", + "example": { "100015": "disable" }, + "type": "object" + }, + "rules-lDrBq79x": { "allOf": [{ "$ref": "#/components/schemas/rule_properties" }], "type": "object" }, + "rules_components-schemas-account_identifier": { "example": "6f91088a406011ed95aed352566e8d4c" }, + "rules_components-schemas-action": { + "description": "The action to perform when the rule matches.", + "example": "execute", + "pattern": "^[a-z_]+$", + "type": "string" + }, + "rules_components-schemas-description": { + "default": "", + "description": "An informative description of the rule.", + "example": "Execute the OWASP ruleset when the IP address is not 1.1.1.1", + "type": "string" + }, + "rules_components-schemas-enabled": { + "default": "true", + "description": "Whether the rule should be executed.", + "example": true, + "type": "boolean" + }, + "rules_components-schemas-id": { + "description": "The unique ID of the rule.", + "example": "3a03d665bac047339bb530ecb439a90d", + "type": "string" + }, + "rules_components-schemas-rule": { + "description": "A rule object.", + "properties": { + "action": { "$ref": "#/components/schemas/rules_components-schemas-action" }, + "action_parameters": { "$ref": "#/components/schemas/action_parameters" }, + "categories": { "$ref": "#/components/schemas/categories-YFgu3d0j" }, + "description": { "$ref": "#/components/schemas/rules_components-schemas-description" }, + "enabled": { "$ref": "#/components/schemas/rules_components-schemas-enabled" }, + "expression": { "$ref": "#/components/schemas/schemas-expression" }, + "id": { "$ref": "#/components/schemas/rules_components-schemas-id" }, + "last_updated": { "$ref": "#/components/schemas/schemas-last_updated" }, + "logging": { "$ref": "#/components/schemas/logging" }, + "ref": { "$ref": "#/components/schemas/components-schemas-ref" }, + "version": { "$ref": "#/components/schemas/schemas-version" } + }, + "type": "object" + }, + "rules_count": { + "default": 0, + "description": "The number of rules in the current rule group.", + "example": 10, + "readOnly": true, + "type": "number" + }, + "rules_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/rule_result" }, "type": "array" } } } + ] + }, + "rules_response_collection-Fgtzw0xK": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/rules-lDrBq79x" }, "type": "array" }, + "result_info": { + "properties": { + "count": { "example": 1 }, + "page": { "example": 1 }, + "per_page": { "example": 20 }, + "total_count": { "example": 1 } + }, + "type": "object" + } + } + } + ] + }, + "ruleset": { + "description": "A ruleset object.", + "properties": { + "description": { "$ref": "#/components/schemas/rulesets_components-schemas-description" }, + "id": { "$ref": "#/components/schemas/rulesets_components-schemas-id" }, + "kind": { "$ref": "#/components/schemas/schemas-kind" }, + "last_updated": { "$ref": "#/components/schemas/last_updated" }, + "name": { "$ref": "#/components/schemas/rulesets_components-schemas-name" }, + "phase": { "$ref": "#/components/schemas/phase" }, + "rules": { "$ref": "#/components/schemas/schemas-rules" }, + "version": { "$ref": "#/components/schemas/version-VHkxmcSG" } + }, + "type": "object" + }, + "ruleset_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { "properties": { "result": { "$ref": "#/components/schemas/ruleset" } }, "type": "object" } + ] + }, + "ruleset_without_rules": { + "description": "A ruleset object.", + "properties": { + "description": { "$ref": "#/components/schemas/rulesets_components-schemas-description" }, + "id": { "$ref": "#/components/schemas/rulesets_components-schemas-id" }, + "kind": { "$ref": "#/components/schemas/schemas-kind" }, + "last_updated": { "$ref": "#/components/schemas/last_updated" }, + "name": { "$ref": "#/components/schemas/rulesets_components-schemas-name" }, + "phase": { "$ref": "#/components/schemas/phase" }, + "version": { "$ref": "#/components/schemas/version-VHkxmcSG" } + }, + "type": "object" + }, + "rulesets_components-schemas-description": { + "default": "", + "description": "An informative description of the ruleset.", + "example": "My ruleset to execute managed rulesets", + "type": "string" + }, + "rulesets_components-schemas-id": { + "description": "The unique ID of the ruleset.", + "example": "2f2feab2026849078ba485f918791bdc", + "pattern": "^[0-9a-f]{32}$", + "type": "string" + }, + "rulesets_components-schemas-name": { + "description": "The human-readable name of the ruleset.", + "example": "My ruleset", + "type": "string" + }, + "rulesets_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { + "properties": { + "result": { + "description": "A list of rulesets. The returned information will not include the rules in each ruleset.", + "items": { "$ref": "#/components/schemas/ruleset_without_rules" }, + "type": "array" + } + }, + "type": "object" + } + ] + }, + "run_at": { + "description": "Timestamp of when the tunnel connection was started.", + "example": "2009-11-10T23:00:00Z", + "format": "date-time", + "type": "string" + }, + "saas_app": { + "properties": { + "consumer_service_url": { + "description": "The service provider's endpoint that is responsible for receiving and parsing a SAML assertion.", + "example": "https://example.com", + "type": "string" + }, + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "custom_attributes": { + "properties": { + "name": { "description": "The name of the attribute.", "example": "family_name", "type": "string" }, + "name_format": { + "description": "A globally unique name for an identity or service provider.", + "enum": [ + "urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified", + "urn:oasis:names:tc:SAML:2.0:attrname-format:basic", + "urn:oasis:names:tc:SAML:2.0:attrname-format:uri" + ], + "example": "urn:oasis:names:tc:SAML:2.0:attrname-format:basic", + "type": "string" + }, + "source": { + "properties": { + "name": { "description": "The name of the IdP attribute.", "example": "last_name", "type": "string" } + }, + "type": "object" + } + }, + "type": "object" + }, + "idp_entity_id": { + "description": "The unique identifier for your SaaS application.", + "example": "https://example.cloudflareaccess.com", + "type": "string" + }, + "name_id_format": { + "description": "The format of the name identifier sent to the SaaS application.", + "enum": ["id", "email"], + "example": "id", + "type": "string" + }, + "public_key": { + "description": "The Access public certificate that will be used to verify your identity.", + "example": "example unique name", + "type": "string" + }, + "sp_entity_id": { + "description": "A globally unique name for an identity or service provider.", + "example": "example unique name", + "type": "string" + }, + "sso_endpoint": { + "description": "The endpoint where your SaaS application will send login requests.", + "example": "https://example.cloudflareaccess.com/cdn-cgi/access/sso/saml/b3f58a2b414e0b51d45c8c2af26fccca0e27c63763c426fa52f98dcf0b3b3bfd", + "type": "string" + }, + "updated_at": { "$ref": "#/components/schemas/timestamp" } + }, + "type": "object" + }, + "saas_props": { + "properties": { + "allowed_idps": { "$ref": "#/components/schemas/allowed_idps" }, + "app_launcher_visible": { "$ref": "#/components/schemas/app_launcher_visible" }, + "auto_redirect_to_identity": { "$ref": "#/components/schemas/schemas-auto_redirect_to_identity" }, + "logo_url": { "$ref": "#/components/schemas/logo_url" }, + "name": { "$ref": "#/components/schemas/apps_components-schemas-name" }, + "saas_app": { "$ref": "#/components/schemas/saas_app" }, + "type": { "description": "The application type.", "example": "saas", "type": "string" } + }, + "title": "SaaS Application", + "type": "object" + }, + "saas_props-3mDdjpPa": { + "properties": { + "allowed_idps": { "$ref": "#/components/schemas/allowed_idps" }, + "app_launcher_visible": { "$ref": "#/components/schemas/app_launcher_visible" }, + "auto_redirect_to_identity": { "$ref": "#/components/schemas/auto_redirect_to_identity-zRTYoQOC" }, + "logo_url": { "$ref": "#/components/schemas/logo_url" }, + "name": { "$ref": "#/components/schemas/apps_components-schemas-name" }, + "saas_app": { "$ref": "#/components/schemas/saas_app" }, + "type": { "description": "The application type.", "example": "saas", "type": "string" } + }, + "title": "SaaS Application", + "type": "object" + }, + "same_site_cookie_attribute": { + "description": "Sets the SameSite cookie setting, which provides increased security against CSRF attacks.", + "example": "strict", + "type": "string" + }, + "saml": { + "allOf": [ + { "$ref": "#/components/schemas/identity-provider" }, + { + "properties": { + "config": { + "properties": { + "attributes": { + "description": "A list of SAML attribute names that will be added to your signed JWT token and can be used in SAML policy rules.", + "example": ["group", "department_code", "divison"], + "items": { "type": "string" }, + "type": "array" + }, + "email_attribute_name": { + "description": "The attribute name for email in the SAML response.", + "example": "Email", + "type": "string" + }, + "header_attributes": { + "description": "Add a list of attribute names that will be returned in the response header from the Access callback.", + "items": { + "properties": { + "attribute_name": { "description": "attribute name from the IDP", "type": "string" }, + "header_name": { + "description": "header that will be added on the request to the origin", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "idp_public_certs": { + "description": "X509 certificate to verify the signature in the SAML authentication response", + "items": { "type": "string" }, + "type": "array" + }, + "issuer_url": { + "description": "IdP Entity ID or Issuer URL", + "example": "https://whoami.com", + "type": "string" + }, + "sign_request": { + "description": "Sign the SAML authentication request with Access credentials. To verify the signature, use the public key from the Access certs endpoints.", + "type": "boolean" + }, + "sso_target_url": { + "description": "URL to send the SAML authentication requests to", + "example": "https://edgeaccess.org/idp/saml/login", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + ], + "title": "Generic SAML", + "type": "object" + }, + "saml_group_rule": { + "description": "Matches a SAML group.\nRequires a SAML identity provider.", + "properties": { + "saml": { + "properties": { + "attribute_name": { + "description": "The name of the SAML attribute.", + "example": "group", + "type": "string" + }, + "attribute_value": { + "description": "The SAML attribute value to look for.", + "example": "devs@cloudflare.com", + "type": "string" + } + }, + "required": ["attribute_name", "attribute_value"], + "type": "object" + } + }, + "required": ["saml"], + "title": "SAML group", + "type": "object" + }, + "sample": { + "description": "The sample parameter is the sample rate of the records set by the client: \"sample\": 1 is 100% of records \"sample\": 10 is 10% and so on.", + "example": 1, + "type": "integer" + }, + "sample-qlwBkrnD": { + "description": "When `?sample=` is provided, a sample of matching records is returned. If `sample=0.1` then 10% of records will be returned. Sampling is random: repeated calls will not only return different records, but likely will also vary slightly in number of returned records. When `?count=` is also specified, `count` is applied to the number of returned records, not the sampled records. So, with `sample=0.05` and `count=7`, when there is a total of 100 records available, approximately five will be returned. When there are 1000 records, seven will be returned. When there are 10,000 records, seven will be returned.", + "example": 0.1, + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "scale": { + "default": 0.15, + "description": "The size of the image relative to the overall size of the video. This parameter will adapt to horizontal and vertical videos automatically. `0.0` indicates no scaling (use the size of the image as-is), and `1.0 `fills the entire video.", + "example": 0.1, + "maximum": 1, + "minimum": 0, + "readOnly": true, + "type": "number" + }, + "schedule": { + "description": "Schedule for activating DNS policies. Does not apply to HTTP or network policies.", + "properties": { + "fri": { + "description": "The time intervals when the rule will be active on Fridays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Fridays.", + "example": "08:00-12:30,13:30-17:00", + "type": "string" + }, + "mon": { + "description": "The time intervals when the rule will be active on Mondays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Mondays.", + "example": "08:00-12:30,13:30-17:00", + "type": "string" + }, + "sat": { + "description": "The time intervals when the rule will be active on Saturdays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Saturdays.", + "example": "08:00-12:30,13:30-17:00", + "type": "string" + }, + "sun": { + "description": "The time intervals when the rule will be active on Sundays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Sundays.", + "example": "08:00-12:30,13:30-17:00", + "type": "string" + }, + "thu": { + "description": "The time intervals when the rule will be active on Thursdays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Thursdays.", + "example": "08:00-12:30,13:30-17:00", + "type": "string" + }, + "time_zone": { + "description": "The time zone the rule will be evaluated against. If a [valid time zone city name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) is provided, Gateway will always use the current time at that time zone. If this parameter is omitted, then the time zone inferred from the user's source IP is used to evaluate the rule. If Gateway cannot determine the time zone from the IP, we will fall back to the time zone of the user's connected data center.", + "example": "America/New York", + "type": "string" + }, + "tue": { + "description": "The time intervals when the rule will be active on Tuesdays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Tuesdays.", + "example": "08:00-12:30,13:30-17:00", + "type": "string" + }, + "wed": { + "description": "The time intervals when the rule will be active on Wednesdays, in increasing order from 00:00-24:00. If this parameter is omitted, the rule will be deactivated on Wednesdays.", + "example": "08:00-12:30,13:30-17:00", + "type": "string" + } + }, + "type": "object" + }, + "schedule-6SyTxxBD": { + "description": "Polling frequency for the WARP client posture check. Default: `5m` (poll every five minutes). Minimum: `1m`.", + "example": "1h", + "type": "string" + }, + "schedule-kOC57cA0": { + "description": "Polling frequency for the WARP client posture check. Default: `5m` (poll every five minutes). Minimum: `1m`.", + "example": "1h", + "type": "string" + }, + "schema_response_discovery": { + "allOf": [ + { "$ref": "#/components/schemas/default_response" }, + { + "properties": { + "result": { + "properties": { + "schemas": { "items": { "$ref": "#/components/schemas/openapi" }, "type": "array" }, + "timestamp": { "type": "string" } + }, + "type": "object" + } + } + } + ] + }, + "schema_response_with_thresholds": { + "allOf": [ + { "$ref": "#/components/schemas/default_response" }, + { + "properties": { + "result": { + "properties": { + "schemas": { "items": { "$ref": "#/components/schemas/openapiwiththresholds" }, "type": "array" }, + "timestamp": { "type": "string" } + }, + "type": "object" + } + } + } + ] + }, + "schemas-access_seat": { + "description": "True if the user has authenticated with Cloudflare Access.", + "example": false, + "type": "boolean" + }, + "schemas-account": { "allOf": [{ "$ref": "#/components/schemas/account" }], "readOnly": true }, + "schemas-account_identifier": { + "description": "Account identifier tag.", + "example": "023e105f4ecef8ad9ca31a8372d0c353", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "schemas-action": { + "anyOf": [ + { + "properties": { + "mode": { "$ref": "#/components/schemas/mode" }, + "response": { "$ref": "#/components/schemas/custom_response" }, + "timeout": { "$ref": "#/components/schemas/timeout-QN7vNkTu" } + }, + "type": "object" + } + ], + "description": "The action to perform when the threshold of matched traffic within the configured period is exceeded.", + "type": "object" + }, + "schemas-action_parameters": { + "description": "The parameters configuring the action.", + "oneOf": [{ "$ref": "#/components/schemas/action_parameters_route" }], + "type": "object" + }, + "schemas-address": { "description": "Address.", "example": "123 Sesame St.", "type": "string" }, + "schemas-advertised": { + "description": "Enablement of prefix advertisement to the Internet.", + "example": true, + "type": "boolean" + }, + "schemas-alert_type": { + "description": "Type of notification that has been dispatched.", + "example": "universal_ssl_event_type", + "type": "string" + }, + "schemas-allowed": { + "default": false, + "description": "The result of the authentication event.", + "type": "boolean" + }, + "schemas-api-response-common": { + "properties": { + "errors": { "$ref": "#/components/schemas/messages" }, + "messages": { "$ref": "#/components/schemas/messages" }, + "result": { "anyOf": [{ "type": "object" }, { "items": {}, "type": "array" }, { "type": "string" }] }, + "success": { + "description": "Whether the API call was successful", + "enum": [true], + "example": true, + "type": "boolean" + } + }, + "required": ["success", "errors", "messages", "result"], + "type": "object" + }, + "schemas-api-response-common-failure": { + "properties": { + "errors": { + "allOf": [{ "$ref": "#/components/schemas/messages" }], + "example": [{ "code": 7003, "message": "No route for the URI" }], + "minLength": 1 + }, + "messages": { "allOf": [{ "$ref": "#/components/schemas/messages" }], "example": [] }, + "result": { "enum": [null], "nullable": true, "type": "object" }, + "success": { + "description": "Whether the API call was successful", + "enum": [false], + "example": false, + "type": "boolean" + } + }, + "required": ["success", "errors", "messages", "result"], + "type": "object" + }, + "schemas-api-response-single-id": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-api-response-common" }, + { + "properties": { + "result": { + "nullable": true, + "properties": { "id": { "$ref": "#/components/schemas/schemas-identifier" } }, + "required": ["id"], + "type": "object" + } + } + } + ], + "type": "object" + }, + "schemas-app_launcher_visible": { + "description": "Displays the application in the App Launcher.", + "example": true, + "type": "boolean" + }, + "schemas-apps": { + "anyOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/basic_app_response_props" }, + { "$ref": "#/components/schemas/schemas-self_hosted_props" } + ], + "title": "Self Hosted Application", + "type": "object" + }, + { + "allOf": [ + { "$ref": "#/components/schemas/basic_app_response_props" }, + { "$ref": "#/components/schemas/saas_props" } + ], + "title": "SaaS Application", + "type": "object" + }, + { + "allOf": [ + { "$ref": "#/components/schemas/basic_app_response_props" }, + { "$ref": "#/components/schemas/schemas-ssh_props" } + ], + "title": "Browser SSH Application", + "type": "object" + }, + { + "allOf": [ + { "$ref": "#/components/schemas/basic_app_response_props" }, + { "$ref": "#/components/schemas/schemas-vnc_props" } + ], + "title": "Browser VNC Application", + "type": "object" + }, + { + "allOf": [ + { "$ref": "#/components/schemas/basic_app_response_props" }, + { "$ref": "#/components/schemas/app_launcher_props" } + ], + "title": "App Launcher Application", + "type": "object" + }, + { + "allOf": [ + { "$ref": "#/components/schemas/basic_app_response_props" }, + { "$ref": "#/components/schemas/warp_props" } + ], + "title": "Device Enrollment Permissions Application", + "type": "object" + }, + { + "allOf": [ + { "$ref": "#/components/schemas/basic_app_response_props" }, + { "$ref": "#/components/schemas/biso_props" } + ], + "title": "Browser Isolation Permissions Application", + "type": "object" + }, + { + "allOf": [ + { "$ref": "#/components/schemas/basic_app_response_props" }, + { "$ref": "#/components/schemas/schemas-bookmark_props" } + ], + "title": "Bookmark application", + "type": "object" + } + ], + "type": "object" + }, + "schemas-apps-DgI9Bh95": { + "anyOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/basic_app_response_props-4oEch10U" }, + { "$ref": "#/components/schemas/self_hosted_props-pFu7lQyL" } + ], + "title": "Self Hosted Application", + "type": "object" + }, + { + "allOf": [ + { "$ref": "#/components/schemas/basic_app_response_props-4oEch10U" }, + { "$ref": "#/components/schemas/saas_props-3mDdjpPa" } + ], + "title": "SaaS Application", + "type": "object" + }, + { + "allOf": [ + { "$ref": "#/components/schemas/basic_app_response_props-4oEch10U" }, + { "$ref": "#/components/schemas/ssh_props" } + ], + "title": "Browser SSH Application", + "type": "object" + }, + { + "allOf": [ + { "$ref": "#/components/schemas/basic_app_response_props-4oEch10U" }, + { "$ref": "#/components/schemas/vnc_props" } + ], + "title": "Browser VNC Application", + "type": "object" + }, + { + "allOf": [ + { "$ref": "#/components/schemas/basic_app_response_props-4oEch10U" }, + { "$ref": "#/components/schemas/app_launcher_props" } + ], + "title": "App Launcher Application", + "type": "object" + }, + { + "allOf": [ + { "$ref": "#/components/schemas/basic_app_response_props-4oEch10U" }, + { "$ref": "#/components/schemas/warp_props" } + ], + "title": "Device Enrollment Permissions Application", + "type": "object" + }, + { + "allOf": [ + { "$ref": "#/components/schemas/basic_app_response_props-4oEch10U" }, + { "$ref": "#/components/schemas/biso_props" } + ], + "title": "Browser Isolation Permissions Application", + "type": "object" + }, + { + "allOf": [ + { "$ref": "#/components/schemas/basic_app_response_props-4oEch10U" }, + { "$ref": "#/components/schemas/schemas-bookmark_props-ygkj2JJN" } + ], + "title": "Bookmark application", + "type": "object" + } + ], + "type": "object" + }, + "schemas-asn": { "description": "AS number associated with the node object.", "type": "string" }, + "schemas-aud": { + "description": "Audience tag.", + "example": "737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893", + "maxLength": 64, + "readOnly": true, + "type": "string" + }, + "schemas-auto_redirect_to_identity": { + "default": false, + "description": "When set to `true`, users skip the identity provider selection step during login. You must specify only one identity provider in allowed_idps.", + "type": "boolean" + }, + "schemas-automatic_platform_optimization": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { + "description": "ID of the zone setting.", + "enum": ["automatic_platform_optimization"], + "example": "automatic_platform_optimization" + }, + "value": { "$ref": "#/components/schemas/automatic_platform_optimization" } + } + } + ], + "description": "[Automatic Platform Optimization for WordPress](https://developers.cloudflare.com/automatic-platform-optimization/) serves your WordPress site from Cloudflare's edge network and caches third-party fonts.", + "title": "Automatic Platform Optimization for WordPress" + }, + "schemas-available": { + "description": "Shows if a domain is available for transferring into Cloudflare Registrar.", + "example": false, + "type": "boolean" + }, + "schemas-azureAD": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-identity-provider" }, + { + "properties": { + "config": { + "allOf": [ + { "$ref": "#/components/schemas/generic-oauth-config" }, + { + "properties": { + "directory_id": { + "description": "Your Azure directory uuid", + "example": "\u003cyour azure directory uuid\u003e", + "type": "string" + }, + "support_groups": { + "description": "Should Cloudflare try to load groups from your account", + "type": "boolean" + } + }, + "type": "object" + } + ] + } + }, + "type": "object" + } + ], + "title": "Azure AD", + "type": "object" + }, + "schemas-base": { + "properties": { + "id": { "description": "Identifier of the zone setting.", "example": "development_mode", "type": "string" }, + "modified_on": { + "description": "last time this setting was modified.", + "example": "2014-01-01T05:20:00.12345Z", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + } + }, + "required": ["id", "modified_on"] + }, + "schemas-bookmark_props": { + "properties": { + "app_launcher_visible": { "default": true }, + "domain": { "description": "The URL or domain of the bookmark.", "example": "https://mybookmark.com" }, + "logo_url": { "$ref": "#/components/schemas/logo_url" }, + "name": { "$ref": "#/components/schemas/apps_components-schemas-name" }, + "type": { "description": "The application type.", "example": "bookmark", "type": "string" } + }, + "required": ["type", "domain"], + "title": "Bookmark Application", + "type": "object" + }, + "schemas-bookmark_props-ygkj2JJN": { + "properties": { + "app_launcher_visible": { "default": true }, + "domain": { "description": "The URL or domain of the bookmark.", "example": "https://mybookmark.com" }, + "logo_url": { "$ref": "#/components/schemas/logo_url" }, + "name": { "$ref": "#/components/schemas/apps_components-schemas-name" }, + "type": { "description": "The application type.", "example": "bookmark", "type": "string" } + }, + "title": "Bookmark Application", + "type": "object" + }, + "schemas-ca": { + "properties": { + "aud": { "$ref": "#/components/schemas/aud" }, + "id": { "$ref": "#/components/schemas/ca_components-schemas-id" }, + "public_key": { "$ref": "#/components/schemas/public_key-xgmH3SVX" } + }, + "type": "object" + }, + "schemas-can_delete": { + "description": "Controls whether the membership can be deleted via the API or not.", + "example": true, + "type": "boolean" + }, + "schemas-centrify": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-identity-provider" }, + { + "properties": { + "config": { + "allOf": [ + { "$ref": "#/components/schemas/generic-oauth-config" }, + { + "properties": { + "centrify_account": { + "description": "Your centrify account url", + "example": "https://abc123.my.centrify.com/", + "type": "string" + }, + "centrify_app_id": { + "description": "Your centrify app id", + "example": "exampleapp", + "type": "string" + } + }, + "type": "object" + } + ] + } + }, + "type": "object" + } + ], + "title": "Centrify", + "type": "object" + }, + "schemas-certificate": { + "description": "The zone's SSL certificate or SSL certificate and intermediate(s).", + "example": "-----BEGIN CERTIFICATE----- MIIDtTCCAp2gAwIBAgIJAM15n7fdxhRtMA0GCSqGSIb3DQEBBQUAMEUxCzAJBgNV BAYTAlVTMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX aWRnaXRzIFB0eSBMdGQwHhcNMTQwMzExMTkyMTU5WhcNMTQwNDEwMTkyMTU5WjBF MQswCQYDVQQGEwJVUzETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50 ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB CgKCAQEAvq3sKsHpeduJHimOK+fvQdKsI8z8A05MZyyLp2/R/GE8FjNv+hkVY1WQ LIyTNNQH7CJecE1nbTfo8Y56S7x/rhxC6/DJ8MIulapFPnorq46KU6yRxiM0MQ3N nTJHlHA2ozZta6YBBfVfhHWl1F0IfNbXCLKvGwWWMbCx43OfW6KTkbRnE6gFWKuO fSO5h2u5TaWVuSIzBvYs7Vza6m+gtYAvKAJV2nSZ+eSEFPDo29corOy8+huEOUL8 5FAw4BFPsr1TlrlGPFitduQUHGrSL7skk1ESGza0to3bOtrodKei2s9bk5MXm7lZ qI+WZJX4Zu9+mzZhc9pCVi8r/qlXuQIDAQABo4GnMIGkMB0GA1UdDgQWBBRvavf+ sWM4IwKiH9X9w1vl6nUVRDB1BgNVHSMEbjBsgBRvavf+sWM4IwKiH9X9w1vl6nUV RKFJpEcwRTELMAkGA1UEBhMCVVMxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV BAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAM15n7fdxhRtMAwGA1UdEwQF MAMBAf8wDQYJKoZIhvcNAQEFBQADggEBABY2ZzBaW0dMsAAT7tPJzrVWVzQx6KU4 UEBLudIlWPlkAwTnINCWR/8eNjCCmGA4heUdHmazdpPa8RzwOmc0NT1NQqzSyktt vTqb4iHD7+8f9MqJ9/FssCfTtqr/Qst/hGH4Wmdf1EJ/6FqYAAb5iRlPgshFZxU8 uXtA8hWn6fK6eISD9HBdcAFToUvKNZ1BIDPvh9f95Ine8ar6yGd56TUNrHR8eHBs ESxz5ddVR/oWRysNJ+aGAyYqHS8S/ttmC7r4XCAHqXptkHPCGRqkAhsterYhd4I8 /cBzejUobNCjjHFbtkAL/SjxZOLW+pNkZwfeYdM8iPkD54Uua1v2tdw= -----END CERTIFICATE-----", + "type": "string" + }, + "schemas-certificateObject": { + "properties": { + "certificate": { + "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate" + }, + "expires_on": { + "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-expires_on" + }, + "id": { "$ref": "#/components/schemas/identifier-tZwYoMuc" }, + "issuer": { "$ref": "#/components/schemas/issuer" }, + "serial_number": { "$ref": "#/components/schemas/serial_number" }, + "signature": { "$ref": "#/components/schemas/signature" }, + "status": { "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-status" }, + "uploaded_on": { "$ref": "#/components/schemas/components-schemas-uploaded_on" } + } + }, + "schemas-certificateObject-otmSOZma": { + "properties": { + "certificate": { + "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate" + }, + "expires_on": { + "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-expires_on" + }, + "id": { "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier" }, + "issuer": { "$ref": "#/components/schemas/issuer" }, + "serial_number": { "$ref": "#/components/schemas/serial_number" }, + "signature": { "$ref": "#/components/schemas/signature" }, + "status": { "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-status" }, + "uploaded_on": { "$ref": "#/components/schemas/components-schemas-uploaded_on" } + } + }, + "schemas-certificate_authority": { + "description": "Certificate Authority selected for the order. Selecting Let's Encrypt will reduce customization of other fields: validation_method must be 'txt', validity_days must be 90, cloudflare_branding must be omitted, and hosts must contain only 2 entries, one for the zone name and one for the subdomain wildcard of the zone name (e.g. example.com, *.example.com).", + "enum": ["digicert", "google", "lets_encrypt"], + "example": "digicert", + "type": "string" + }, + "schemas-certificate_authority-mu8utRU0": { + "description": "The Certificate Authority that Total TLS certificates will be issued through.", + "enum": ["google", "lets_encrypt"], + "example": "google", + "type": "string" + }, + "schemas-certificate_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/certificates-M6ivZ4vU" }, "type": "array" } + }, + "type": "object" + } + ] + }, + "schemas-certificate_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } }, "type": "object" } + ] + }, + "schemas-certificates": { + "description": "The uploaded root CA certificate.", + "example": "-----BEGIN CERTIFICATE-----\nMIIDmDCCAoCgAwIBAgIUKTOAZNjcXVZRj4oQt0SHsl1c1vMwDQYJKoZIhvcNAQELBQAwUTELMAkGA1UEBhMCVVMxFjAUBgNVBAgMDVNhbiBGcmFuY2lzY28xEzARBgNVBAcMCkNhbGlmb3JuaWExFTATBgNVBAoMDEV4YW1wbGUgSW5jLjAgFw0yMjExMjIxNjU5NDdaGA8yMTIyMTAyOTE2NTk0N1owUTELMAkGA1UEBhMCVVMxFjAUBgNVBAgMDVNhbiBGcmFuY2lzY28xEzARBgNVBAcMCkNhbGlmb3JuaWExFTATBgNVBAoMDEV4YW1wbGUgSW5jLjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMRcORwgJFTdcG/2GKI+cFYiOBNDKjCZUXEOvXWY42BkH9wxiMT869CO+enA1w5pIrXow6kCM1sQspHHaVmJUlotEMJxyoLFfA/8Kt1EKFyobOjuZs2SwyVyJ2sStvQuUQEosULZCNGZEqoH5g6zhMPxaxm7ZLrrsDZ9maNGVqo7EWLWHrZ57Q/5MtTrbxQL+eXjUmJ9K3kS+3uEwMdqR6Z3BluU1ivanpPc1CN2GNhdO0/hSY4YkGEnuLsqJyDd3cIiB1MxuCBJ4ZaqOd2viV1WcP3oU3dxVPm4MWyfYIldMWB14FahScxLhWdRnM9YZ/i9IFcLypXsuz7DjrJPtPUCAwEAAaNmMGQwHQYDVR0OBBYEFP5JzLUawNF+c3AXsYTEWHh7z2czMB8GA1UdIwQYMBaAFP5JzLUawNF+c3AXsYTEWHh7z2czMA4GA1UdDwEB/wQEAwIBBjASBgNVHRMBAf8ECDAGAQH/AgEBMA0GCSqGSIb3DQEBCwUAA4IBAQBc+Be7NDhpE09y7hLPZGRPl1cSKBw4RI0XIv6rlbSTFs5EebpTGjhx/whNxwEZhB9HZ7111Oa1YlT8xkI9DshB78mjAHCKBAJ76moK8tkG0aqdYpJ4ZcJTVBB7l98Rvgc7zfTii7WemTy72deBbSeiEtXavm4EF0mWjHhQ5Nxpnp00Bqn5g1x8CyTDypgmugnep+xG+iFzNmTdsz7WI9T/7kDMXqB7M/FPWBORyS98OJqNDswCLF8bIZYwUBEe+bRHFomoShMzaC3tvim7WCb16noDkSTMlfKO4pnvKhpcVdSgwcruATV7y+W+Lvmz2OT/Gui4JhqeoTewsxndhDDE\n-----END CERTIFICATE-----", + "type": "string" + }, + "schemas-cidr_configuration": { + "properties": { + "target": { + "description": "The configuration target. You must set the target to `ip_range` when specifying an IP address range in the Zone Lockdown rule.", + "enum": ["ip_range"], + "example": "ip_range" + }, + "value": { + "description": "The IP address range to match. You can only use prefix lengths `/16` and `/24`.", + "example": "198.51.100.4/16", + "type": "string" + } + }, + "title": "An IP address range configuration." + }, + "schemas-collection_invite_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { "result": { "items": { "$ref": "#/components/schemas/schemas-invite" }, "type": "array" } }, + "type": "object" + } + ] + }, + "schemas-collection_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "items": { + "properties": { + "additional_information": { "$ref": "#/components/schemas/additional_information" }, + "application": { "$ref": "#/components/schemas/application-WiomAg5h" }, + "content_categories": { "$ref": "#/components/schemas/content_categories" }, + "domain": { "$ref": "#/components/schemas/schemas-domain_name" }, + "popularity_rank": { "$ref": "#/components/schemas/popularity_rank" }, + "risk_score": { "$ref": "#/components/schemas/risk_score" }, + "risk_types": { "$ref": "#/components/schemas/risk_types" } + } + }, + "type": "array" + } + } + } + ] + }, + "schemas-colo_name": { + "description": "The Cloudflare data center used for this connection.", + "example": "DFW", + "type": "string" + }, + "schemas-comment": { + "description": "Optional remark describing the virtual network.", + "example": "Staging VPC for data science", + "type": "string" + }, + "schemas-component_values": { + "description": "Array of available components values for the plan.", + "items": { "$ref": "#/components/schemas/component-value" }, + "type": "array" + }, + "schemas-config": { + "description": "The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).", + "type": "object" + }, + "schemas-config_request": { + "description": "The configuration object containing information for the WARP client to detect the managed network.", + "example": { + "sha256": "b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c", + "tls_sockaddr": "foo.bar:1234" + }, + "oneOf": [{ "$ref": "#/components/schemas/tls_config_request" }], + "type": "object" + }, + "schemas-config_response": { + "description": "The configuration object containing information for the WARP client to detect the managed network.", + "example": { + "sha256": "b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c", + "tls_sockaddr": "foo.bar:1234" + }, + "oneOf": [{ "$ref": "#/components/schemas/tls_config_response" }], + "type": "object" + }, + "schemas-configuration": { + "description": "The rule configuration.", + "oneOf": [ + { "$ref": "#/components/schemas/ip_configuration" }, + { "$ref": "#/components/schemas/ipv6_configuration" }, + { "$ref": "#/components/schemas/cidr_configuration" }, + { "$ref": "#/components/schemas/asn_configuration" }, + { "$ref": "#/components/schemas/country_configuration" } + ], + "type": "object" + }, + "schemas-connection": { "description": "The IdP used to authenticate.", "example": "saml", "type": "string" }, + "schemas-created": { + "description": "When the device was created.", + "example": "2017-06-14T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "schemas-created_at": { + "description": "The time when the certificate was created.", + "example": "2100-01-01T05:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "schemas-created_on": { + "description": "The date and time the tunnel was created.", + "example": "2017-06-14T00:00:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "schemas-created_on-KZj9IpMd": { + "description": "The RFC 3339 timestamp of when the list was created.", + "example": "2020-01-01T08:00:00Z", + "type": "string" + }, + "schemas-csr": { + "description": "The Certificate Signing Request (CSR). Must be newline-encoded.", + "example": "-----BEGIN CERTIFICATE REQUEST-----\\nMIICY....\\n-----END CERTIFICATE REQUEST-----\\n", + "type": "string" + }, + "schemas-cursor": { + "description": "Opaque token indicating the position from which to continue when requesting the next set of records. A valid value for the cursor can be obtained from the cursors object in the result_info structure.", + "example": "AAAAANuhDN7SjacTnSVsDu3WW1Lvst6dxJGTjRY5BhxPXdf6L6uTcpd_NVtjhn11OUYRsVEykxoUwF-JQU4dn6QylZSKTOJuG0indrdn_MlHpMRtsxgXjs-RPdHYIVm3odE_uvEQ_dTQGFm8oikZMohns34DLBgrQpc", + "type": "string" + }, + "schemas-default": { + "description": "Whether the policy is the default policy for an account.", + "example": false, + "type": "boolean" + }, + "schemas-deleted": { "description": "True if the device was deleted.", "example": true, "type": "boolean" }, + "schemas-description": { + "description": "The description of the Rule.", + "example": "Block the bad websites based on host name", + "type": "string" + }, + "schemas-description-Fsn87iOz": { + "description": "An optional description field which may be used to describe the types of IPs or zones on the map.", + "example": "My Ecommerce zones", + "nullable": true, + "type": "string" + }, + "schemas-description-MUzoo3Z3": { + "description": "The billing item description.", + "example": "The billing item description", + "maxLength": 255, + "readOnly": true, + "type": "string" + }, + "schemas-description-SitV9b51": { + "description": "An optional description of the GRE tunnel.", + "example": "Tunnel for ISP X", + "type": "string" + }, + "schemas-description-XvtZaN2T": { + "description": "A human-readable description of the pool.", + "example": "Primary data center - Provider XYZ", + "type": "string" + }, + "schemas-description-jdg4o19i": { + "description": "A description of the policy.", + "example": "Policy for test teams.", + "maxLength": 500, + "type": "string" + }, + "schemas-description_search": { + "description": "A string to search for in the description of existing rules.", + "example": "endpoints", + "type": "string" + }, + "schemas-destination_conf": { + "description": "Unique WebSocket address that will receive messages from Cloudflare’s edge.", + "example": "wss://logs.cloudflare.com/instant-logs/ws/sessions/99d471b1ca3c23cc8e30b6acec5db987", + "format": "uri", + "maxLength": 4096, + "type": "string" + }, + "schemas-disabled_at": { + "description": "This field shows up only if the pool is disabled. This field is set with the time the pool was disabled at.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "schemas-dns-firewall": { "allOf": [{ "$ref": "#/components/schemas/dns-firewall" }], "type": "object" }, + "schemas-domain": { + "description": "The domain of the Bookmark application.", + "example": "example.com", + "type": "string" + }, + "schemas-domain-N8byIUtr": { + "description": "The domain and path that Access will secure.", + "example": "test.example.com/admin", + "type": "string" + }, + "schemas-domain_identifier": { + "description": "Domain identifier.", + "example": "ea95132c15732412d22c1476fa83f27a", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "schemas-domain_name": { "example": "cloudflare.com", "type": "string" }, + "schemas-email": { + "description": "The email of the user.", + "example": "jdoe@example.com", + "format": "email", + "type": "string" + }, + "schemas-email-EQUZrKsL": { + "description": "The email address of the authenticating user.", + "example": "user@example.com", + "format": "email", + "type": "string" + }, + "schemas-empty_response": { + "allOf": [ + { + "properties": { + "result": { "nullable": true, "type": "object" }, + "success": { "enum": [true, false], "example": true, "type": "boolean" } + } + } + ] + }, + "schemas-empty_response-raiSSReB": { + "allOf": [ + { + "properties": { + "result": { "nullable": true }, + "success": { "enum": [true, false], "example": true, "type": "boolean" } + } + } + ] + }, + "schemas-enabled": { + "description": "Disabling Universal SSL removes any currently active Universal SSL certificates for your zone from the edge and prevents any future Universal SSL certificates from being ordered. If there are no advanced certificates or custom certificates uploaded for the domain, visitors will be unable to access the domain over HTTPS.\n\nBy disabling Universal SSL, you understand that the following Cloudflare settings and preferences will result in visitors being unable to visit your domain unless you have uploaded a custom certificate or purchased an advanced certificate.\n\n* HSTS\n* Always Use HTTPS\n* Opportunistic Encryption\n* Onion Routing\n* Any Page Rules redirecting traffic to HTTPS\n\nSimilarly, any HTTP redirect to HTTPS at the origin while the Cloudflare proxy is enabled will result in users being unable to visit your site without a valid certificate at Cloudflare's edge.\n\nIf you do not have a valid custom or advanced certificate at Cloudflare's edge and are unsure if any of the above Cloudflare settings are enabled, or if any HTTP redirects exist at your origin, we advise leaving Universal SSL enabled for your domain.", + "example": true, + "type": "boolean" + }, + "schemas-enabled-ItkBt4kJ": { + "default": true, + "description": "Whether to enable (the default) this origin within the pool. Disabled origins will not receive traffic and are excluded from health checks. The origin will only be disabled for the current pool.", + "example": true, + "type": "boolean" + }, + "schemas-exclude": { + "description": "Rules evaluated with a NOT logical operator. To match the policy, a user cannot meet any of the Exclude rules.", + "items": { "$ref": "#/components/schemas/rule" }, + "type": "array" + }, + "schemas-exclude-NRBuYW2u": { + "description": "Rules evaluated with a NOT logical operator. To match the policy, a user cannot meet any of the Exclude rules.", + "items": { "$ref": "#/components/schemas/rule_components-schemas-rule" }, + "type": "array" + }, + "schemas-expected_codes": { + "default": "200", + "description": "The expected HTTP response codes or code ranges of the health check, comma-separated. This parameter is only valid for HTTP and HTTPS monitors.", + "example": "2xx", + "type": "string" + }, + "schemas-expiration": { + "description": "Sets the expiration time for a posture check result. If empty, the result remains valid until it is overwritten by new data from the WARP client.", + "example": "1h", + "type": "string" + }, + "schemas-expires_on": { + "description": "When the certificate will expire.", + "example": "2014-01-01T05:20:00.12345Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "schemas-expires_on-SFzDZ8Kt": { + "description": "When the invite is no longer active.", + "example": "2014-01-01T05:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "schemas-expression": { + "description": "The expression defining which traffic will match the rule.", + "example": "ip.src ne 1.1.1.1", + "type": "string" + }, + "schemas-facebook": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-identity-provider" }, + { "properties": { "config": { "$ref": "#/components/schemas/generic-oauth-config" } }, "type": "object" } + ], + "title": "Facebook", + "type": "object" + }, + "schemas-features": { + "description": "Features enabled for the Cloudflare Tunnel.", + "items": { "example": "ha-origin", "type": "string" }, + "type": "array" + }, + "schemas-filter-response-collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "items": { + "allOf": [ + { "$ref": "#/components/schemas/filter-k8oSIkrx" }, + { "required": ["id", "expression", "paused"], "type": "object" } + ] + }, + "type": "array" + } + }, + "type": "object" + } + ] + }, + "schemas-filter-response-single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "oneOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/filter-k8oSIkrx" }, + { "required": ["id", "expression", "paused"], "type": "object" } + ] + }, + { "nullable": true } + ] + } + }, + "required": ["result"], + "type": "object" + } + ] + }, + "schemas-filter_options": { + "description": "Format of additional configuration options (filters) for the alert type. Data type of filters during policy creation: Array of strings.", + "example": [ + { "ComparisonOperator": "==", "Key": "zones", "Optional": false }, + { "ComparisonOperator": "\u003e=", "Key": "slo", "Optional": true } + ], + "items": {}, + "type": "array" + }, + "schemas-filters": { + "properties": { + "configuration.target": { + "description": "The target to search in existing rules.", + "enum": ["ip", "ip_range", "asn", "country"], + "example": "ip", + "type": "string" + }, + "configuration.value": { + "description": "The target value to search for in existing rules: an IP address, an IP address range, or a country code, depending on the provided `configuration.target`.\nNotes: You can search for a single IPv4 address, an IP address range with a subnet of '/16' or '/24', or a two-letter ISO-3166-1 alpha-2 country code.", + "example": "198.51.100.4", + "type": "string" + }, + "match": { + "default": "all", + "description": "When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match.", + "enum": ["any", "all"], + "type": "string" + }, + "mode": { "$ref": "#/components/schemas/schemas-mode" }, + "notes": { + "description": "The string to search for in the notes of existing IP Access rules.\nNotes: For example, the string 'attack' would match IP Access rules with notes 'Attack 26/02' and 'Attack 27/02'. The search is case insensitive.", + "example": "my note", + "type": "string" + } + }, + "type": "object" + }, + "schemas-force_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/schemas-force_result" } } } + ] + }, + "schemas-force_result": { + "description": "When force_notify query parameter is set to true, the response is a simple string", + "example": "OK", + "type": "string" + }, + "schemas-frequency": { + "description": "The frequency at which you will be billed for this plan.", + "enum": ["weekly", "monthly", "quarterly", "yearly"], + "example": "monthly", + "readOnly": true, + "type": "string" + }, + "schemas-gateway_seat": { + "description": "True if the user has logged into the WARP client.", + "example": false, + "type": "boolean" + }, + "schemas-github": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-identity-provider" }, + { "properties": { "config": { "$ref": "#/components/schemas/generic-oauth-config" } }, "type": "object" } + ], + "title": "GitHub", + "type": "object" + }, + "schemas-google": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-identity-provider" }, + { "properties": { "config": { "$ref": "#/components/schemas/generic-oauth-config" } }, "type": "object" } + ], + "title": "Google", + "type": "object" + }, + "schemas-google-apps": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-identity-provider" }, + { + "properties": { + "config": { + "allOf": [ + { "$ref": "#/components/schemas/generic-oauth-config" }, + { + "properties": { + "apps_domain": { + "description": "Your companies TLD", + "example": "mycompany.com", + "type": "string" + } + }, + "type": "object" + } + ] + } + }, + "type": "object" + } + ], + "title": "Google Workspace", + "type": "object" + }, + "schemas-group": { + "allOf": [ + { "$ref": "#/components/schemas/group" }, + { + "properties": { + "allowed_modes": { "$ref": "#/components/schemas/allowed_modes" }, + "mode": { "$ref": "#/components/schemas/components-schemas-mode" } + } + } + ], + "required": ["id", "name", "description", "mode", "rules_count"], + "type": "object" + }, + "schemas-groups": { + "properties": { + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "exclude": { "$ref": "#/components/schemas/exclude-TaQDb77a" }, + "id": { "$ref": "#/components/schemas/schemas-uuid-vgvRNXQL" }, + "include": { "$ref": "#/components/schemas/include-6K7SmqAm" }, + "name": { "$ref": "#/components/schemas/groups_components-schemas-name" }, + "require": { "$ref": "#/components/schemas/require-SpDpRST8" }, + "updated_at": { "$ref": "#/components/schemas/timestamp" } + }, + "type": "object" + }, + "schemas-header": { + "description": "The request header is used to pass additional information with an HTTP request. Currently supported header is 'Host'.", + "properties": { "Host": { "$ref": "#/components/schemas/Host" } }, + "type": "object" + }, + "schemas-health_check": { + "properties": { + "enabled": { + "default": true, + "description": "Determines whether to run healthchecks for a tunnel.", + "example": true, + "type": "boolean" + }, + "rate": { + "default": "mid", + "description": "How frequent the health check is run. The default value is `mid`.", + "enum": ["low", "mid", "high"], + "example": "low", + "type": "string" + }, + "target": { + "description": "The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`.", + "example": "203.0.113.1", + "type": "string" + }, + "type": { + "default": "reply", + "description": "The type of healthcheck to run, reply or request. The default value is `reply`.", + "enum": ["reply", "request"], + "example": "request", + "type": "string" + } + }, + "type": "object" + }, + "schemas-host": { + "description": "The keyless SSL name.", + "example": "example.com", + "format": "hostname", + "maxLength": 253, + "type": "string" + }, + "schemas-hostname": { + "description": "The hostname on the origin for which the client certificate uploaded will be used.", + "example": "app.example.com", + "maxLength": 255, + "type": "string" + }, + "schemas-hosts": { + "description": "Comma separated list of valid host names for the certificate packs. Must contain the zone apex, may not contain more than 50 hosts, and may not be empty.", + "example": ["example.com", "*.example.com", "www.example.com"], + "items": { "type": "string" }, + "type": "array" + }, + "schemas-id": { "description": "The ID of the user.", "example": "f3b12456-80dd-4e89-9f5f-ba3dfff12365" }, + "schemas-id-OWr6ZoMG": { + "description": "Identifier for the tail.", + "example": "03dc9f77817b488fb26c5861ec18f791", + "type": "string" + }, + "schemas-id_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { "id": { "$ref": "#/components/schemas/schemas-identifier-03kXbNiE" } }, + "type": "object" + } + } + } + ] + }, + "schemas-id_response-77ATe4Eu": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { "properties": { "id": { "$ref": "#/components/schemas/id-e2D1eWah" } }, "type": "object" } + } + } + ] + }, + "schemas-id_response-CtbIGMqm": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { "id": { "$ref": "#/components/schemas/pool_components-schemas-identifier" } }, + "type": "object" + } + } + } + ] + }, + "schemas-id_response-ZaI3kQGy": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "nullable": true } } } + ] + }, + "schemas-id_response-n8mMAIdf": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { "id": { "$ref": "#/components/schemas/schemas-identifier-LDS3pdXe" } }, + "type": "object" + } + } + } + ] + }, + "schemas-identifier": { + "description": "Identifier", + "example": "023e105f4ecef8ad9ca31a8372d0c353", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "schemas-identifier-03kXbNiE": { "example": "69cd1e104af3e6ed3cb344f263fd0d5a", "readOnly": true }, + "schemas-identifier-3n9sRq0H": {}, + "schemas-identifier-67y1Mk1I": { + "description": "Tunnel identifier tag.", + "example": "c4a7362d577a6c3019a474fd6f485821", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "schemas-identifier-LDS3pdXe": { "example": "17b5962d775c646f3f9725cbc7a53df4" }, + "schemas-identifier-f8xN4YrK": { + "description": "Keyless certificate identifier tag.", + "example": "4d2844d2ce78891c34d0b6c0535a291e", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "schemas-identity-provider": { + "properties": { + "config": { + "description": "The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).", + "type": "object" + }, + "id": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" }, + "name": { "$ref": "#/components/schemas/schemas-name-QA00iN6H" }, + "scim_config": { + "description": "The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.", + "properties": { + "enabled": { + "description": "A flag to enable or disable SCIM for the identity provider.", + "type": "boolean" + }, + "group_member_deprovision": { + "description": "A flag to revoke a user's session in Access and force a reauthentication on the user's Gateway session when they have been added or removed from a group in the Identity Provider.", + "type": "boolean" + }, + "seat_deprovision": { + "description": "A flag to remove a user's seat in Zero Trust when they have been deprovisioned in the Identity Provider. This cannot be enabled unless user_deprovision is also enabled.", + "type": "boolean" + }, + "secret": { + "description": "A read-only token generated when the SCIM integration is enabled for the first time. It is redacted on subsequent requests. If you lose this you will need to refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.", + "type": "string" + }, + "user_deprovision": { + "description": "A flag to enable revoking a user's session in Access and Gateway when they have been deprovisioned in the Identity Provider.", + "type": "boolean" + } + }, + "type": "object" + }, + "type": { + "description": "The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).", + "example": "onetimepin", + "type": "string" + } + }, + "required": ["name", "type", "config"], + "type": "object" + }, + "schemas-identity-providers": { + "oneOf": [ + { "$ref": "#/components/schemas/schemas-azureAD" }, + { "$ref": "#/components/schemas/schemas-centrify" }, + { "$ref": "#/components/schemas/schemas-facebook" }, + { "$ref": "#/components/schemas/schemas-github" }, + { "$ref": "#/components/schemas/schemas-google" }, + { "$ref": "#/components/schemas/schemas-google-apps" }, + { "$ref": "#/components/schemas/schemas-linkedin" }, + { "$ref": "#/components/schemas/schemas-oidc" }, + { "$ref": "#/components/schemas/schemas-okta" }, + { "$ref": "#/components/schemas/schemas-onelogin" }, + { "$ref": "#/components/schemas/schemas-pingone" }, + { "$ref": "#/components/schemas/schemas-saml" }, + { "$ref": "#/components/schemas/schemas-yandex" } + ] + }, + "schemas-include": { "items": { "$ref": "#/components/schemas/split_tunnel_include" }, "type": "array" }, + "schemas-interval": { + "description": "The interval between each posture check with the third party API. Use \"m\" for minutes (e.g. \"5m\") and \"h\" for hours (e.g. \"12h\").", + "example": "10m", + "type": "string" + }, + "schemas-invite": { "allOf": [{ "$ref": "#/components/schemas/user_invite" }], "type": "object" }, + "schemas-ip": { + "description": "The IP address of the authenticating user.", + "example": "198.41.129.166", + "type": "string" + }, + "schemas-ip_configuration": { + "properties": { + "target": { + "description": "The configuration target. You must set the target to `ip` when specifying an IP address in the Zone Lockdown rule.", + "enum": ["ip"], + "example": "ip" + }, + "value": { + "description": "The IP address to match. This address will be compared to the IP address of incoming requests.", + "example": "198.51.100.4", + "type": "string" + } + }, + "title": "An IP address configuration." + }, + "schemas-ips": { + "description": "The set of IPs on the Address Map.", + "items": { "$ref": "#/components/schemas/address-maps-ip" }, + "type": "array" + }, + "schemas-issuer": { + "description": "The certificate authority that issued the certificate.", + "example": "O=Example Inc.,L=California,ST=San Francisco,C=US", + "readOnly": true, + "type": "string" + }, + "schemas-key": { + "description": "The device's public key.", + "example": "yek0SUYoOQ10vMGsIYAevozXUQpQtNFJFfFGqER/BGc=", + "type": "string" + }, + "schemas-kind": { + "description": "The kind of the ruleset.", + "enum": ["custom", "root", "zone"], + "example": "root", + "type": "string" + }, + "schemas-last_updated": { + "description": "The timestamp of when the rule was last modified.", + "example": "2000-01-01T00:00:00.000000Z", + "type": "string" + }, + "schemas-linkedin": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-identity-provider" }, + { "properties": { "config": { "$ref": "#/components/schemas/generic-oauth-config" } }, "type": "object" } + ], + "title": "LinkedIn", + "type": "object" + }, + "schemas-match": { + "description": "The conditions that the client must match to run the rule.", + "items": { "$ref": "#/components/schemas/match_item" }, + "type": "array" + }, + "schemas-match-ImQchlrH": { + "description": "The wirefilter expression to match devices.", + "example": "user.identity == \"test@cloudflare.com\"", + "maxLength": 500, + "type": "string" + }, + "schemas-member": { "allOf": [{ "$ref": "#/components/schemas/member" }] }, + "schemas-metadata": { + "description": "What EXIF data should be preserved in the output image.", + "enum": ["keep", "copyright", "none"], + "example": "none", + "type": "string" + }, + "schemas-method": { + "default": "GET", + "description": "The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.", + "example": "GET", + "type": "string" + }, + "schemas-mode": { + "description": "The action to apply to a matched request.", + "enum": ["block", "challenge", "whitelist", "js_challenge", "managed_challenge"], + "example": "challenge", + "type": "string" + }, + "schemas-modified_on": { + "description": "The date and time the tunnel was last modified.", + "example": "2017-06-14T05:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "schemas-modified_on-DUFYxWOX": { + "description": "The timestamp of when the Page Rule was last modified.", + "example": "2014-01-01T05:20:00.12345Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "schemas-modified_on-lfwlFlJl": { + "description": "When the certificate was last modified.", + "example": "2014-01-01T05:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "schemas-modified_tunnels_collection_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "modified": { "example": true, "type": "boolean" }, + "modified_ipsec_tunnels": { + "items": { "$ref": "#/components/schemas/ipsec-tunnel" }, + "type": "array" + } + } + } + } + } + ] + }, + "schemas-monitor": { + "description": "The ID of the Monitor to use for checking the health of origins within this pool." + }, + "schemas-mtu": { + "default": 1476, + "description": "The Maximum Transmission Unit (MTU) in bytes for the interconnect. The minimum value is 576.", + "type": "integer" + }, + "schemas-name": { + "description": "The name of the Location.", + "example": "Austin Office Location", + "type": "string" + }, + "schemas-name-1UDkXCXq": { "description": "The device name.", "example": "My mobile device", "type": "string" }, + "schemas-name-F4rYvN2r": { + "description": "Optional unique name for the certificate. Only used for human readability.", + "example": "example_ca_cert", + "type": "string" + }, + "schemas-name-QA00iN6H": { + "description": "The name of the identity provider, shown to users on the login page.", + "example": "Widget Corps IDP", + "type": "string" + }, + "schemas-name-Tf4rbdAh": { + "description": "A human-identifiable name for the origin.", + "example": "app-server-1", + "type": "string" + }, + "schemas-name-Usb6SCq8": { + "description": "Organization name.", + "example": "Cloudflare, Inc.", + "maxLength": 100, + "type": "string" + }, + "schemas-name-m2fEJLlJ": { + "description": "The name of the IPsec tunnel. The name cannot share a name with other tunnels.", + "example": "IPsec_1", + "type": "string" + }, + "schemas-name-rmJQq4HY": { "description": "TSIG key name.", "example": "tsig.customer.cf.", "type": "string" }, + "schemas-namespace": { + "properties": { + "class": { "readOnly": true }, + "id": { "readOnly": true }, + "name": { "readOnly": true }, + "script": { "readOnly": true } + }, + "type": "object" + }, + "schemas-oidc": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-identity-provider" }, + { + "properties": { + "config": { + "allOf": [ + { "$ref": "#/components/schemas/generic-oauth-config" }, + { + "properties": { + "auth_url": { + "description": "The authorization_endpoint URL of your IdP", + "example": "https://accounts.google.com/o/oauth2/auth", + "type": "string" + }, + "certs_url": { + "description": "The jwks_uri endpoint of your IdP to allow the IdP keys to sign the tokens", + "example": "https://www.googleapis.com/oauth2/v3/certs", + "type": "string" + }, + "claims": { + "description": "List of custom claims that will be pulled from your id_token and added to your signed Access JWT token.", + "example": ["given_name", "locale"], + "items": { "type": "string" }, + "type": "array" + }, + "scopes": { + "description": "OAuth scopes", + "example": ["openid", "email", "profile"], + "items": { "type": "string" }, + "type": "array" + }, + "token_url": { + "description": "The token_endpoint URL of your IdP", + "example": "https://accounts.google.com/o/oauth2/token", + "type": "string" + } + }, + "type": "object" + } + ] + } + }, + "type": "object" + } + ], + "title": "Generic OAuth", + "type": "object" + }, + "schemas-okta": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-identity-provider" }, + { + "properties": { + "config": { + "allOf": [ + { "$ref": "#/components/schemas/generic-oauth-config" }, + { + "properties": { + "okta_account": { + "description": "Your okta account url", + "example": "https://dev-abc123.oktapreview.com", + "type": "string" + } + }, + "type": "object" + } + ] + } + }, + "type": "object" + } + ], + "title": "Okta", + "type": "object" + }, + "schemas-onelogin": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-identity-provider" }, + { + "properties": { + "config": { + "allOf": [ + { "$ref": "#/components/schemas/generic-oauth-config" }, + { + "properties": { + "onelogin_account": { + "description": "Your OneLogin account url", + "example": "https://mycompany.onelogin.com", + "type": "string" + } + }, + "type": "object" + } + ] + } + }, + "type": "object" + } + ], + "title": "OneLogin", + "type": "object" + }, + "schemas-operation": { + "properties": { + "completed": { + "description": "The RFC 3339 timestamp of when the operation was completed.", + "example": "2020-01-01T08:00:00Z", + "readOnly": true, + "type": "string" + }, + "error": { + "description": "A message describing the error when the status is `failed`.", + "example": "This list is at the maximum number of items", + "readOnly": true, + "type": "string" + }, + "id": { "$ref": "#/components/schemas/operation_id" }, + "status": { + "description": "The current status of the asynchronous operation.", + "enum": ["pending", "running", "completed", "failed"], + "example": "failed", + "readOnly": true, + "type": "string" + } + }, + "required": ["id", "status"], + "type": "object" + }, + "schemas-options": { + "example": { "max_ttl": 15, "packet_type": "icmp" }, + "properties": { + "max_ttl": { "$ref": "#/components/schemas/max_ttl" }, + "packet_type": { "$ref": "#/components/schemas/packet_type" }, + "packets_per_ttl": { "$ref": "#/components/schemas/packets_per_ttl" }, + "port": { "$ref": "#/components/schemas/traceroute_components-schemas-port" }, + "wait_time": { "$ref": "#/components/schemas/wait_time" } + } + }, + "schemas-organization": { + "description": "Name of organization.", + "example": "Cloudflare, Inc.", + "type": "string" + }, + "schemas-origin": { + "properties": { + "address": { "$ref": "#/components/schemas/address-SVXLSyuc" }, + "disabled_at": { "$ref": "#/components/schemas/disabled_at" }, + "enabled": { "$ref": "#/components/schemas/origin_components-schemas-enabled" }, + "header": { "$ref": "#/components/schemas/schemas-header" }, + "name": { "$ref": "#/components/schemas/origin_components-schemas-name" }, + "virtual_network_id": { "$ref": "#/components/schemas/virtual_network_id" }, + "weight": { "$ref": "#/components/schemas/weight-9aFRWjMy" } + }, + "type": "object" + }, + "schemas-patch": { + "description": "Update enablement of Tiered Caching", + "properties": { "value": { "$ref": "#/components/schemas/components-schemas-value" } }, + "required": ["value"], + "type": "object" + }, + "schemas-pattern": { "example": "example.net/*", "title": "Filter pattern", "type": "string" }, + "schemas-paused": { + "description": "When true, indicates that the rule is currently paused.", + "example": false, + "type": "boolean" + }, + "schemas-per_page": { "description": "Number of results to display.", "minimum": 1, "type": "number" }, + "schemas-permissions": { + "description": "Access permissions for this User.", + "items": { "example": "#zones:read", "maxLength": 160, "type": "string" }, + "readOnly": true, + "type": "array" + }, + "schemas-phase": { + "description": "The phase where the ruleset is executed.", + "enum": ["http_request_transform", "http_request_late_transform", "http_response_headers_transform"], + "type": "string" + }, + "schemas-pingone": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-identity-provider" }, + { + "properties": { + "config": { + "allOf": [ + { "$ref": "#/components/schemas/generic-oauth-config" }, + { + "properties": { + "ping_env_id": { + "description": "Your PingOne environment identifier", + "example": "342b5660-0c32-4936-a5a4-ce21fae57b0a", + "type": "string" + } + }, + "type": "object" + } + ] + } + }, + "type": "object" + } + ], + "title": "PingOne", + "type": "object" + }, + "schemas-policies": { + "properties": { + "approval_groups": { "$ref": "#/components/schemas/approval_groups" }, + "approval_required": { "$ref": "#/components/schemas/approval_required" }, + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "decision": { "$ref": "#/components/schemas/decision" }, + "exclude": { "$ref": "#/components/schemas/schemas-exclude-NRBuYW2u" }, + "id": { "$ref": "#/components/schemas/components-schemas-uuid" }, + "include": { "$ref": "#/components/schemas/include-6K7SmqAm" }, + "name": { "$ref": "#/components/schemas/policies_components-schemas-name" }, + "precedence": { "$ref": "#/components/schemas/precedence-3goMFnFD" }, + "purpose_justification_prompt": { "$ref": "#/components/schemas/purpose_justification_prompt" }, + "purpose_justification_required": { "$ref": "#/components/schemas/purpose_justification_required" }, + "require": { "$ref": "#/components/schemas/schemas-require-0qS7IZb9" }, + "updated_at": { "$ref": "#/components/schemas/timestamp" } + }, + "type": "object" + }, + "schemas-port": { + "default": 0, + "description": "Port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).", + "type": "integer" + }, + "schemas-port-uAxZ6zJW": { + "default": 0, + "description": "The port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).", + "type": "integer" + }, + "schemas-precedence": { + "description": "The precedence of the policy. Lower values indicate higher precedence. Policies will be evaluated in ascending order of this field.", + "example": 100, + "type": "number" + }, + "schemas-preview_id": { "example": "p1aba936b94213e5b8dca0c0dbf1f9cc" }, + "schemas-price": { + "description": "The amount you will be billed for this plan.", + "example": 0, + "type": "number" + }, + "schemas-priority": { + "description": "The order in which the individual WAF rule is executed within its rule group.", + "readOnly": true, + "type": "string" + }, + "schemas-private_key": { + "description": "The hostname certificate's private key.", + "example": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n", + "type": "string" + }, + "schemas-railgun": { + "properties": { + "activation": { "$ref": "#/components/schemas/activation" }, + "created_on": { "$ref": "#/components/schemas/components-schemas-created_on" }, + "enabled": { "$ref": "#/components/schemas/railgun_components-schemas-enabled" }, + "id": { "$ref": "#/components/schemas/railgun_components-schemas-identifier" }, + "modified_on": { "$ref": "#/components/schemas/railgun_components-schemas-modified_on" }, + "name": { "$ref": "#/components/schemas/railgun_components-schemas-name" }, + "status": { "$ref": "#/components/schemas/railgun_components-schemas-status" }, + "upgrade_info": { "$ref": "#/components/schemas/upgrade_info" }, + "zones_connected": { "$ref": "#/components/schemas/zones_connected" } + }, + "required": ["id", "name", "status", "enabled", "zones_connected", "activation"], + "type": "object" + }, + "schemas-railgun_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "type": "object" }, "type": "array" } } } + ] + }, + "schemas-rate-plan": { "allOf": [{ "$ref": "#/components/schemas/rate-plan" }], "type": "object" }, + "schemas-ref": { + "description": "A short reference tag. Allows you to select related filters.", + "example": "FIL-100", + "maxLength": 50, + "type": "string" + }, + "schemas-references_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "description": "List of resources that reference a given pool.", + "example": [ + { + "reference_type": "referrer", + "resource_id": "699d98642c564d2e855e9661899b7252", + "resource_name": "www.example.com", + "resource_type": "load_balancer" + }, + { + "reference_type": "referral", + "resource_id": "f1aba936b94213e5b8dca0c0dbf1f9cc", + "resource_name": "Login page monitor", + "resource_type": "monitor" + } + ], + "items": { + "properties": { + "reference_type": { "enum": ["*", "referral", "referrer"], "type": "string" }, + "resource_id": { "type": "string" }, + "resource_name": { "type": "string" }, + "resource_type": { "type": "string" } + }, + "type": "object" + }, + "type": "array" + } + } + } + ] + }, + "schemas-request_model": { + "properties": { + "scope": { "$ref": "#/components/schemas/scope-6kSZmzRz" }, + "type": { "$ref": "#/components/schemas/url_normalization_components-schemas-type" } + }, + "type": "object" + }, + "schemas-requests": { + "description": "Breakdown of totals for requests.", + "properties": { + "all": { "description": "Total number of requests served.", "type": "integer" }, + "cached": { "description": "Total number of cached requests served.", "type": "integer" }, + "content_type": { + "description": "A variable list of key/value pairs where the key represents the type of content served, and the value is the number of requests.", + "example": { "css": 15343, "gif": 23178, "html": 1234213, "javascript": 318236, "jpeg": 1982048 }, + "type": "object" + }, + "country": { + "description": "A variable list of key/value pairs where the key is a two-digit country code and the value is the number of requests served to that country.", + "example": { "AG": 37298, "GI": 293846, "US": 4181364 }, + "type": "object" + }, + "http_status": { + "additionalProperties": true, + "description": "Key/value pairs where the key is a HTTP status code and the value is the number of requests served with that code.", + "example": { "200": 13496983, "301": 283, "400": 187936, "402": 1828, "404": 1293 }, + "type": "object" + }, + "ssl": { + "description": "A break down of requests served over HTTPS.", + "properties": { + "encrypted": { "description": "The number of requests served over HTTPS.", "type": "integer" }, + "unencrypted": { "description": "The number of requests served over HTTP.", "type": "integer" } + }, + "type": "object" + }, + "ssl_protocols": { + "description": "A breakdown of requests by their SSL protocol.", + "properties": { + "TLSv1": { "description": "The number of requests served over TLS v1.0.", "type": "integer" }, + "TLSv1.1": { "description": "The number of requests served over TLS v1.1.", "type": "integer" }, + "TLSv1.2": { "description": "The number of requests served over TLS v1.2.", "type": "integer" }, + "TLSv1.3": { "description": "The number of requests served over TLS v1.3.", "type": "integer" }, + "none": { "description": "The number of requests served over HTTP.", "type": "integer" } + }, + "type": "object" + }, + "uncached": { "description": "Total number of requests served from the origin.", "type": "integer" } + }, + "type": "object" + }, + "schemas-require": { + "description": "Rules evaluated with an AND logical operator. To match the policy, a user must meet all of the Require rules.", + "items": { "$ref": "#/components/schemas/rule" }, + "type": "array" + }, + "schemas-require-0qS7IZb9": { + "description": "Rules evaluated with an AND logical operator. To match the policy, a user must meet all of the Require rules.", + "items": { "$ref": "#/components/schemas/rule_components-schemas-rule" }, + "type": "array" + }, + "schemas-response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/ip_components-schemas-ip" }, "type": "array" } + } + } + ] + }, + "schemas-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/locations" }, "type": "array" } } } + ] + }, + "schemas-response_collection-4HEckTYK": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/groups" }, "type": "array" } } } + ] + }, + "schemas-response_collection-AREv1gR0": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/peer" }, "type": "array" } } } + ] + }, + "schemas-response_collection-CSlm0TuB": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "items": { "$ref": "#/components/schemas/device-posture-integrations-Xb3lCexZ" }, + "type": "array" + } + } + } + ] + }, + "schemas-response_collection-NmAY72Ue": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/ipam-delegations" }, "type": "array" } + } + } + ] + }, + "schemas-response_collection-PNoWMjSR": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/pool-Dw5V2rGp" }, "type": "array" } } } + ] + }, + "schemas-response_collection-gsiDzBvh": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "example": [ + { + "id": "7cf72faf220841aabcfdfab81c43c4f6", + "name": "Billing Read", + "scopes": ["com.cloudflare.api.account"] + }, + { + "id": "9d24387c6e8544e2bc4024a03991339f", + "name": "Load Balancing: Monitors and Pools Read", + "scopes": ["com.cloudflare.api.account"] + }, + { + "id": "d2a1802cc9a34e30852f8b33869b2f3c", + "name": "Load Balancing: Monitors and Pools Write", + "scopes": ["com.cloudflare.api.account"] + }, + { + "id": "8b47d2786a534c08a1f94ee8f9f599ef", + "name": "Workers KV Storage Read", + "scopes": ["com.cloudflare.api.account"] + }, + { + "id": "f7f0eda5697f475c90846e879bab8666", + "name": "Workers KV Storage Write", + "scopes": ["com.cloudflare.api.account"] + }, + { + "id": "1a71c399035b4950a1bd1466bbe4f420", + "name": "Workers Scripts Read", + "scopes": ["com.cloudflare.api.account"] + }, + { + "id": "e086da7e2179491d91ee5f35b3ca210a", + "name": "Workers Scripts Write", + "scopes": ["com.cloudflare.api.account"] + } + ], + "items": { "type": "object" }, + "type": "array" + } + }, + "type": "object" + } + ] + }, + "schemas-response_model": { + "properties": { + "scope": { "$ref": "#/components/schemas/scope-6kSZmzRz" }, + "type": { "$ref": "#/components/schemas/url_normalization_components-schemas-type" } + }, + "type": "object" + }, + "schemas-response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } }, "type": "object" } + ] + }, + "schemas-result": { + "allOf": [ + { "$ref": "#/components/schemas/result-iSgQlUWZ" }, + { + "properties": { + "data": { + "example": [ + { + "metrics": [ + [2, 4], + [16, 32] + ] + } + ] + }, + "max": { "example": { "readKiB": 32, "requests": 4 } }, + "min": { "example": { "readKiB": 16, "requests": 2 } }, + "query": { "$ref": "#/components/schemas/query-ju6G02HL" }, + "totals": { "example": { "readKiB": 48, "requests": 6 } } + } + } + ] + }, + "schemas-role": { + "properties": { + "description": { "$ref": "#/components/schemas/description-gV3mXO2g" }, + "id": { "$ref": "#/components/schemas/role_components-schemas-identifier" }, + "name": { "$ref": "#/components/schemas/components-schemas-name-l3W5RvJP" }, + "permissions": { "$ref": "#/components/schemas/schemas-permissions" } + }, + "required": ["id", "name", "description", "permissions"], + "type": "object" + }, + "schemas-rule": { + "allOf": [ + { "$ref": "#/components/schemas/rule-VtwDyToZ" }, + { + "properties": { + "scope": { + "description": "All zones owned by the user will have the rule applied.", + "properties": { + "email": { "$ref": "#/components/schemas/email-sNyq81Xd" }, + "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" }, + "type": { + "description": "The scope of the rule.", + "enum": ["user", "organization"], + "example": "user", + "readOnly": true + } + }, + "readOnly": true, + "type": "object" + } + } + } + ], + "required": ["id", "mode", "allowed_modes", "configuration", "scope"], + "type": "object" + }, + "schemas-rules": { + "description": "The list of rules in the ruleset.", + "items": { "$ref": "#/components/schemas/rules_components-schemas-rule" }, + "type": "array" + }, + "schemas-ruleset": { + "properties": { + "description": { "example": "" }, + "id": { "example": "2f2feab2026849078ba485f918791bdc" }, + "kind": { "example": "zone" }, + "name": { "example": "default" }, + "phase": { "example": "http_request_origin" }, + "rules": { + "description": "The rules in the ruleset.", + "items": { "$ref": "#/components/schemas/origin-rules_components-schemas-rule" }, + "type": "array" + } + } + }, + "schemas-saml": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-identity-provider" }, + { + "properties": { + "config": { + "properties": { + "attributes": { + "description": "A list of SAML attribute names that will be added to your signed JWT token and can be used in SAML policy rules.", + "example": ["group", "department_code", "divison"], + "items": { "type": "string" }, + "type": "array" + }, + "email_attribute_name": { + "description": "The attribute name for email in the SAML response.", + "example": "Email", + "type": "string" + }, + "header_attributes": { + "description": "Add a list of attribute names that will be returned in the response header from the Access callback.", + "items": { + "properties": { + "attribute_name": { "description": "attribute name from the IDP", "type": "string" }, + "header_name": { + "description": "header that will be added on the request to the origin", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "idp_public_certs": { + "description": "X509 certificate to verify the signature in the SAML authentication response", + "items": { "type": "string" }, + "type": "array" + }, + "issuer_url": { + "description": "IdP Entity ID or Issuer URL", + "example": "https://whoami.com", + "type": "string" + }, + "sign_request": { + "description": "Sign the SAML authentication request with Access credentials. To verify the signature, use the public key from the Access certs endpoints.", + "type": "boolean" + }, + "sso_target_url": { + "description": "URL to send the SAML authentication requests to", + "example": "https://edgeaccess.org/idp/saml/login", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + } + ], + "title": "Generic SAML", + "type": "object" + }, + "schemas-script_name": { + "description": "Name of the script to apply when the route is matched. The route is skipped when this is blank/missing.", + "example": "this-is_my_script-01", + "pattern": "^[a-z0-9_][a-z0-9-_]*$", + "type": "string" + }, + "schemas-self_hosted_props": { + "properties": { + "allowed_idps": { "$ref": "#/components/schemas/allowed_idps" }, + "app_launcher_visible": { "$ref": "#/components/schemas/app_launcher_visible" }, + "auto_redirect_to_identity": { "$ref": "#/components/schemas/schemas-auto_redirect_to_identity" }, + "cors_headers": { "$ref": "#/components/schemas/cors_headers" }, + "custom_deny_message": { "$ref": "#/components/schemas/custom_deny_message" }, + "custom_deny_url": { "$ref": "#/components/schemas/custom_deny_url" }, + "domain": { "$ref": "#/components/schemas/domain" }, + "enable_binding_cookie": { "$ref": "#/components/schemas/enable_binding_cookie" }, + "http_only_cookie_attribute": { "$ref": "#/components/schemas/http_only_cookie_attribute" }, + "logo_url": { "$ref": "#/components/schemas/logo_url" }, + "name": { "$ref": "#/components/schemas/apps_components-schemas-name" }, + "same_site_cookie_attribute": { "$ref": "#/components/schemas/same_site_cookie_attribute" }, + "service_auth_401_redirect": { "$ref": "#/components/schemas/service_auth_401_redirect" }, + "session_duration": { "$ref": "#/components/schemas/session_duration-itWcJrO0" }, + "skip_interstitial": { "$ref": "#/components/schemas/skip_interstitial" }, + "type": { "description": "The application type.", "example": "self_hosted", "type": "string" } + }, + "required": ["type", "domain"], + "title": "Self Hosted Application", + "type": "object" + }, + "schemas-serial_number": { + "description": "The certificate serial number.", + "example": "235217144297995885180570755458463043449861756659", + "readOnly": true, + "type": "string" + }, + "schemas-service": { + "description": "Worker service associated with the zone and hostname.", + "example": "foo", + "type": "string" + }, + "schemas-signature": { + "description": "Certificate's signature algorithm.", + "enum": ["ECDSAWithSHA256", "SHA1WithRSA", "SHA256WithRSA"], + "type": "string" + }, + "schemas-single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/locations" } } } + ] + }, + "schemas-single_response-CwUTnlnC": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/identity-providers" } } } + ] + }, + "schemas-single_response-PJU34P3b": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/peer" } } } + ] + }, + "schemas-single_response-aU3syxnr": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/device-posture-integrations-Xb3lCexZ" } } } + ] + }, + "schemas-single_response-h7shsYQI": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/api-shield" } } } + ] + }, + "schemas-single_response-uzr0CVkk": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/pool-Dw5V2rGp" } } } + ] + }, + "schemas-single_response-xdmRbZer": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/ipam-delegations" } } } + ] + }, + "schemas-ssh_props": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-self_hosted_props" }, + { "properties": { "type": { "description": "The application type.", "example": "ssh", "type": "string" } } } + ] + }, + "schemas-state": { + "description": "The custom page state.", + "enum": ["default", "customized"], + "example": "default", + "type": "string" + }, + "schemas-status": { + "description": "Status of the Keyless SSL.", + "enum": ["active", "deleted"], + "example": "active", + "readOnly": true, + "type": "string" + }, + "schemas-status-uJZPVtIE": { + "description": "Status of this membership.", + "enum": ["accepted", "pending", "rejected"], + "example": "accepted", + "type": "string" + }, + "schemas-subdomain": { + "description": "The subdomain to be used as the destination in the proxy client.", + "example": "oli3n9zkz5.proxy.cloudflare-gateway.com", + "type": "string" + }, + "schemas-target": { + "description": "Target gateway of the hostname.", + "enum": ["ethereum", "ipfs", "ipfs_universal_path", "polygon"], + "example": "ipfs", + "type": "string" + }, + "schemas-timeout": { + "default": 5, + "description": "The timeout (in seconds) before marking the health check as failed.", + "type": "integer" + }, + "schemas-token": { "allOf": [{ "$ref": "#/components/schemas/token" }] }, + "schemas-tunnel_add_single_request": { + "properties": { + "cloudflare_endpoint": { "$ref": "#/components/schemas/cloudflare_ipsec_endpoint" }, + "customer_endpoint": { "$ref": "#/components/schemas/customer_ipsec_endpoint" }, + "description": { "$ref": "#/components/schemas/components-schemas-description-EJnoLTyB" }, + "interface_address": { "$ref": "#/components/schemas/interface_address" }, + "name": { "$ref": "#/components/schemas/schemas-name-m2fEJLlJ" }, + "psk": { "$ref": "#/components/schemas/psk" } + }, + "required": ["name", "cloudflare_endpoint", "interface_address"], + "type": "object" + }, + "schemas-tunnel_deleted_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "deleted": { "example": true, "type": "boolean" }, + "deleted_ipsec_tunnel": { "type": "object" } + } + } + } + } + ] + }, + "schemas-tunnel_id": { "description": "UUID of the Cloudflare Tunnel serving the route." }, + "schemas-tunnel_modified_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "modified": { "example": true, "type": "boolean" }, + "modified_ipsec_tunnel": { "type": "object" } + } + } + } + } + ] + }, + "schemas-tunnel_name": { "description": "The user-friendly name of the Cloudflare Tunnel serving the route." }, + "schemas-tunnel_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { "result": { "items": { "$ref": "#/components/schemas/tunnel" }, "type": "array" } }, + "type": "object" + } + ] + }, + "schemas-tunnel_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/tunnel" } }, "type": "object" } + ] + }, + "schemas-tunnel_single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "properties": { "ipsec_tunnel": { "type": "object" } } } } } + ] + }, + "schemas-tunnel_update_request": { + "allOf": [{ "$ref": "#/components/schemas/schemas-tunnel_add_single_request" }] + }, + "schemas-tunnels_collection_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "ipsec_tunnels": { "items": { "$ref": "#/components/schemas/ipsec-tunnel" }, "type": "array" } + } + } + } + } + ] + }, + "schemas-type": { + "description": "The type of characteristic.", + "enum": ["header", "cookie"], + "example": "header", + "type": "string" + }, + "schemas-type-BQBcyQpN": { + "description": "The type of Device Posture Integration.", + "enum": ["workspace_one", "crowdstrike_s2s", "uptycs", "intune", "kolide"], + "example": "workspace_one", + "type": "string" + }, + "schemas-until": { + "description": "End of time interval to query, defaults to current time. Timestamp must be in RFC3339 format and uses UTC unless otherwise specified.", + "example": "2014-01-02T03:20:00Z", + "format": "date-time", + "type": "string" + }, + "schemas-updated_at": { + "description": "This is the time the certificate was updated.", + "example": "2022-11-22T17:32:30.467938Z", + "format": "date-time", + "type": "string" + }, + "schemas-uploaded_on": { + "description": "This is the time the certificate was uploaded.", + "example": "2019-10-28T18:11:23.37411Z", + "format": "date-time", + "type": "string" + }, + "schemas-url": { + "description": "The URL pattern to match, composed of a host and a path such as `example.org/path*`. Normalization is applied before the pattern is matched. `*` wildcards are expanded to match applicable traffic. Query strings are not matched. Set the value to `*` to match all traffic to your zone.", + "example": "*.example.org/path*", + "maxLength": 1024, + "type": "string" + }, + "schemas-urls": { + "description": "The URLs to include in the rule definition. You can use wildcards. Each entered URL will be escaped before use, which means you can only use simple wildcard patterns.", + "items": { "example": "api.mysite.com/some/endpoint*", "type": "string" }, + "type": "array" + }, + "schemas-uuid": { "example": "ed35569b41ce4d1facfe683550f54086" }, + "schemas-uuid-JmfIpL8C": { "description": "The unique identifier for the Access group." }, + "schemas-uuid-lt6l49Ob": { + "description": "Device ID.", + "example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", + "maxLength": 36, + "type": "string" + }, + "schemas-uuid-vgvRNXQL": { "description": "The unique identifier for the Access group." }, + "schemas-validation_method": { + "description": "Validation method in use for a certificate pack order.", + "enum": ["http", "cname", "txt"], + "example": "txt", + "type": "string" + }, + "schemas-validity_days": { + "description": "The validity period in days for the certificates ordered via Total TLS.", + "enum": [90], + "type": "integer" + }, + "schemas-value": { + "description": "Enables Argo Smart Routing.", + "enum": ["on", "off"], + "example": "on", + "type": "string" + }, + "schemas-variants": { + "description": "Object specifying available variants for an image.", + "example": [ + "https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/thumbnail", + "https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/hero", + "https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/original" + ], + "items": { + "anyOf": [ + { "$ref": "#/components/schemas/thumbnail_url" }, + { "$ref": "#/components/schemas/hero_url" }, + { "$ref": "#/components/schemas/original_url" } + ] + }, + "readOnly": true, + "type": "array" + }, + "schemas-version": { + "description": "The version of the rule.", + "example": "1", + "pattern": "^[0-9]+$", + "type": "string" + }, + "schemas-virtual_network_id": { + "description": "UUID of the Tunnel Virtual Network this route belongs to. If no virtual networks are configured, the route is assigned to the default virtual network of the account." + }, + "schemas-vnc_props": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-self_hosted_props" }, + { "properties": { "type": { "description": "The application type.", "example": "vnc", "type": "string" } } } + ] + }, + "schemas-yandex": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-identity-provider" }, + { "properties": { "config": { "$ref": "#/components/schemas/generic-oauth-config" } }, "type": "object" } + ], + "title": "Yandex", + "type": "object" + }, + "schemas-zone": { "properties": { "name": { "readOnly": true } }, "type": "object" }, + "schemes": { + "description": "The HTTP schemes to match. You can specify one scheme (`['HTTPS']`), both schemes (`['HTTP','HTTPS']`), or all schemes (`['_ALL_']`). This field is optional.", + "example": ["HTTP", "HTTPS"], + "items": { + "description": "An HTTP scheme or `_ALL_` to indicate all schemes.", + "example": "HTTPS", + "type": "string" + }, + "type": "array" + }, + "scope": { + "description": "Used only for ECMP routes.", + "properties": { + "colo_names": { "$ref": "#/components/schemas/colo_names" }, + "colo_regions": { "$ref": "#/components/schemas/colo_regions" } + }, + "type": "object" + }, + "scope-6kSZmzRz": { + "description": "The scope of the URL normalization.", + "example": "incoming", + "type": "string" + }, + "script": { + "properties": { + "added_at": { "example": "2021-08-18T10:51:10.09615Z" }, + "domain_reported_malicious": { "example": false }, + "fetched_at": { "example": "2021-09-02T10:17:54Z" }, + "first_page_url": { "example": "blog.cloudflare.com/page" }, + "first_seen_at": { "example": "2021-08-18T10:51:08Z" }, + "hash": { "example": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" }, + "host": { "example": "blog.cloudflare.com" }, + "id": { "example": "c9ef84a6bf5e47138c75d95e2f933e8f" }, + "js_integrity_score": { "example": 10 }, + "last_seen_at": { "example": "2021-09-02T09:57:54Z" }, + "page_urls": { "example": ["blog.cloudflare.com/page1", "blog.cloudflare.com/page2"] }, + "url": { "example": "https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.0/js/bootstrap.min.js" }, + "url_contains_cdn_cgi_path": { "example": false } + } + }, + "script-response": { + "properties": { + "created_on": { "$ref": "#/components/schemas/created_on-tz4RTlxL" }, + "etag": { "$ref": "#/components/schemas/etag" }, + "id": { + "description": "The id of the script in the Workers system. Usually the script name.", + "example": "my-workers-script", + "readOnly": true, + "type": "string" + }, + "logpush": { "$ref": "#/components/schemas/logpush" }, + "modified_on": { "$ref": "#/components/schemas/modified_on-6lsEa3Mx" }, + "usage_model": { "$ref": "#/components/schemas/usage_model" } + } + }, + "script-response-collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { + "properties": { "result": { "items": { "$ref": "#/components/schemas/script-response" }, "type": "array" } } + } + ] + }, + "script-response-collection-rhW1Gmt4": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { + "properties": { + "result": { + "items": { + "properties": { + "created_on": { "readOnly": true }, + "etag": { "readOnly": true }, + "id": { "readOnly": true }, + "modified_on": { "readOnly": true }, + "usage_model": { "readOnly": true } + } + }, + "type": "array" + } + } + } + ] + }, + "script-response-single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { "result": { "$ref": "#/components/schemas/script-response" } }, + "x-cfLinkErrors": { + "10001": "Unsupported or unexpected Content Type", + "10002": "Unexpected internal server error", + "10003": "Missing required URL parameter", + "10004": "Malformed URL parameter", + "10006": "Unparseable script body", + "10007": "Resource not found (similar to HTTP 404)", + "10014": "Internal error while attempting authorization checks", + "10015": "The current account is not authorized to use workers", + "10018": "Attempted to update a script where the e-tag does not match", + "10021": "Script content failed validation checks, but was otherwise parseable", + "10023": "Unauthorized access attempt", + "10027": "Script body was too large", + "10075": "Requires a Workers Paid plan" + } + } + ] + }, + "script-response-single-qkojssqp": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } } } + ] + }, + "script_identifier": { + "example": "8ee82b3a2c0f42928b8f14dae4a97121", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "script_name": { + "description": "Name of the script, used in URLs and route configuration.", + "example": "this-is_my_script-01", + "pattern": "^[a-z0-9_][a-z0-9-_]*$", + "type": "string" + }, + "search": { + "properties": { + "resources": { + "description": "A list of resources matching the search query.", + "items": { "$ref": "#/components/schemas/resource_reference" }, + "type": "array" + } + }, + "type": "object" + }, + "search_params": { + "properties": { + "query": { "default": "", "description": "Search query term.", "example": "primary", "type": "string" }, + "references": { + "default": "", + "description": "The type of references to include (\"*\" for all).", + "enum": ["", "*", "referral", "referrer"], + "example": "*", + "type": "string" + } + }, + "type": "object" + }, + "search_result": { "properties": { "result": { "$ref": "#/components/schemas/search" } }, "type": "object" }, + "seat": { + "properties": { + "access_seat": { "$ref": "#/components/schemas/access_seat" }, + "gateway_seat": { "$ref": "#/components/schemas/gateway_seat" }, + "seat_uid": { "$ref": "#/components/schemas/seat_uid" } + }, + "required": ["seat_uid", "gateway_seat", "access_seat"], + "type": "object" + }, + "seat_uid": { "description": "The unique API identifier for the Zero Trust seat." }, + "seats": { + "properties": { + "access_seat": { "$ref": "#/components/schemas/access_seat" }, + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "gateway_seat": { "$ref": "#/components/schemas/gateway_seat" }, + "seat_uid": { "$ref": "#/components/schemas/seat_uid" }, + "updated_at": { "$ref": "#/components/schemas/timestamp" } + }, + "type": "object" + }, + "seats_components-schemas-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/seats" }, "type": "array" } } } + ] + }, + "seats_definition": { + "items": { "$ref": "#/components/schemas/seat" }, + "required": ["seat_uid", "gateway_seat", "access_seat"], + "type": "array" + }, + "secret": { + "description": "TSIG secret.", + "example": "caf79a7804b04337c9c66ccd7bef9190a1e1679b5dd03d8aa10f7ad45e1a9dab92b417896c15d4d007c7c14194538d2a5d0feffdecc5a7f0e1c570cfa700837c", + "type": "string" + }, + "secret-QjCIBSp3": { + "description": "Optional secret that will be passed in the `cf-webhook-auth` header when dispatching a webhook notification. Secrets are not returned in any API response body.", + "type": "string" + }, + "security_header": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { + "description": "ID of the zone's security header.", + "enum": ["security_header"], + "example": "security_header" + }, + "value": { "$ref": "#/components/schemas/security_header_value" } + } + } + ], + "description": "Cloudflare security header for a zone.", + "title": "Security Header" + }, + "security_header_value": { + "properties": { + "strict_transport_security": { + "description": "Strict Transport Security.", + "properties": { + "enabled": { + "description": "Whether or not strict transport security is enabled.", + "example": true, + "type": "boolean" + }, + "include_subdomains": { + "description": "Include all subdomains for strict transport security.", + "example": true, + "type": "boolean" + }, + "max_age": { + "description": "Max age in seconds of the strict transport security.", + "example": 86400, + "type": "number" + }, + "nosniff": { + "description": "Whether or not to include 'X-Content-Type-Options: nosniff' header.", + "example": true, + "type": "boolean" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "security_level": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { + "description": "ID of the zone setting.", + "enum": ["security_level"], + "example": "security_level" + }, + "value": { "$ref": "#/components/schemas/security_level_value" } + } + } + ], + "description": "Choose the appropriate security profile for your website, which will automatically adjust each of the security settings. If you choose to customize an individual security setting, the profile will become Custom. (https://support.cloudflare.com/hc/en-us/articles/200170056).", + "title": "Security Level" + }, + "security_level_value": { + "default": "medium", + "description": "Value of the zone setting.", + "enum": ["off", "essentially_off", "low", "medium", "high", "under_attack"], + "type": "string" + }, + "self_hosted_props": { + "properties": { + "allowed_idps": { "$ref": "#/components/schemas/allowed_idps" }, + "app_launcher_visible": { "$ref": "#/components/schemas/app_launcher_visible" }, + "auto_redirect_to_identity": { "$ref": "#/components/schemas/schemas-auto_redirect_to_identity" }, + "cors_headers": { "$ref": "#/components/schemas/cors_headers" }, + "custom_deny_message": { "$ref": "#/components/schemas/custom_deny_message" }, + "custom_deny_url": { "$ref": "#/components/schemas/custom_deny_url" }, + "domain": { "$ref": "#/components/schemas/domain" }, + "enable_binding_cookie": { "$ref": "#/components/schemas/enable_binding_cookie" }, + "http_only_cookie_attribute": { "$ref": "#/components/schemas/http_only_cookie_attribute" }, + "logo_url": { "$ref": "#/components/schemas/logo_url" }, + "name": { "$ref": "#/components/schemas/apps_components-schemas-name" }, + "path_cookie_attribute": { "$ref": "#/components/schemas/path_cookie_attribute" }, + "same_site_cookie_attribute": { "$ref": "#/components/schemas/same_site_cookie_attribute" }, + "service_auth_401_redirect": { "$ref": "#/components/schemas/service_auth_401_redirect" }, + "session_duration": { "$ref": "#/components/schemas/session_duration-itWcJrO0" }, + "skip_interstitial": { "$ref": "#/components/schemas/skip_interstitial" }, + "type": { "description": "The application type.", "example": "self_hosted", "type": "string" } + }, + "required": ["type", "domain"], + "title": "Self Hosted Application", + "type": "object" + }, + "self_hosted_props-pFu7lQyL": { + "properties": { + "allowed_idps": { "$ref": "#/components/schemas/allowed_idps" }, + "app_launcher_visible": { "$ref": "#/components/schemas/app_launcher_visible" }, + "auto_redirect_to_identity": { "$ref": "#/components/schemas/auto_redirect_to_identity-zRTYoQOC" }, + "cors_headers": { "$ref": "#/components/schemas/cors_headers" }, + "custom_deny_message": { "$ref": "#/components/schemas/custom_deny_message" }, + "custom_deny_url": { "$ref": "#/components/schemas/custom_deny_url" }, + "domain": { "$ref": "#/components/schemas/schemas-domain-N8byIUtr" }, + "enable_binding_cookie": { "$ref": "#/components/schemas/enable_binding_cookie" }, + "http_only_cookie_attribute": { "$ref": "#/components/schemas/http_only_cookie_attribute" }, + "logo_url": { "$ref": "#/components/schemas/logo_url" }, + "name": { "$ref": "#/components/schemas/apps_components-schemas-name" }, + "same_site_cookie_attribute": { "$ref": "#/components/schemas/same_site_cookie_attribute" }, + "service_auth_401_redirect": { "$ref": "#/components/schemas/service_auth_401_redirect" }, + "session_duration": { "$ref": "#/components/schemas/session_duration-ZxG3i84k" }, + "skip_interstitial": { "$ref": "#/components/schemas/skip_interstitial" }, + "type": { "description": "The application type.", "example": "self_hosted", "type": "string" } + }, + "title": "Self Hosted Application", + "type": "object" + }, + "sensitivity": { + "default": "high", + "description": "The sensitivity of the WAF package.", + "enum": ["high", "medium", "low", "off"], + "type": "string" + }, + "sent": { + "description": "Timestamp of when the notification was dispatched in ISO 8601 format.", + "example": "2021-10-08T17:52:17.571336Z", + "format": "date-time", + "type": "string" + }, + "serial_number": { + "description": "The serial number on the uploaded certificate.", + "example": "6743787633689793699141714808227354901", + "type": "string" + }, + "serial_number-8kzQvaWX": { + "description": "The device serial number.", + "example": "EXAMPLEHMD6R", + "type": "string" + }, + "server_side_exclude": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { + "description": "ID of the zone setting.", + "enum": ["server_side_exclude"], + "example": "server_side_exclude" + }, + "value": { "$ref": "#/components/schemas/server_side_exclude_value" } + } + } + ], + "description": "If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: \u003c!--sse--\u003e\u003c!--/sse--\u003e. For example: \u003c!--sse--\u003e Bad visitors won't see my phone number, 555-555-5555 \u003c!--/sse--\u003e. Note: SSE only will work with HTML. If you have HTML minification enabled, you won't see the SSE tags in your HTML source when it's served through Cloudflare. SSE will still function in this case, as Cloudflare's HTML minification and SSE functionality occur on-the-fly as the resource moves through our network to the visitor's computer. (https://support.cloudflare.com/hc/en-us/articles/200170036).", + "title": "Server Side Exclude" + }, + "server_side_exclude_value": { + "default": "on", + "description": "Value of the zone setting.", + "enum": ["on", "off"], + "type": "string" + }, + "service": { "description": "The service using the certificate.", "example": "gateway", "type": "string" }, + "service-tokens": { + "properties": { + "client_id": { "$ref": "#/components/schemas/client_id" }, + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "id": { "description": "The ID of the service token." }, + "name": { "$ref": "#/components/schemas/service-tokens_components-schemas-name" }, + "updated_at": { "$ref": "#/components/schemas/timestamp" } + }, + "type": "object" + }, + "service-tokens_components-schemas-name": { + "description": "The name of the service token.", + "example": "CI/CD token", + "type": "string" + }, + "service-tokens_components-schemas-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { "result": { "items": { "$ref": "#/components/schemas/service-tokens" }, "type": "array" } } + } + ] + }, + "service-tokens_components-schemas-single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/service-tokens" } } } + ] + }, + "service_auth_401_redirect": { + "description": "Returns a 401 status code when the request is blocked by a Service Auth policy.", + "example": true, + "type": "boolean" + }, + "service_mode_v2": { + "properties": { + "mode": { "description": "The mode to run the WARP client under.", "example": "proxy", "type": "string" }, + "port": { "description": "The port number when used with proxy mode.", "example": 3000, "type": "number" } + }, + "type": "object" + }, + "session_affinity": { + "default": "\"\"", + "description": "The session_affinity specifies the type of session affinity the load balancer should use unless specified as \"none\" or \"\"(default). The supported types are \"cookie\" and \"ip_cookie\". \"cookie\" - On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy then a new origin server is calculated and used. \"ip_cookie\" behaves the same as \"cookie\" except the initial origin selection is stable and based on the client’s ip address.", + "enum": ["none", "cookie", "ip_cookie", "\"\""], + "example": "cookie", + "type": "string" + }, + "session_affinity_attributes": { + "description": "Configures cookie attributes for session affinity cookie.", + "properties": { + "drain_duration": { + "description": "Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer.", + "example": 100, + "type": "number" + }, + "samesite": { + "default": "Auto", + "description": "Configures the SameSite attribute on session affinity cookie. Value \"Auto\" will be translated to \"Lax\" or \"None\" depending if Always Use HTTPS is enabled. Note: when using value \"None\", the secure attribute can not be set to \"Never\".", + "enum": ["Auto", "Lax", "None", "Strict"], + "example": "Auto", + "type": "string" + }, + "secure": { + "default": "Auto", + "description": "Configures the Secure attribute on session affinity cookie. Value \"Always\" indicates the Secure attribute will be set in the Set-Cookie header, \"Never\" indicates the Secure attribute will not be set, and \"Auto\" will set the Secure attribute depending if Always Use HTTPS is enabled.", + "enum": ["Auto", "Always", "Never"], + "example": "Auto", + "type": "string" + }, + "zero_downtime_failover": { + "default": "none", + "description": "Configures the zero-downtime failover between origins within a pool when session affinity is enabled. Value \"none\" means no failover takes place for sessions pinned to the origin (default). Value \"temporary\" means traffic will be sent to another other healthy origin until the originally pinned origin is available; note that this can potentially result in heavy origin flapping. Value \"sticky\" means the session affinity cookie is updated and subsequent requests are sent to the new origin. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance.", + "enum": ["none", "temporary", "sticky"], + "example": "sticky", + "type": "string" + } + }, + "type": "object" + }, + "session_affinity_ttl": { + "description": "Time, in seconds, until this load balancer's session affinity cookie expires after being created. This parameter is ignored unless a supported session affinity policy is set. The current default of 23 hours will be used unless session_affinity_ttl is explicitly set. The accepted range of values is between [1800, 604800]. Once the expiry time has been reached, subsequent requests may get sent to a different origin server.", + "example": 5000, + "type": "number" + }, + "session_duration": { + "default": 5, + "description": "Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. If a user is not seen by Cloudflare again in that time period, they will be treated as a new user that visits the route.", + "maximum": 30, + "minimum": 1, + "type": "integer" + }, + "session_duration-ZxG3i84k": { + "default": "24h", + "description": "The amount of time that tokens issued for this application will be valid. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h.", + "example": "24h", + "type": "string" + }, + "session_duration-itWcJrO0": { + "default": "24h", + "description": "The amount of time that tokens issued for this application will be valid. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h.", + "example": "24h", + "type": "string" + }, + "session_id": { + "description": "Unique session id of the job.", + "example": "99d471b1ca3c23cc8e30b6acec5db987", + "type": "string" + }, + "setting": { + "oneOf": [ + { "$ref": "#/components/schemas/0rtt" }, + { "$ref": "#/components/schemas/advanced_ddos" }, + { "$ref": "#/components/schemas/always_online" }, + { "$ref": "#/components/schemas/always_use_https" }, + { "$ref": "#/components/schemas/automatic_https_rewrites" }, + { "$ref": "#/components/schemas/brotli" }, + { "$ref": "#/components/schemas/browser_cache_ttl" }, + { "$ref": "#/components/schemas/browser_check" }, + { "$ref": "#/components/schemas/cache_level" }, + { "$ref": "#/components/schemas/challenge_ttl" }, + { "$ref": "#/components/schemas/ciphers" }, + { "$ref": "#/components/schemas/cname_flattening" }, + { "$ref": "#/components/schemas/development_mode" }, + { "$ref": "#/components/schemas/early_hints" }, + { "$ref": "#/components/schemas/edge_cache_ttl" }, + { "$ref": "#/components/schemas/email_obfuscation" }, + { "$ref": "#/components/schemas/h2_prioritization" }, + { "$ref": "#/components/schemas/hotlink_protection" }, + { "$ref": "#/components/schemas/http2" }, + { "$ref": "#/components/schemas/http3" }, + { "$ref": "#/components/schemas/image_resizing" }, + { "$ref": "#/components/schemas/ip_geolocation" }, + { "$ref": "#/components/schemas/ipv6" }, + { "$ref": "#/components/schemas/max_upload" }, + { "$ref": "#/components/schemas/min_tls_version" }, + { "$ref": "#/components/schemas/minify" }, + { "$ref": "#/components/schemas/mirage" }, + { "$ref": "#/components/schemas/mobile_redirect" }, + { "$ref": "#/components/schemas/nel" }, + { "$ref": "#/components/schemas/opportunistic_encryption" }, + { "$ref": "#/components/schemas/opportunistic_onion" }, + { "$ref": "#/components/schemas/orange_to_orange" }, + { "$ref": "#/components/schemas/origin_error_page_pass_thru" }, + { "$ref": "#/components/schemas/origin_max_http_version" }, + { "$ref": "#/components/schemas/polish" }, + { "$ref": "#/components/schemas/prefetch_preload" }, + { "$ref": "#/components/schemas/privacy_pass" }, + { "$ref": "#/components/schemas/proxy_read_timeout" }, + { "$ref": "#/components/schemas/pseudo_ipv4" }, + { "$ref": "#/components/schemas/response_buffering" }, + { "$ref": "#/components/schemas/rocket_loader" }, + { "$ref": "#/components/schemas/schemas-automatic_platform_optimization" }, + { "$ref": "#/components/schemas/security_header" }, + { "$ref": "#/components/schemas/security_level" }, + { "$ref": "#/components/schemas/server_side_exclude" }, + { "$ref": "#/components/schemas/sha1_support" }, + { "$ref": "#/components/schemas/sort_query_string_for_cache" }, + { "$ref": "#/components/schemas/ssl" }, + { "$ref": "#/components/schemas/ssl_recommender" }, + { "$ref": "#/components/schemas/tls_1_2_only" }, + { "$ref": "#/components/schemas/tls_1_3" }, + { "$ref": "#/components/schemas/tls_client_auth" }, + { "$ref": "#/components/schemas/true_client_ip_header" }, + { "$ref": "#/components/schemas/waf" }, + { "$ref": "#/components/schemas/webp" }, + { "$ref": "#/components/schemas/websockets" } + ], + "type": "object" + }, + "settings": { + "description": "Settings available for the zone.", + "example": [ + { "id": "browser_check", "properties": [{ "name": "value", "type": "toggle" }] }, + { + "id": "browser_cache_ttl", + "properties": [ + { + "max": 31536000, + "min": 1800, + "name": "value", + "suggested_values": [ + 1800, 3600, 7200, 10800, 14400, 18000, 28800, 43200, 57600, 72000, 86400, 172800, 259200, 345600, + 432000, 691200, 1382400, 2073600, 2678400, 5356800, 16070400, 31536000 + ], + "type": "range" + } + ] + }, + { "id": "browser_check", "properties": [{ "name": "value", "type": "toggle" }] }, + { + "id": "cache_key_fields", + "properties": [ + { + "name": "value", + "properties": [ + { + "allowEmpty": true, + "choices": ["include", "exclude"], + "multiple": false, + "name": "query_string", + "type": "select" + }, + { + "allowEmpty": true, + "choices": ["include", "exclude", "check_presence"], + "multiple": true, + "name": "header", + "type": "select" + }, + { "allowEmpty": false, "choices": ["resolved"], "multiple": true, "name": "host", "type": "select" }, + { + "allowEmpty": true, + "choices": ["include", "check_presence"], + "multiple": true, + "name": "cookie", + "type": "select" + }, + { + "allowEmpty": false, + "choices": ["device_type", "geo", "lang"], + "multiple": true, + "name": "user", + "type": "select" + } + ], + "type": "object" + } + ] + }, + { "id": "cache_deception_armor", "properties": [{ "name": "value", "type": "toggle" }] }, + { + "id": "cache_level", + "properties": [ + { + "choices": ["bypass", "basic", "simplified", "aggressive", "cache_everything"], + "multiple": false, + "name": "value", + "type": "select" + } + ] + }, + { "id": "cache_ttl_by_status", "properties": [{ "allowEmpty": false, "name": "value", "type": "object" }] }, + { "id": "disable_apps", "properties": [] }, + { "id": "disable_performance", "properties": [] }, + { "id": "disable_security", "properties": [] }, + { + "id": "edge_cache_ttl", + "properties": [ + { + "max": 2419200, + "min": 7200, + "name": "value", + "suggested_values": [ + 7200, 10800, 14400, 18000, 28800, 43200, 57600, 72000, 86400, 172800, 259200, 345600, 432000, 518400, + 604800, 1209600, 2419200 + ], + "type": "range" + } + ] + }, + { "id": "email_obfuscation", "properties": [{ "name": "value", "type": "toggle" }] }, + { + "id": "forwarding_url", + "properties": [ + { "choices": [301, 302], "multiple": false, "name": "status_code", "type": "choice" }, + { "name": "url", "type": "forwardingUrl" } + ] + }, + { "id": "ip_geolocation", "properties": [{ "name": "value", "type": "toggle" }] }, + { + "id": "minify", + "properties": [ + { + "allowEmpty": true, + "choices": ["html", "css", "js"], + "multiple": true, + "name": "value", + "type": "select" + } + ] + }, + { "id": "explicit_cache_control", "properties": [{ "name": "value", "type": "toggle" }] }, + { "id": "rocket_loader", "properties": [{ "name": "value", "type": "toggle" }] }, + { + "id": "security_level", + "properties": [ + { + "choices": ["essentially_off", "low", "medium", "high", "under_attack"], + "multiple": false, + "name": "value", + "type": "select" + } + ] + }, + { "id": "server_side_exclude", "properties": [{ "name": "value", "type": "toggle" }] }, + { + "id": "ssl", + "properties": [ + { "choices": ["off", "flexible", "full", "strict"], "multiple": false, "name": "value", "type": "choice" } + ] + } + ], + "items": { "type": "object" }, + "type": "array" + }, + "settings-2v3jrs7t": { + "allOf": [{ "$ref": "#/components/schemas/email-settings_properties" }], + "type": "object" + }, + "settings-s418OBZp": { + "additionalProperties": false, + "properties": { + "china_network": { + "description": "Request client certificates for this hostname in China. Can only be set to true if this zone is china network enabled.", + "example": false, + "type": "boolean" + }, + "client_certificate_forwarding": { + "description": "Client Certificate Forwarding is a feature that takes the client cert provided by the eyeball to the edge, and forwards it to the origin as a HTTP header to allow logging on the origin.", + "example": true, + "type": "boolean" + }, + "hostname": { + "description": "The hostname that these settings apply to.", + "example": "admin.example.com", + "type": "string" + } + }, + "required": ["hostname", "china_network", "client_certificate_forwarding"], + "title": "Hostname Settings", + "type": "object" + }, + "sha1_support": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { "description": "Zone setting identifier.", "enum": ["sha1_support"], "example": "sha1_support" }, + "value": { "$ref": "#/components/schemas/sha1_support_value" } + } + } + ], + "description": "Allow SHA1 support.", + "title": "Toggle SHA1 support" + }, + "sha1_support_value": { + "default": "off", + "description": "Value of the zone setting.", + "enum": ["off", "on"], + "type": "string" + }, + "shared_entry_update_integration": { + "description": "Properties of an integration entry in a custom profile", + "properties": { + "enabled": { "description": "Whether the entry is enabled or not.", "type": "boolean" }, + "entry_id": { "$ref": "#/components/schemas/entry_id" } + }, + "title": "Update integration entry", + "type": "object" + }, + "shared_entry_update_predefined": { + "description": "Properties of a predefined entry in a custom profile", + "properties": { + "enabled": { "description": "Whether the entry is enabled or not.", "example": true, "type": "boolean" }, + "entry_id": { "$ref": "#/components/schemas/entry_id" } + }, + "title": "Update predefined entry", + "type": "object" + }, + "signature": { + "description": "The type of hash used for the certificate.", + "example": "SHA256WithRSA", + "readOnly": true, + "type": "string" + }, + "signed_token_request": { + "properties": { + "accessRules": { + "description": "The optional list of access rule constraints on the token. Access can be blocked or allowed based on an IP, IP range, or by country. Access rules are evaluated from first to last. If a rule matches, the associated action is applied and no further rules are evaluated.", + "example": [ + { "action": "block", "country": ["US", "MX"], "type": "ip.geoip.country" }, + { "action": "allow", "ip": ["93.184.216.0/24", "2400:cb00::/32"], "type": "ip.src" }, + { "action": "block", "type": "any" } + ], + "items": { "$ref": "#/components/schemas/accessRules" }, + "readOnly": true, + "type": "array" + }, + "downloadable": { + "default": false, + "description": "The optional boolean value that enables using signed tokens to access MP4 download links for a video.", + "readOnly": true, + "type": "boolean" + }, + "exp": { + "description": "The optional unix epoch timestamp that specficies the time after a token is not accepted. The maximum time specification is 24 hours from issuing time. If this field is not set, the default is one hour after issuing.", + "readOnly": true, + "type": "integer" + }, + "id": { + "description": "The optional ID of a Stream signing key. If present, the `pem` field is also required.", + "example": "ab0d4ef71g4425f8dcba9041231813000", + "readOnly": true, + "type": "string" + }, + "nbf": { + "description": "The optional unix epoch timestamp that specifies the time before a the token is not accepted. If this field is not set, the default is one hour before issuing.", + "readOnly": true, + "type": "integer" + }, + "pem": { + "description": "The optional base64 encoded private key in PEM format associated with a Stream signing key. If present, the `id` field is also required.", + "example": "LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQpNSUlFcEFJQkFBS0NBUUVBc284dnBvOFpEWXRkOUgzbWlPaW1qYXAzVXlVM0oyZ3kwTUYvN1R4blJuRnkwRHpDCkxqUk9naFZsQ0hPQmxsd3NVaE9GU0lyYnN4K05tUTdBeS90TFpXSGxuVGF3UWJ5WGZGOStJeDhVSnNlSHBGV1oKNVF5Z1JYd2liSjh1MVVsZ2xlcmZHMkpueldjVXpZTzEySktZN3doSkw1ajROMWgxZFJNUXQ5Q1pkZFlCQWRzOQpCdk02cjRFMDcxQkhQekhWeDMrUTI1VWtubGdUNXIwS3FiM1E1Y0dlTlBXY1JreW1ybkJEWWR0OXR4eFFMb1dPCllzNXdsMnVYWFVYL0VGcDMwajU0Nmp6czllWExLYlNDbjJjTDZFVE96Y2x3aG9DRGx2a2VQT05rUE9LMDVKNUMKTm1TdFdhMG9hV1VGRzM0MFl3cVVrWGt4OU9tNndXd1JldU1uU1FJREFRQUJBb0lCQUFJOHo1ck5kOEdtOGJBMgo1S3pxQjI1R2lOVENwbUNJeW53NXRJWHZTQmNHcEdydUcvdlN2WG9kVlFVSVY0TWdHQkVXUEFrVzdsNWVBcHI4CnA1ZFd5SkRXYTNkdklFSE9vSEpYU3dBYksxZzZEMTNVa2NkZ1EyRGpoNVhuWDhHZCtBY2c2SmRTQWgxOWtYSHEKMk54RUtBVDB6Ri83a1g2MkRkREFBcWxmQkpGSXJodVIvZUdEVWh4L2piTTRhQ2JCcFdiM0pnRE9OYm5tS1ZoMwpxS2ZwZmRZZENZU1lzWUxrNTlxRDF2VFNwUVFUQ0VadW9VKzNzRVNhdkJzaUs1bU0vTzY5ZkRMRXNURG1MeTVQCmhEK3BMQXI0SlhNNjFwRGVBS0l3cUVqWWJybXlDRHRXTUdJNnZzZ0E1eXQzUUJaME9vV2w5QUkwdWxoZ3p4dXQKZ2ZFNTRRRUNnWUVBN0F3a0lhVEEzYmQ4Nk9jSVZnNFlrWGk1cm5aNDdsM1k4V24zcjIzUmVISXhLdkllRUtSbgp5bUlFNDFtRVBBSmlGWFpLK1VPTXdkeS9EcnFJUithT1JiT2NiV01jWUg2QzgvbG1wdVJFaXE3SW1Ub3VWcnA4CnlnUkprMWprVDA4cTIvNmg4eTBEdjJqMitsaHFXNzRNOUt0cmwxcTRlWmZRUFREL01tR1NnTWtDZ1lFQXdhY04KaSttN1p6dnJtL3NuekF2VlZ5SEtwZHVUUjNERk1naC9maC9tZ0ZHZ1RwZWtUOVV5b3FleGNYQXdwMVlhL01iQQoyNTVJVDZRbXZZTm5yNXp6Wmxic2tMV0hsYllvbWhmWnVXTHhXR3hRaEFORWdaMFVVdUVTRGMvbWx2UXZHbEtSCkZoaGhBUWlVSmdDamhPaHk1SlBiNGFldGRKd0UxK09lVWRFaE1vRUNnWUVBNG8yZ25CM1o4ck5xa3NzemlBek4KYmNuMlJVbDJOaW9pejBwS3JMaDFaT29NNE5BekpQdjJsaHRQMzdtS0htS1hLMHczRjFqTEgwSTBxZmxFVmVZbQpSU1huakdHazJjUnpBYUVzOGgrQzNheDE0Z01pZUtGU3BqNUpNOEFNbVVZOXQ1cUVhN2FYc3o0V1ZoOUlMYmVTCkRiNzlhKzVwd21LQVBrcnBsTHhyZFdrQ2dZQlNNSHVBWVdBbmJYZ1BDS2FZWklGVWJNUWNacmY0ZnpWQ2lmYksKYWZHampvRlNPZXdEOGdGK3BWdWJRTGwxbkFieU44ek1xVDRaaHhybUhpcFlqMjJDaHV2NmN3RXJtbGRiSnpwQwpBMnRaVXdkTk1ESFlMUG5lUHlZeGRJWnlsUXFVeW14SGkydElUQUxNcWtLOGV3ZWdXZHpkeGhQSlJScU5JazhrCmZIVHhnUUtCZ1FEUFc2UXIxY3F3QjNUdnVWdWR4WGRqUTdIcDFodXhrNEVWaEFJZllKNFhSTW1NUE5YS28wdHUKdUt6LzE0QW14R0dvSWJxYVc1bDMzeFNteUxhem84clNUN0tSTjVKME9JSHcrZkR5SFgxdHpVSjZCTldDcEFTcwpjbWdNK0htSzVON0w2bkNaZFJQY2IwU1hGaVRQUGhCUG1PVWFDUnpER0ZMK2JYM1VwajJKbWc9PQotLS0tLUVORCBSU0EgUFJJVkFURSBLRVktLS0tLQo=", + "readOnly": true, + "type": "string" + } + }, + "readOnly": true, + "type": "object" + }, + "signed_token_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "token": { + "description": "The signed token used with the signed URLs feature.", + "example": "eyJhbGciOiJSUzI1NiIsImtpZCI6ImU5ZGI5OTBhODI2NjZkZDU3MWM3N2Y5NDRhNWM1YzhkIn0.eyJzdWIiOiJlYTk1MTMyYzE1NzMyNDEyZDIyYzE0NzZmYTgzZjI3YSIsImtpZCI6ImU5ZGI5OTBhODI2NjZkZDU3MWM3N2Y5NDRhNWM1YzhkIiwiZXhwIjoiMTUzNzQ2MDM2NSIsIm5iZiI6IjE1Mzc0NTMxNjUifQ.OZhqOARADn1iubK6GKcn25hN3nU-hCFF5q9w2C4yup0C4diG7aMIowiRpP-eDod8dbAJubsiFuTKrqPcmyCKWYsiv0TQueukqbQlF7HCO1TV-oF6El5-7ldJ46eD-ZQ0XgcIYEKrQOYFF8iDQbqPm3REWd6BnjKZdeVrLzuRaiSnZ9qqFpGu5dfxIY9-nZKDubJHqCr3Imtb211VIG_b9MdtO92JjvkDS-rxT_pkEfTZSafl1OU-98A7KBGtPSJHz2dHORIrUiTA6on4eIXTj9aFhGiir4rSn-rn0OjPRTtJMWIDMoQyE_fwrSYzB7MPuzL2t82BWaEbHZTfixBm5A", + "type": "string" + } + } + } + } + } + ] + }, + "signing_key_created": { + "description": "The date and time a signing key was created.", + "example": "2014-01-02T02:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "since": { + "description": "Start date and time of requesting data period in ISO 8601 format.", + "example": "2023-11-11T12:00:00Z", + "format": "date-time", + "type": "string" + }, + "since-cRELaVYs": { + "anyOf": [{ "type": "string" }, { "type": "integer" }], + "default": -10080, + "description": "The (inclusive) beginning of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. At this point in time, it cannot exceed a time in the past greater than one year.\n\nRanges that the Cloudflare web application provides will provide the following period length for each point:\n- Last 60 minutes (from -59 to -1): 1 minute resolution\n- Last 7 hours (from -419 to -60): 15 minutes resolution\n- Last 15 hours (from -899 to -420): 30 minutes resolution\n- Last 72 hours (from -4320 to -900): 1 hour resolution\n- Older than 3 days (-525600 to -4320): 1 day resolution.", + "example": "2015-01-01T12:23:00Z" + }, + "single_invite_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } }, "type": "object" } + ] + }, + "single_member_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } }, "type": "object" } + ] + }, + "single_membership_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } }, "type": "object" } + ] + }, + "single_organization_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } }, "type": "object" } + ] + }, + "single_request_outgoing": { + "properties": { + "id": { "$ref": "#/components/schemas/identifier-ahBjrSIO" }, + "name": { "$ref": "#/components/schemas/name-YGUm4gr7" }, + "peers": { "$ref": "#/components/schemas/peers" } + }, + "required": ["id", "name", "peers"] + }, + "single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/lists" } } } + ] + }, + "single_response-JiiItTpX": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/healthchecks" } } } + ] + }, + "single_response-UJHycgfI": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/device-posture-rules-gduy4mTZ" } } } + ] + }, + "single_response-X5UPXTbk": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/tsig" } } } + ] + }, + "single_response-ZvEjOvIb": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/waitingroom" } } } + ] + }, + "single_response-lMJq2fgM": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/configuration" } } } + ] + }, + "single_response-tparoDL5": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/ipam-prefixes" } } } + ] + }, + "single_response-x2K6CTG8": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/organizations" } } } + ] + }, + "single_response-xymoBSIP": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/monitor-FBAH67XY" } } } + ] + }, + "single_response_hostnames": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/settings-s418OBZp" } } } + ] + }, + "single_response_incoming": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "auto_refresh_seconds": { "$ref": "#/components/schemas/auto_refresh_seconds" }, + "checked_time": { "$ref": "#/components/schemas/time" }, + "created_time": { "$ref": "#/components/schemas/time" }, + "id": { "$ref": "#/components/schemas/identifier-ahBjrSIO" }, + "modified_time": { "$ref": "#/components/schemas/time" }, + "name": { "$ref": "#/components/schemas/name-YGUm4gr7" }, + "peers": { "$ref": "#/components/schemas/peers" }, + "soa_serial": { "$ref": "#/components/schemas/soa_serial" } + }, + "type": "object" + } + } + } + ] + }, + "single_response_outgoing": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "checked_time": { "$ref": "#/components/schemas/time" }, + "created_time": { "$ref": "#/components/schemas/time" }, + "id": { "$ref": "#/components/schemas/identifier-ahBjrSIO" }, + "last_transferred_time": { "$ref": "#/components/schemas/time" }, + "name": { "$ref": "#/components/schemas/name-YGUm4gr7" }, + "peers": { "$ref": "#/components/schemas/peers" }, + "soa_serial": { "$ref": "#/components/schemas/soa_serial" } + }, + "type": "object" + } + } + } + ] + }, + "single_response_with_list_items": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "description": { "$ref": "#/components/schemas/description" }, + "id": { "$ref": "#/components/schemas/uuid" }, + "items": { "$ref": "#/components/schemas/items" }, + "name": { "$ref": "#/components/schemas/name" }, + "type": { "$ref": "#/components/schemas/type" }, + "updated_at": { "$ref": "#/components/schemas/timestamp" } + } + } + } + } + ] + }, + "single_role_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } }, "type": "object" } + ] + }, + "single_user_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } }, "type": "object" } + ] + }, + "size": { + "description": "The size of the media item in bytes.", + "example": 4190963, + "readOnly": true, + "type": "number" + }, + "ski": { + "description": "Subject Key Identifier", + "example": "8e375af1389a069a0f921f8cc8e1eb12d784b949", + "readOnly": true, + "type": "string" + }, + "skip_interstitial": { + "description": "Enables automatic authentication through cloudflared.", + "example": true, + "type": "boolean" + }, + "soa_serial": { + "description": "The serial number of the SOA for the given zone.", + "example": 2019102400, + "type": "number" + }, + "sort": { + "description": "A comma-separated list of dimensions to sort by, where each dimension may be prefixed by - (descending) or + (ascending).", + "example": "+responseCode,-queryName", + "type": "string" + }, + "sort-KhE8n2c0": { + "description": "The sort order for the result set; sort fields must be included in `metrics` or `dimensions`.", + "example": ["+count", "-bytesIngress"], + "items": {}, + "type": "array" + }, + "sort_query_string_for_cache": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { + "description": "ID of the zone setting.", + "enum": ["sort_query_string_for_cache"], + "example": "sort_query_string_for_cache" + }, + "value": { "$ref": "#/components/schemas/sort_query_string_for_cache_value" } + } + } + ], + "default": "off", + "description": "Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones.", + "title": "Get String Sort" + }, + "sort_query_string_for_cache_value": { + "default": "off", + "description": "Value of the zone setting.", + "enum": ["on", "off"], + "type": "string" + }, + "split_tunnel": { + "properties": { + "address": { + "description": "The address in CIDR format to exclude from the tunnel. If address is present, host must not be present.", + "example": "192.0.2.0/24", + "type": "string" + }, + "description": { + "description": "A description of the split tunnel item, displayed in the client UI.", + "example": "Exclude testing domains from the tunnel", + "maxLength": 100, + "type": "string" + }, + "host": { + "description": "The domain name to exclude from the tunnel. If host is present, address must not be present.", + "example": "*.example.com", + "type": "string" + } + }, + "required": ["address", "description"], + "type": "object" + }, + "split_tunnel_include": { + "properties": { + "address": { + "description": "The address in CIDR format to include in the tunnel. If address is present, host must not be present.", + "example": "192.0.2.0/24", + "type": "string" + }, + "description": { + "description": "A description of the split tunnel item, displayed in the client UI.", + "example": "Include testing domains from the tunnel", + "maxLength": 100, + "type": "string" + }, + "host": { + "description": "The domain name to include in the tunnel. If host is present, address must not be present.", + "example": "*.example.com", + "type": "string" + } + }, + "required": ["address", "description"], + "type": "object" + }, + "split_tunnel_include_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/split_tunnel_include" }, "type": "array" } + } + } + ] + }, + "split_tunnel_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/split_tunnel" }, "type": "array" } } } + ] + }, + "ssh_props": { + "allOf": [ + { "$ref": "#/components/schemas/self_hosted_props-pFu7lQyL" }, + { "properties": { "type": { "description": "The application type.", "example": "ssh", "type": "string" } } } + ] + }, + "ssl": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { "description": "ID of the zone setting.", "enum": ["ssl"], "example": "ssl" }, + "value": { "$ref": "#/components/schemas/ssl_value" } + } + } + ], + "description": "SSL encrypts your visitor's connection and safeguards credit card numbers and other personal data to and from your website. SSL can take up to 5 minutes to fully activate. Requires Cloudflare active on your root domain or www domain. Off: no SSL between the visitor and Cloudflare, and no SSL between Cloudflare and your web server (all HTTP traffic). Flexible: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, but no SSL between Cloudflare and your web server. You don't need to have an SSL cert on your web server, but your vistors will still see the site as being HTTPS enabled. Full: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have your own SSL cert or self-signed cert at the very least. Full (Strict): SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have a valid SSL certificate installed on your web server. This certificate must be signed by a certificate authority, have an expiration date in the future, and respond for the request domain name (hostname). (https://support.cloudflare.com/hc/en-us/articles/200170416).", + "title": "SSL" + }, + "ssl-EYx9hEKp": { + "description": "SSL properties for the custom hostname.", + "oneOf": [ + { + "properties": { + "bundle_method": { + "default": "ubiquitous", + "description": "A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it.", + "enum": ["ubiquitous", "optimal", "force"], + "example": "ubiquitous", + "type": "string" + }, + "certificate_authority": { "$ref": "#/components/schemas/certificate_authority" }, + "custom_certificate": { + "description": "If a custom uploaded certificate is used.", + "example": "-----BEGIN CERTIFICATE-----\\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\\n-----END CERTIFICATE-----\\n", + "type": "string" + }, + "custom_csr_id": { + "description": "The identifier for the Custom CSR that was used.", + "example": "7b163417-1d2b-4c84-a38a-2fb7a0cd7752", + "type": "string" + }, + "custom_key": { + "description": "The key for a custom uploaded certificate.", + "example": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n", + "type": "string" + }, + "expires_on": { + "description": "The time the custom certificate expires on.", + "example": "2021-02-06T18:11:23.531995Z", + "format": "date-time", + "type": "string" + }, + "hosts": { + "description": "A list of Hostnames on a custom uploaded certificate.", + "example": ["app.example.com", "*.app.example.com"], + "items": {}, + "type": "array" + }, + "id": { + "description": "Custom hostname SSL identifier tag.", + "example": "0d89c70d-ad9f-4843-b99f-6cc0252067e9", + "maxLength": 36, + "minLength": 36, + "type": "string" + }, + "issuer": { + "description": "The issuer on a custom uploaded certificate.", + "example": "DigiCertInc", + "type": "string" + }, + "method": { + "description": "Domain control validation (DCV) method used for this hostname.", + "enum": ["http", "txt", "email"], + "example": "txt" + }, + "serial_number": { + "description": "The serial number on a custom uploaded certificate.", + "example": "6743787633689793699141714808227354901", + "type": "string" + }, + "settings": { "$ref": "#/components/schemas/sslsettings" }, + "signature": { + "description": "The signature on a custom uploaded certificate.", + "example": "SHA256WithRSA", + "type": "string" + }, + "status": { + "description": "Status of the hostname's SSL certificates.", + "enum": [ + "initializing", + "pending_validation", + "deleted", + "pending_issuance", + "pending_deployment", + "pending_deletion", + "pending_expiration", + "expired", + "active", + "initializing_timed_out", + "validation_timed_out", + "issuance_timed_out", + "deployment_timed_out", + "deletion_timed_out", + "pending_cleanup", + "staging_deployment", + "staging_active", + "deactivating", + "inactive", + "backup_issued", + "holding_deployment" + ], + "example": "pending_validation", + "readOnly": true + }, + "type": { + "description": "Level of validation to be used for this hostname. Domain validation (dv) must be used.", + "enum": ["dv"], + "example": "dv", + "readOnly": true + }, + "uploaded_on": { + "description": "The time the custom certificate was uploaded.", + "example": "2020-02-06T18:11:23.531995Z", + "format": "date-time", + "type": "string" + }, + "validation_errors": { + "description": "Domain validation errors that have been received by the certificate authority (CA).", + "items": { + "properties": { + "message": { + "description": "A domain validation error.", + "example": "SERVFAIL looking up CAA for app.example.com", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "validation_records": { "items": { "$ref": "#/components/schemas/validation_record" }, "type": "array" }, + "wildcard": { + "description": "Indicates whether the certificate covers a wildcard.", + "example": false, + "type": "boolean" + } + }, + "type": "object" + } + ], + "type": "object" + }, + "ssl-UwTUGHGu": { + "description": "SSL properties for the custom hostname.", + "oneOf": [ + { + "properties": { + "bundle_method": { + "default": "ubiquitous", + "description": "A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it.", + "enum": ["ubiquitous", "optimal", "force"], + "example": "ubiquitous", + "type": "string" + }, + "certificate_authority": { + "description": "The Certificate Authority that has issued this certificate.", + "enum": ["digicert", "google", "lets_encrypt"], + "example": "digicert", + "type": "string" + }, + "custom_certificate": { + "description": "If a custom uploaded certificate is used.", + "example": "-----BEGIN CERTIFICATE-----\\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\\n-----END CERTIFICATE-----\\n", + "type": "string" + }, + "custom_csr_id": { + "description": "The identifier for the Custom CSR that was used.", + "example": "7b163417-1d2b-4c84-a38a-2fb7a0cd7752", + "type": "string" + }, + "custom_key": { + "description": "The key for a custom uploaded certificate.", + "example": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n", + "type": "string" + }, + "expires_on": { + "description": "The time the custom certificate expires on.", + "example": "2021-02-06T18:11:23.531995Z", + "format": "date-time", + "type": "string" + }, + "hosts": { + "description": "A list of Hostnames on a custom uploaded certificate.", + "example": ["app.example.com", "*.app.example.com"], + "items": {}, + "type": "array" + }, + "id": { + "description": "Custom hostname SSL identifier tag.", + "example": "0d89c70d-ad9f-4843-b99f-6cc0252067e9", + "maxLength": 36, + "minLength": 36, + "type": "string" + }, + "issuer": { + "description": "The issuer on a custom uploaded certificate.", + "example": "DigiCertInc", + "type": "string" + }, + "method": { + "description": "Domain control validation (DCV) method used for this hostname.", + "enum": ["http", "txt", "email"], + "example": "txt" + }, + "serial_number": { + "description": "The serial number on a custom uploaded certificate.", + "example": "6743787633689793699141714808227354901", + "type": "string" + }, + "settings": { "$ref": "#/components/schemas/sslsettings" }, + "signature": { + "description": "The signature on a custom uploaded certificate.", + "example": "SHA256WithRSA", + "type": "string" + }, + "status": { + "description": "Status of the hostname's SSL certificates.", + "enum": [ + "initializing", + "pending_validation", + "deleted", + "pending_issuance", + "pending_deployment", + "pending_deletion", + "pending_expiration", + "expired", + "active", + "initializing_timed_out", + "validation_timed_out", + "issuance_timed_out", + "deployment_timed_out", + "deletion_timed_out", + "pending_cleanup", + "staging_deployment", + "staging_active", + "deactivating", + "inactive", + "backup_issued", + "holding_deployment" + ], + "example": "pending_validation", + "readOnly": true + }, + "type": { + "description": "Level of validation to be used for this hostname. Domain validation (dv) must be used.", + "enum": ["dv"], + "example": "dv", + "readOnly": true + }, + "uploaded_on": { + "description": "The time the custom certificate was uploaded.", + "example": "2020-02-06T18:11:23.531995Z", + "format": "date-time", + "type": "string" + }, + "validation_errors": { + "description": "Domain validation errors that have been received by the certificate authority (CA).", + "items": { + "properties": { + "message": { + "description": "A domain validation error.", + "example": "SERVFAIL looking up CAA for app.example.com", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "validation_records": { "items": { "$ref": "#/components/schemas/validation_record" }, "type": "array" }, + "wildcard": { + "description": "Indicates whether the certificate covers a wildcard.", + "example": false, + "type": "boolean" + } + }, + "type": "object" + } + ], + "type": "object" + }, + "ssl-recommender_components-schemas-value": { + "enum": ["flexible", "full", "strict"], + "example": "strict", + "type": "string" + }, + "ssl_recommender": { + "allOf": [ + { + "properties": { + "enabled": { "$ref": "#/components/schemas/ssl_recommender_enabled" }, + "id": { + "description": "Enrollment value for SSL/TLS Recommender.", + "enum": ["ssl_recommender"], + "example": "ssl_recommender" + } + } + }, + { + "properties": { + "editable": { "$ref": "#/components/schemas/editable" }, + "modified_on": { "$ref": "#/components/schemas/modified_on-zM0Z89yx" } + } + } + ], + "description": "Enrollment in the SSL/TLS Recommender service which tries to detect and recommend (by sending periodic emails) the most secure SSL/TLS setting your origin servers support.", + "title": "SSL/TLS Recommender" + }, + "ssl_recommender_enabled": { + "default": false, + "description": "ssl-recommender enrollment setting.", + "type": "boolean" + }, + "ssl_universal_settings_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/universal" } } } + ] + }, + "ssl_validation_method_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "status": { "$ref": "#/components/schemas/validation_method_components-schemas-status" }, + "validation_method": { "$ref": "#/components/schemas/validation_method_definition" } + } + } + } + } + ] + }, + "ssl_value": { + "default": "off", + "description": "Value of the zone setting.\nNotes: Depends on the zone's plan level", + "enum": ["off", "flexible", "full", "strict"], + "type": "string" + }, + "ssl_verification_response_collection": { + "allOf": [ + { "properties": { "result": { "items": { "$ref": "#/components/schemas/verification" }, "type": "array" } } } + ] + }, + "sslpost": { + "description": "SSL properties used when creating the custom hostname.", + "oneOf": [ + { + "properties": { + "bundle_method": { + "default": "ubiquitous", + "description": "A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it.", + "enum": ["ubiquitous", "optimal", "force"], + "example": "ubiquitous", + "type": "string" + }, + "certificate_authority": { "$ref": "#/components/schemas/certificate_authority" }, + "custom_certificate": { + "description": "If a custom uploaded certificate is used.", + "example": "-----BEGIN CERTIFICATE-----\\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\\n-----END CERTIFICATE-----\\n", + "type": "string" + }, + "custom_key": { + "description": "The key for a custom uploaded certificate.", + "example": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n", + "type": "string" + }, + "method": { + "description": "Domain control validation (DCV) method used for this hostname.", + "enum": ["http", "txt", "email"], + "example": "http" + }, + "settings": { "$ref": "#/components/schemas/sslsettings" }, + "type": { + "description": "Level of validation to be used for this hostname. Domain validation (dv) must be used.", + "enum": ["dv"], + "example": "dv" + }, + "wildcard": { + "description": "Indicates whether the certificate covers a wildcard.", + "example": false, + "type": "boolean" + } + }, + "type": "object" + } + ], + "type": "object" + }, + "sslpost-TcVapXSa": { + "description": "SSL properties used when creating the custom hostname.", + "oneOf": [ + { + "properties": { + "bundle_method": { + "default": "ubiquitous", + "description": "A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it.", + "enum": ["ubiquitous", "optimal", "force"], + "example": "ubiquitous", + "type": "string" + }, + "custom_certificate": { + "description": "If a custom uploaded certificate is used.", + "example": "-----BEGIN CERTIFICATE-----\\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\\n-----END CERTIFICATE-----\\n", + "type": "string" + }, + "custom_key": { + "description": "The key for a custom uploaded certificate.", + "example": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG\ndtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn\nabIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid\ntnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py\nFxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE\newooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb\nHBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/\naxiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb\n+ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g\n+j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv\nKLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7\n9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo\n/WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu\niacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9\nN2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe\nVAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB\nvULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U\nlySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR\n9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7\nmEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX\ndFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe\nPG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS\nfhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W\nqu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T\nlv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi\n-----END RSA PRIVATE KEY-----\n", + "type": "string" + }, + "method": { + "description": "Domain control validation (DCV) method used for this hostname.", + "enum": ["http", "txt", "email"], + "example": "http" + }, + "settings": { "$ref": "#/components/schemas/sslsettings" }, + "type": { + "description": "Level of validation to be used for this hostname. Domain validation (dv) must be used.", + "enum": ["dv"], + "example": "dv", + "readOnly": true + }, + "wildcard": { + "description": "Indicates whether the certificate covers a wildcard.", + "example": false, + "type": "boolean" + } + }, + "type": "object" + } + ], + "type": "object" + }, + "sslsettings": { + "description": "SSL specific settings.", + "properties": { + "ciphers": { + "description": "An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format.", + "example": ["ECDHE-RSA-AES128-GCM-SHA256", "AES128-SHA"], + "items": { "type": "string" }, + "type": "array", + "uniqueItems": true + }, + "early_hints": { + "description": "Whether or not Early Hints is enabled.", + "enum": ["on", "off"], + "example": "on" + }, + "http2": { "description": "Whether or not HTTP2 is enabled.", "enum": ["on", "off"], "example": "on" }, + "min_tls_version": { + "description": "The minimum TLS version supported.", + "enum": ["1.0", "1.1", "1.2", "1.3"], + "example": "1.2" + }, + "tls_1_3": { "description": "Whether or not TLS 1.3 is enabled.", "enum": ["on", "off"], "example": "on" } + }, + "type": "object" + }, + "stage": { + "description": "The status of the deployment.", + "properties": { + "ended_on": { + "description": "When the stage ended.", + "example": "2021-03-09T00:58:59.045655", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The current build stage.", + "example": "deploy", + "pattern": "queued|initialize|clone_repo|build|deploy", + "type": "string" + }, + "started_on": { + "description": "When the stage started.", + "example": "2021-03-09T00:55:03.923456Z", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "status": { + "description": "State of the current stage.", + "example": "success", + "pattern": "success|idle|active|failure|canceled", + "readOnly": true, + "type": "string" + } + }, + "readOnly": true, + "type": "object" + }, + "start_end_params": { + "properties": { + "end": { + "description": "Defaults to the current date.", + "example": "2021-04-30", + "format": "date", + "type": "string" + }, + "start": { + "description": "Defaults to 30 days before the end parameter value.", + "example": "2021-04-01", + "format": "date", + "type": "string" + } + }, + "type": "object" + }, + "start_time_seconds": { + "description": "Specifies the start time for the video clip in seconds.", + "readOnly": true, + "type": "integer" + }, + "state": { "description": "State, provided by the CSR", "example": "CA", "readOnly": true, "type": "string" }, + "state-MZbhRzAd": { + "description": "The state that the subscription is in.", + "enum": ["Trial", "Provisioned", "Paid", "AwaitingPayment", "Cancelled", "Failed", "Expired"], + "example": "Paid", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "The current status of the origin server according to the health check.", + "enum": ["unknown", "healthy", "unhealthy", "suspended"], + "example": "healthy", + "readOnly": true, + "type": "string" + }, + "status-2mOK9Pc7": { + "description": "Status of DNSSEC, based on user-desired state and presence of necessary records.", + "enum": ["active", "pending", "disabled", "pending-disabled", "error"], + "example": "active" + }, + "status-5v6phuGF": { + "enum": ["event_prequeueing", "not_queueing", "queueing"], + "example": "queueing", + "type": "string" + }, + "status-8gYjapkg": { + "description": "Status of the token.", + "enum": ["active", "disabled", "expired"], + "example": "active", + "type": "string" + }, + "status-cnKVAn0b": { + "default": "disabled", + "description": "The status of the Page Rule.", + "enum": ["active", "disabled"], + "example": "active", + "type": "string" + }, + "status-dMauZcAv": { + "description": "Status of the zone's custom SSL.", + "enum": ["active", "expired", "deleted", "pending", "initializing"], + "example": "active", + "readOnly": true + }, + "status_event_id": { "example": "25756b2dfe6e378a06b033b670413757", "type": "string" }, + "status_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "estimated_queued_users": { "$ref": "#/components/schemas/estimated_queued_users" }, + "estimated_total_active_users": { "$ref": "#/components/schemas/estimated_total_active_users" }, + "event_id": { "$ref": "#/components/schemas/status_event_id" }, + "max_estimated_time_minutes": { "$ref": "#/components/schemas/max_estimated_time_minutes" }, + "status": { "$ref": "#/components/schemas/status-5v6phuGF" } + }, + "type": "object" + } + } + } + ] + }, + "std_dev_rtt_ms": { "description": "Standard deviation of the RTTs in ms.", "type": "number" }, + "steering_policy": { + "default": "\"\"", + "description": "Steering Policy for this load balancer.\n- `\"off\"`: Use `default_pools`.\n- `\"geo\"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools` is determined by `location_strategy`.\n- `\"random\"`: Select a pool randomly.\n- `\"dynamic_latency\"`: Use round trip time to select the closest pool in default_pools (requires pool health checks).\n- `\"proximity\"`: Use the pools' latitude and longitude to select the closest pool using the Cloudflare PoP location for proxied requests or the location determined by `location_strategy` for non-proxied requests.\n- `\"\"`: Will map to `\"geo\"` if you use `region_pools`/`country_pools`/`pop_pools` otherwise `\"off\"`.", + "enum": ["off", "geo", "random", "dynamic_latency", "proximity", "\"\""], + "example": "dynamic_latency", + "type": "string" + }, + "stix_identifier": { + "description": "STIX 2.1 identifier: https://docs.oasis-open.org/cti/stix/v2.1/cs02/stix-v2.1-cs02.html#_64yvzeku5a5c", + "example": "ipv4-addr--baa568ec-6efe-5902-be55-0663833db537", + "type": "string" + }, + "string_constraint": { + "description": "String constraint.", + "properties": { + "operator": { + "default": "contains", + "description": "The matches operator can use asterisks and pipes as wildcard and 'or' operators.", + "enum": ["matches", "contains", "equals", "not_equal", "not_contain"] + }, + "value": { "description": "The value to apply the operator to.", "type": "string" } + }, + "required": ["operator", "value"], + "type": "object" + }, + "subcategory": { + "properties": { + "beta": { "$ref": "#/components/schemas/beta" }, + "class": { "$ref": "#/components/schemas/class" }, + "description": { "$ref": "#/components/schemas/components-schemas-description" }, + "id": { "$ref": "#/components/schemas/id" }, + "name": { "$ref": "#/components/schemas/categories_components-schemas-name" } + }, + "type": "object" + }, + "subdivision_code_a2": { + "description": "Two-letter subdivision code followed in ISO 3166-2.", + "example": "CA", + "type": "string" + }, + "subdomain": { + "description": "The DNS Over HTTPS domain to send DNS requests to. (auto-generated).", + "example": "oli3n9zkz5", + "type": "string" + }, + "subdomain-response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { "properties": { "result": { "properties": { "name": { "readOnly": true } }, "type": "object" } } } + ] + }, + "subscription": { "allOf": [{ "$ref": "#/components/schemas/subscription-v2" }], "type": "object" }, + "subscription-v2": { + "properties": { + "app": { "properties": { "install_id": { "$ref": "#/components/schemas/install_id" } } }, + "component_values": { "$ref": "#/components/schemas/component_values" }, + "currency": { "$ref": "#/components/schemas/currency" }, + "current_period_end": { "$ref": "#/components/schemas/current_period_end" }, + "current_period_start": { "$ref": "#/components/schemas/current_period_start" }, + "frequency": { "$ref": "#/components/schemas/frequency-StdFMmw2" }, + "id": { "$ref": "#/components/schemas/subscription-v2_components-schemas-identifier" }, + "price": { "$ref": "#/components/schemas/price" }, + "rate_plan": { "$ref": "#/components/schemas/rate_plan" }, + "state": { "$ref": "#/components/schemas/state-MZbhRzAd" }, + "zone": { "$ref": "#/components/schemas/zone-NCQbmiTF" } + }, + "type": "object" + }, + "subscription-v2_components-schemas-identifier": { + "description": "Subscription identifier tag.", + "example": "506e3185e9c882d175a2d0cb0093d9f2", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "suggested_threshold": { + "description": "The suggested threshold in requests done by the same auth_id or period_seconds.", + "readOnly": true, + "type": "integer" + }, + "support_url": { + "description": "The URL to launch when the Send Feedback button is clicked.", + "example": "https://1.1.1.1/help", + "type": "string" + }, + "supported_tld": { + "description": "Whether a particular TLD is currently supported by Cloudflare Registrar. Refer to [TLD Policies](https://www.cloudflare.com/tld-policies/) for a list of supported TLDs.", + "example": true, + "type": "boolean" + }, + "suspended": { + "default": false, + "description": "If suspended, no health checks are sent to the origin.", + "type": "boolean" + }, + "suspended-qdpN2ZN2": { + "default": false, + "description": "Suspends or allows traffic going to the waiting room. If set to `true`, the traffic will not go to the waiting room.", + "type": "boolean" + }, + "switch_locked": { + "description": "Whether to allow the user to turn off the WARP switch and disconnect the client.", + "example": true, + "type": "boolean" + }, + "tags": { + "description": "Custom tags for the DNS record. This field has no effect on DNS responses.", + "items": { + "description": "Individual tag of the form name:value (the name must consist of only letters, numbers, underscores and hyphens)", + "example": "owner:dns-team", + "type": "string" + }, + "type": "array" + }, + "tail-response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { + "properties": { + "result": { + "properties": { + "expires_at": { "readOnly": true }, + "id": { "readOnly": true }, + "url": { "readOnly": true } + }, + "type": "object" + } + } + } + ] + }, + "target": { + "description": "A request condition target.", + "oneOf": [{ "$ref": "#/components/schemas/url_target" }], + "required": ["target", "constraint"] + }, + "target-MnAfh9We": { + "description": "The target hostname, IPv6, or IPv6 address.", + "example": "1.1.1.1", + "type": "string" + }, + "target_result": { + "properties": { + "colos": { "items": { "$ref": "#/components/schemas/colo_result" }, "type": "array" }, + "target": { "$ref": "#/components/schemas/target-MnAfh9We" } + }, + "type": "object" + }, + "target_summary": { + "description": "Aggregated statistics from all hops about the target.", + "example": { + "asn": "", + "ip": "1.1.1.1", + "max_latency_ms": 0.034, + "mean_latency_ms": 0.021, + "min_latency_ms": 0.014, + "name": "1.1.1.1", + "packet_count": 3, + "std_dev_latency_ms": 0.011269427669584647 + }, + "type": "object" + }, + "targets": { + "description": "The rule targets to evaluate on each request.", + "example": [{ "constraint": { "operator": "matches", "value": "*example.com/images/*" }, "target": "url" }], + "items": { "$ref": "#/components/schemas/target" }, + "type": "array" + }, + "targets-8BcM0LKv": { + "example": ["203.0.113.1", "cloudflare.com"], + "items": { + "description": "Hosts as a hostname or IPv4/IPv6 address represented by strings.", + "example": "203.0.113.1", + "type": "string" + }, + "maxLength": 10, + "type": "array" + }, + "tcp_config": { + "description": "Parameters specific to TCP health check.", + "nullable": true, + "properties": { + "method": { + "default": "connection_established", + "description": "The TCP connection method to use for the health check.", + "enum": ["connection_established"], + "type": "string" + }, + "port": { + "default": 80, + "description": "Port number to connect to for the health check. Defaults to 80.", + "type": "integer" + } + }, + "type": "object" + }, + "teamnet": { + "properties": { + "comment": { "$ref": "#/components/schemas/comment-ZBQ7qz21" }, + "created_at": { "description": "Timestamp of when the route was created." }, + "deleted_at": { + "description": "Timestamp of when the route was deleted. If `null`, the route has not been deleted.", + "example": "2021-01-25T18:22:34.317854Z", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "network": { "$ref": "#/components/schemas/ip_network" }, + "tunnel_id": { "$ref": "#/components/schemas/schemas-tunnel_id" }, + "tunnel_name": { "$ref": "#/components/schemas/schemas-tunnel_name" }, + "virtual_network_id": { "$ref": "#/components/schemas/schemas-virtual_network_id" } + }, + "required": ["network", "tunnel_id", "comment", "created_at"], + "type": "object" + }, + "teamnet_components-schemas-ip": { "example": "10.1.0.137", "type": "string" }, + "telephone": { + "description": "User's telephone number", + "example": "+1 123-123-1234", + "maxLength": 20, + "nullable": true, + "type": "string" + }, + "test_connection_properties": { + "properties": { + "body_hash": { + "description": "Hash version of body.", + "example": "be27f2429421e12f200cab1da43ba301bdc70e1d", + "type": "string" + }, + "body_size": { "description": "Size of the body in bytes.", "example": "63910 bytes", "type": "string" }, + "cf-cache-status": { "description": "Lists any `cf-cache-status` present.", "type": "string" }, + "cf-ray": { + "description": "Lists any `cf-ray` present.", + "example": "1ddd7570575207d9-LAX", + "type": "string" + }, + "cf-wan-error": { "description": "Lists any `cf-wan-error` present.", "type": "string" }, + "cloudflare": { + "description": "Whether Cloudflare is enabled on the host.", + "example": "on", + "type": "string" + }, + "connection_close": { + "default": true, + "description": "Connection closed or open.", + "example": false, + "type": "boolean" + }, + "elapsed_time": { + "description": "Amount of seconds that the test lasted.", + "example": "0.239013s", + "type": "string" + }, + "host_name": { "description": "The hostname queried.", "example": "www.example.com", "type": "string" }, + "http_status": { "description": "The HTTP status response code.", "example": 200, "type": "number" }, + "method": { + "description": "HTTP Method used to test the connection.", + "enum": ["GET", "POST"], + "example": "GET" + }, + "missing_headers": { + "description": "What headers are missing.", + "example": "No Content-Length or Transfer-Encoding.", + "type": "string" + }, + "protocol": { + "description": "Protocol used to test the connection.", + "example": "HTTP/1.1", + "type": "string" + }, + "railgun": { + "description": "Indicates if Railgun is enabled on the queried hostname.", + "example": "on", + "type": "string" + }, + "response_status": { "description": "HTTP Status code.", "example": "200 OK", "type": "string" }, + "url": { + "description": "Url of the domain you can compare the connection to.", + "example": "https://www.cloudflare.com", + "type": "string" + } + }, + "type": "object" + }, + "test_connection_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/test_connection_properties" } } } + ] + }, + "threats": { + "description": "Breakdown of totals for threats.", + "properties": { + "all": { + "description": "The total number of identifiable threats received over the time frame.", + "type": "integer" + }, + "country": { + "description": "A list of key/value pairs where the key is a two-digit country code and the value is the number of malicious requests received from that country.", + "example": { "AU": 91, "CN": 523423, "US": 123 }, + "type": "object" + }, + "type": { + "description": "The list of key/value pairs where the key is a threat category and the value is the number of requests.", + "example": { + "hot.ban.unknown": 5324, + "macro.chl.captchaErr": 1341, + "macro.chl.jschlErr": 5323, + "user.ban.ip": 123 + }, + "type": "object" + } + }, + "type": "object" + }, + "threshold": { + "description": "The threshold that will trigger the configured mitigation action. Configure this value along with the `period` property to establish a threshold per period.", + "example": 60, + "minimum": 1, + "type": "number" + }, + "thresholds": { + "properties": { + "thresholds": { + "properties": { + "auth_id_tokens": { "$ref": "#/components/schemas/auth_id_tokens" }, + "data_points": { "$ref": "#/components/schemas/data_points" }, + "last_updated": { "$ref": "#/components/schemas/timestamp" }, + "p50": { "$ref": "#/components/schemas/p50" }, + "p90": { "$ref": "#/components/schemas/p90" }, + "p99": { "$ref": "#/components/schemas/p99" }, + "period_seconds": { "$ref": "#/components/schemas/period_seconds" }, + "requests": { "$ref": "#/components/schemas/requests" }, + "suggested_threshold": { "$ref": "#/components/schemas/suggested_threshold" } + }, + "type": "object" + } + }, + "readOnly": true, + "required": [ + "period_seconds", + "suggested_threshold", + "p50", + "p90", + "p99", + "requests", + "auth_id_tokens", + "data_points", + "last_updated" + ], + "type": "object" + }, + "thumbnailTimestampPct": { + "default": 0, + "description": "The timestamp for a thumbnail image calculated as a percentage value of the video's duration. To convert from a second-wise timestamp to a percentage, divide the desired timestamp by the total duration of the video. If this value is not set, the default thumbnail image is taken from 0s of the video.", + "example": 0.529241, + "maximum": 1, + "minimum": 0, + "type": "number" + }, + "thumbnail_url": { + "description": "URI to thumbnail variant for an image.", + "example": "https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/thumbnail", + "format": "uri", + "readOnly": true, + "type": "string" + }, + "thumbnail_url-GZVIYimZ": { + "description": "The media item's thumbnail URI. This field is omitted until encoding is complete.", + "example": "https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/thumbnails/thumbnail.jpg", + "format": "uri", + "readOnly": true, + "type": "string" + }, + "tiered-cache-smart-topology-api_components-schemas-value": { + "description": "Enables Tiered Cache.", + "enum": ["on", "off"], + "example": "on", + "type": "string" + }, + "time": { + "description": "The time for a specific event.", + "example": "2019-10-24T17:09:42.883908+01:00", + "type": "string" + }, + "time_delta": { + "description": "Unit of time to group data by.", + "enum": ["all", "auto", "year", "quarter", "month", "week", "day", "hour", "dekaminute", "minute"], + "example": "hour", + "type": "string" + }, + "timeout": { + "default": 5, + "description": "The timeout (in seconds) before marking the health check as failed.", + "type": "integer" + }, + "timeout-QN7vNkTu": { + "description": "The time in seconds during which Cloudflare will perform the mitigation action. Must be an integer value greater than or equal to the period.\nNotes: If \"mode\" is \"challenge\", \"managed_challenge\", or \"js_challenge\", Cloudflare will use the zone's Challenge Passage time and you should not provide this value.", + "example": 86400, + "maximum": 86400, + "minimum": 1, + "type": "number" + }, + "timeseries": { + "description": "Time deltas containing metadata about each bucket of time. The number of buckets (resolution) is determined by the amount of time between the since and until parameters.", + "items": { + "properties": { + "bandwidth": { "$ref": "#/components/schemas/bandwidth" }, + "pageviews": { "$ref": "#/components/schemas/pageviews" }, + "requests": { "$ref": "#/components/schemas/schemas-requests" }, + "since": { "$ref": "#/components/schemas/since-cRELaVYs" }, + "threats": { "$ref": "#/components/schemas/threats" }, + "uniques": { "$ref": "#/components/schemas/uniques" }, + "until": { "$ref": "#/components/schemas/until-HpHDrENT" } + }, + "type": "object" + }, + "type": "array" + }, + "timeseries_by_colo": { + "description": "Time deltas containing metadata about each bucket of time. The number of buckets (resolution) is determined by the amount of time between the since and until parameters.", + "items": { + "properties": { + "bandwidth": { "$ref": "#/components/schemas/bandwidth_by_colo" }, + "requests": { "$ref": "#/components/schemas/requests_by_colo" }, + "since": { "$ref": "#/components/schemas/since-cRELaVYs" }, + "threats": { "$ref": "#/components/schemas/threats" }, + "until": { "$ref": "#/components/schemas/until-HpHDrENT" } + }, + "type": "object" + }, + "type": "array" + }, + "timestamp": { + "example": "2014-01-01T05:20:00.12345Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "timestamps": { + "default": "unixnano", + "description": "By default, timestamps in responses are returned as Unix nanosecond integers. The `?timestamps=` argument can be set to change the format in which response timestamps are returned. Possible values are: `unix`, `unixnano`, `rfc3339`. Note that `unix` and `unixnano` return timestamps as integers; `rfc3339` returns timestamps as strings.", + "enum": ["unix", "unixnano", "rfc3339"], + "example": "unixnano", + "type": "string" + }, + "tls": { + "description": "The type of TLS termination associated with the application.", + "enum": ["off", "flexible", "full", "strict"], + "example": "full", + "type": "string" + }, + "tls-settings": { + "description": "TLS interception settings.", + "properties": { + "enabled": { "description": "Enable inspecting encrypted HTTP traffic.", "example": true, "type": "boolean" } + }, + "type": "object" + }, + "tls_1_2_only": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { "description": "Zone setting identifier.", "enum": ["tls_1_2_only"], "example": "tls_1_2_only" }, + "value": { "$ref": "#/components/schemas/tls_1_2_only_value" } + } + } + ], + "description": "Only allows TLS1.2.", + "title": "TLS1.2 only" + }, + "tls_1_2_only_value": { + "default": "off", + "description": "Value of the zone setting.", + "enum": ["off", "on"], + "type": "string" + }, + "tls_1_3": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { "description": "ID of the zone setting.", "enum": ["tls_1_3"], "example": "tls_1_3" }, + "value": { "$ref": "#/components/schemas/tls_1_3_value" } + } + } + ], + "default": "off", + "description": "Enables Crypto TLS 1.3 feature for a zone.", + "title": "Enable TLS 1.3 value for a zone" + }, + "tls_1_3_value": { + "default": "off", + "description": "Value of the zone setting.\nNotes: Default value depends on the zone's plan level.", + "enum": ["on", "off", "zrt"], + "type": "string" + }, + "tls_client_auth": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { + "description": "ID of the zone setting.", + "enum": ["tls_client_auth"], + "example": "tls_client_auth" + }, + "value": { "$ref": "#/components/schemas/tls_client_auth_value" } + } + } + ], + "description": "TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only).", + "title": "TLS Client Authentication" + }, + "tls_client_auth_value": { + "default": "on", + "description": "value of the zone setting.", + "enum": ["on", "off"], + "type": "string" + }, + "tls_config_request": { + "properties": { + "sha256": { + "description": "The SHA-256 hash of the TLS certificate presented by the host found at tls_sockaddr. If absent, regular certificate verification (trusted roots, valid timestamp, etc) will be used to validate the certificate.", + "example": "b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c", + "type": "string" + }, + "tls_sockaddr": { + "description": "A network address of the form \"host:port\" that the WARP client will use to detect the presence of a TLS host.", + "example": "foobar:1234", + "type": "string" + } + }, + "required": ["tls_sockaddr"], + "type": "object" + }, + "tls_config_response": { + "description": "The Managed Network TLS Config Response.", + "properties": { + "sha256": { + "description": "The SHA-256 hash of the TLS certificate presented by the host found at tls_sockaddr. If absent, regular certificate verification (trusted roots, valid timestamp, etc) will be used to validate the certificate.", + "example": "b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c", + "type": "string" + }, + "tls_sockaddr": { + "description": "A network address of the form \"host:port\" that the WARP client will use to detect the presence of a TLS host.", + "example": "foobar:1234", + "type": "string" + } + }, + "required": ["tls_sockaddr"], + "type": "object" + }, + "token": { + "properties": { + "condition": { "$ref": "#/components/schemas/condition" }, + "expires_on": { "$ref": "#/components/schemas/expires_on-dkbMDCaD" }, + "id": { "$ref": "#/components/schemas/components-schemas-identifier-vS0Y8rdw" }, + "issued_on": { "$ref": "#/components/schemas/issued_on-ckMiaqK5" }, + "modified_on": { "$ref": "#/components/schemas/modified_on-bJDfxiY8" }, + "name": { "$ref": "#/components/schemas/name-pG4STmz5" }, + "not_before": { "$ref": "#/components/schemas/not_before" }, + "policies": { "$ref": "#/components/schemas/policies-iecjppBc" }, + "status": { "$ref": "#/components/schemas/status-8gYjapkg" } + }, + "required": ["id", "name", "status", "policies"], + "type": "object" + }, + "total_active_users": { + "description": "Sets the total number of active user sessions on the route at a point in time. A route is a combination of host and path on which a waiting room is available. This value is used as a baseline for the total number of active user sessions on the route. It is possible to have a situation where there are more or less active users sessions on the route based on the traffic patterns at that time around the world.", + "maximum": 2147483647, + "minimum": 200, + "type": "integer" + }, + "total_tls_settings_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "certificate_authority": { "$ref": "#/components/schemas/components-schemas-certificate_authority" }, + "enabled": { "$ref": "#/components/schemas/components-schemas-enabled" }, + "validity_days": { "$ref": "#/components/schemas/schemas-validity_days" } + } + } + } + } + ] + }, + "total_tls_settings_response-uh822r21": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "certificate_authority": { "$ref": "#/components/schemas/schemas-certificate_authority-mu8utRU0" }, + "enabled": { "$ref": "#/components/schemas/components-schemas-enabled" }, + "validity_days": { "$ref": "#/components/schemas/schemas-validity_days" } + } + } + } + } + ] + }, + "totals": { + "description": "Breakdown of totals by data type.", + "properties": { + "bandwidth": { "$ref": "#/components/schemas/bandwidth" }, + "pageviews": { "$ref": "#/components/schemas/pageviews" }, + "requests": { "$ref": "#/components/schemas/schemas-requests" }, + "since": { "$ref": "#/components/schemas/since-cRELaVYs" }, + "threats": { "$ref": "#/components/schemas/threats" }, + "uniques": { "$ref": "#/components/schemas/uniques" }, + "until": { "$ref": "#/components/schemas/until-HpHDrENT" } + }, + "type": "object" + }, + "totals_by_colo": { + "description": "Breakdown of totals by data type.", + "properties": { + "bandwidth": { "$ref": "#/components/schemas/bandwidth_by_colo" }, + "requests": { "$ref": "#/components/schemas/requests_by_colo" }, + "since": { "$ref": "#/components/schemas/since-cRELaVYs" }, + "threats": { "$ref": "#/components/schemas/threats" }, + "until": { "$ref": "#/components/schemas/until-HpHDrENT" } + }, + "type": "object" + }, + "trace": { + "items": { + "description": "List of steps acting on request/response", + "properties": { + "action": { + "description": "If step type is rule, then action performed by this rule", + "example": "execute", + "pattern": "^[a-z_]+$", + "type": "string" + }, + "action_parameters": { + "description": "If step type is rule, then action parameters of this rule as JSON", + "example": { "id": "4814384a9e5d4991b9815dcfc25d2f1f" }, + "type": "object" + }, + "description": { + "description": "If step type is rule or ruleset, the description of this entity", + "example": "some rule", + "type": "string" + }, + "expression": { + "description": "If step type is rule, then expression used to match for this rule", + "example": "ip.src ne 1.1.1.1", + "type": "string" + }, + "kind": { + "description": "If step type is ruleset, then kind of this ruleset", + "example": "zone", + "type": "string" + }, + "matched": { + "description": "Whether tracing step affected tracing request/response", + "example": true, + "type": "boolean" + }, + "name": { + "description": "If step type is ruleset, then name of this ruleset", + "example": "some ruleset name", + "type": "string" + }, + "step_name": { "description": "Tracing step identifying name", "example": "rule_id01", "type": "string" }, + "trace": { "$ref": "#/components/schemas/trace" }, + "type": { "description": "Tracing step type", "example": "rule", "type": "string" } + }, + "type": "object" + }, + "type": "array" + }, + "traceroute_components-schemas-ip": { "description": "IP address of the node.", "type": "string" }, + "traceroute_components-schemas-name": { + "description": "Host name of the address, this may be the same as the IP address.", + "type": "string" + }, + "traceroute_components-schemas-port": { + "default": 0, + "description": "For UDP and TCP, specifies the destination port. For ICMP, specifies the initial ICMP sequence value. Default value 0 will choose the best value to use for each protocol.", + "maximum": 65535, + "minimum": 0, + "type": "integer" + }, + "traceroute_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/target_result" }, "type": "array" } } } + ] + }, + "traceroute_time_ms": { "description": "Total time of traceroute in ms.", "type": "integer" }, + "traditional_allow_rule": { + "allOf": [ + { "$ref": "#/components/schemas/rule_components-schemas-base-2" }, + { + "properties": { + "allowed_modes": { "$ref": "#/components/schemas/allowed_modes_allow_traditional" }, + "mode": { "$ref": "#/components/schemas/mode_allow_traditional" } + } + } + ], + "description": "When triggered, traditional WAF rules cause the firewall to immediately act on the request based on the rule configuration. An 'allow' rule will immediately allow the request and no other rules will be processed.", + "required": ["id", "description", "priority", "allowed_modes", "default_mode", "mode", "group", "package_id"], + "title": "Traditional (allow) WAF rule" + }, + "traditional_deny_rule": { + "allOf": [ + { "$ref": "#/components/schemas/rule_components-schemas-base-2" }, + { + "properties": { + "allowed_modes": { "$ref": "#/components/schemas/allowed_modes_deny_traditional" }, + "default_mode": { "$ref": "#/components/schemas/default_mode" }, + "mode": { "$ref": "#/components/schemas/mode_deny_traditional" } + } + } + ], + "description": "When triggered, traditional WAF rules cause the firewall to immediately act upon the request based on the configuration of the rule. A 'deny' rule will immediately respond to the request based on the configured rule action/mode (for example, 'block') and no other rules will be processed.", + "required": ["id", "description", "priority", "allowed_modes", "default_mode", "mode", "group", "package_id"], + "title": "Traditional (deny) WAF rule" + }, + "traffic": { + "description": "The wirefilter expression to be used for traffic matching.", + "example": "http.request.uri matches \".*a/partial/uri.*\" and http.request.host in $01302951-49f9-47c9-a400-0297e60b6a10", + "type": "string" + }, + "traffic_type": { + "default": "direct", + "description": "Determines how data travels from the edge to your origin. When set to \"direct\", Spectrum will send traffic directly to your origin, and the application's type is derived from the `protocol`. When set to \"http\" or \"https\", Spectrum will apply Cloudflare's HTTP/HTTPS features as it sends traffic to your origin, and the application type matches this property exactly.", + "enum": ["direct", "http", "https"], + "example": "direct", + "type": "string" + }, + "transfer_in": { + "description": "Statuses for domain transfers into Cloudflare Registrar.", + "properties": { + "accept_foa": { + "description": "Form of authorization has been accepted by the registrant.", + "example": "needed" + }, + "approve_transfer": { "description": "Shows transfer status with the registry.", "example": "unknown" }, + "can_cancel_transfer": { + "description": "Indicates if cancellation is still possible.", + "example": true, + "type": "boolean" + }, + "disable_privacy": { "description": "Privacy guards are disabled at the foreign registrar." }, + "enter_auth_code": { "description": "Auth code has been entered and verified.", "example": "needed" }, + "unlock_domain": { "description": "Domain is unlocked at the foreign registrar." } + } + }, + "transform-rules_components-schemas-action_parameters": { + "description": "The parameters configuring the action.", + "oneOf": [{ "$ref": "#/components/schemas/action_parameters_rewrite" }], + "type": "object" + }, + "transform-rules_components-schemas-rule": { + "properties": { + "action": { "example": "rewrite" }, + "action_parameters": { "$ref": "#/components/schemas/transform-rules_components-schemas-action_parameters" }, + "description": { "example": "change request based on ip location" }, + "expression": { "example": "ip.geoip.country eq \"AL\"" }, + "id": { "example": "3a03d665bac047339bb530ecb439a90d" }, + "version": { "example": "1" } + } + }, + "transform-rules_components-schemas-ruleset": { + "properties": { + "description": { "example": "" }, + "id": { "example": "2f2feab2026849078ba485f918791bdc" }, + "kind": { "example": "zone" }, + "name": { "example": "default" }, + "phase": { "example": "http_request_transform" }, + "rules": { + "description": "The rules in the ruleset.", + "items": { "$ref": "#/components/schemas/transform-rules_components-schemas-rule" }, + "type": "array" + } + } + }, + "true_client_ip_header": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { + "description": "ID of the zone setting.", + "enum": ["true_client_ip_header"], + "example": "true_client_ip_header" + }, + "value": { "$ref": "#/components/schemas/true_client_ip_header_value" } + } + } + ], + "default": "off", + "description": "Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones.", + "title": "True Client IP Header" + }, + "true_client_ip_header_value": { + "default": "off", + "description": "Value of the zone setting.", + "enum": ["on", "off"], + "type": "string" + }, + "tsig": { + "properties": { + "algo": { "$ref": "#/components/schemas/algo" }, + "id": { "$ref": "#/components/schemas/schemas-identifier-03kXbNiE" }, + "name": { "$ref": "#/components/schemas/schemas-name-rmJQq4HY" }, + "secret": { "$ref": "#/components/schemas/secret" } + }, + "required": ["id", "name", "secret", "algo"], + "type": "object" + }, + "tsig_id": { + "description": "TSIG authentication will be used for zone transfer if configured.", + "example": "69cd1e104af3e6ed3cb344f263fd0d5a", + "type": "string" + }, + "ttl": { + "default": 64, + "description": "Time To Live (TTL) in number of hops of the GRE tunnel.", + "type": "integer" + }, + "ttl-0jCBhfJ2": { + "description": "Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.", + "example": 30, + "type": "number" + }, + "ttl-Us5Qprrb": { + "anyOf": [ + { "example": 3600, "maximum": 86400, "minimum": 30, "type": "number" }, + { "enum": [1], "type": "number" } + ], + "default": 1, + "description": "Time To Live (TTL) of the DNS record in seconds. Setting to 1 means 'automatic'. Value must be between 60 and 86400, with the minimum reduced to 30 for Enterprise zones.", + "example": 3600, + "type": "number" + }, + "ttl-vFKh1wOV": { + "description": "Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.", + "example": 30, + "type": "number" + }, + "tunnel": { + "description": "A Cloudflare Tunnel that connects your origin to Cloudflare's edge.", + "properties": { + "account_tag": { "$ref": "#/components/schemas/cf_account_id" }, + "connections": { "$ref": "#/components/schemas/connections" }, + "conns_active_at": { "$ref": "#/components/schemas/conns_active_at" }, + "conns_inactive_at": { "$ref": "#/components/schemas/conns_inactive_at" }, + "created_at": { "$ref": "#/components/schemas/cloudflare-tunnel_components-schemas-created_at" }, + "deleted_at": { "$ref": "#/components/schemas/deleted_at-5nLnuPfs" }, + "id": { "$ref": "#/components/schemas/tunnel_id" }, + "metadata": { "$ref": "#/components/schemas/cloudflare-tunnel_components-schemas-metadata" }, + "name": { "$ref": "#/components/schemas/tunnel_name" }, + "remote_config": { "$ref": "#/components/schemas/remote_config" }, + "status": { "$ref": "#/components/schemas/cloudflare-tunnel_components-schemas-status" }, + "tun_type": { "$ref": "#/components/schemas/tunnel_type" } + }, + "type": "object" + }, + "tunnel_add_single_request": { + "properties": { + "cloudflare_gre_endpoint": { "$ref": "#/components/schemas/cloudflare_gre_endpoint" }, + "customer_gre_endpoint": { "$ref": "#/components/schemas/customer_gre_endpoint" }, + "description": { "$ref": "#/components/schemas/schemas-description-SitV9b51" }, + "health_check": { "$ref": "#/components/schemas/health_check" }, + "interface_address": { "$ref": "#/components/schemas/interface_address" }, + "mtu": { "$ref": "#/components/schemas/mtu" }, + "name": { "$ref": "#/components/schemas/name-z6BHq9UH" }, + "ttl": { "$ref": "#/components/schemas/ttl" } + }, + "required": ["name", "customer_gre_endpoint", "cloudflare_gre_endpoint", "interface_address"], + "type": "object" + }, + "tunnel_connection": { + "description": "A connection between cloudflared and a Cloudflare data center.", + "properties": { + "arch": { "$ref": "#/components/schemas/arch" }, + "config_version": { "$ref": "#/components/schemas/config_version" }, + "conns": { "$ref": "#/components/schemas/connections" }, + "features": { "$ref": "#/components/schemas/schemas-features" }, + "id": { "$ref": "#/components/schemas/connection_id" }, + "run_at": { "$ref": "#/components/schemas/run_at" }, + "version": { "$ref": "#/components/schemas/cloudflare-tunnel_components-schemas-version" } + }, + "type": "object" + }, + "tunnel_connections_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/tunnel_connection" }, "type": "array" } + }, + "type": "object" + } + ] + }, + "tunnel_deleted_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "deleted": { "example": true, "type": "boolean" }, + "deleted_gre_tunnel": { "type": "object" } + } + } + } + } + ] + }, + "tunnel_health_check": { + "properties": { + "enabled": { + "default": true, + "description": "Determines whether to run healthchecks for a tunnel.", + "example": true, + "type": "boolean" + }, + "rate": { + "default": "mid", + "description": "How frequent the health check is run. The default value is `mid`.", + "enum": ["low", "mid", "high"], + "example": "low", + "type": "string" + }, + "target": { + "description": "The destination address in a request type health check. After the healthcheck is decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded to this address. This field defaults to `customer_gre_endpoint address`.", + "example": "203.0.113.1", + "type": "string" + }, + "type": { + "default": "reply", + "description": "The type of healthcheck to run, reply or request. The default value is `reply`.", + "enum": ["reply", "request"], + "example": "request", + "type": "string" + } + }, + "type": "object" + }, + "tunnel_id": { + "description": "UUID of the tunnel.", + "example": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415", + "maxLength": 36, + "readOnly": true, + "type": "string" + }, + "tunnel_modified_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "modified": { "example": true, "type": "boolean" }, + "modified_gre_tunnel": { "type": "object" } + } + } + } + } + ] + }, + "tunnel_name": { "description": "A user-friendly name for the tunnel.", "example": "blog", "type": "string" }, + "tunnel_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { "result": { "items": { "$ref": "#/components/schemas/argo-tunnel" }, "type": "array" } }, + "type": "object" + } + ] + }, + "tunnel_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } }, "type": "object" } + ] + }, + "tunnel_response_token": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "string" } }, "type": "object" } + ] + }, + "tunnel_secret": { + "description": "Sets the password required to run a locally-managed tunnel. Must be at least 32 bytes and encoded as a base64 string.", + "example": "AQIDBAUGBwgBAgMEBQYHCAECAwQFBgcIAQIDBAUGBwg=", + "type": "string" + }, + "tunnel_single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "properties": { "gre_tunnel": { "type": "object" } } } } } + ] + }, + "tunnel_type": { + "description": "The type of tunnel.", + "enum": ["cfd_tunnel"], + "example": "cfd_tunnel", + "type": "string" + }, + "tunnel_update_request": { "allOf": [{ "$ref": "#/components/schemas/tunnel_add_single_request" }] }, + "tunnels_collection_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "gre_tunnels": { "items": { "$ref": "#/components/schemas/gre-tunnel" }, "type": "array" } + } + } + } + } + ] + }, + "tus_resumable": { + "description": "Specifies the TUS protocol version. This value must be included in every upload request.\nNotes: The only supported version of TUS protocol is 1.0.0.", + "enum": ["1.0.0"], + "example": "1.0.0", + "type": "string" + }, + "two_factor_authentication_enabled": { + "default": false, + "description": "Indicates whether two-factor authentication is enabled for the user account. Does not apply to API authentication.", + "readOnly": true, + "type": "boolean" + }, + "type": { + "description": "The type of List.", + "enum": ["SERIAL", "URL", "DOMAIN", "EMAIL", "IP"], + "example": "SERIAL", + "type": "string" + }, + "type-52Dm78wx": { + "description": "The billing item type.", + "example": "charge", + "maxLength": 30, + "readOnly": true, + "type": "string" + }, + "type-8rJfuYNQ": { + "default": "legacy_custom", + "description": "The type 'legacy_custom' enables support for legacy clients which do not include SNI in the TLS handshake.", + "enum": ["legacy_custom", "sni_custom"], + "example": "sni_custom", + "type": "string" + }, + "type-Eu3SX4l3": { + "default": "HTTP", + "description": "The protocol to use for the health check. Currently supported protocols are 'HTTP', 'HTTPS' and 'TCP'.", + "example": "HTTPS", + "type": "string" + }, + "type-gTI6cLgq": { + "default": "http", + "description": "The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'.", + "enum": ["http", "https", "tcp", "udp_icmp", "icmp_ping", "smtp"], + "example": "https", + "type": "string" + }, + "type-kxPaBgXc": { + "description": "A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup.", + "enum": ["full", "partial"], + "example": "full", + "type": "string" + }, + "type-tb4QXpPC": { + "description": "The type of Device Posture Rule.", + "enum": ["file", "application", "serial_number", "tanium", "gateway", "warp", "disk_encryption"], + "example": "file", + "type": "string" + }, + "type-u7orNcta": { + "description": "The application type.", + "enum": ["self_hosted", "saas", "ssh", "vnc", "app_launcher", "warp", "biso", "bookmark", "dash_sso"], + "example": "self_hosted", + "type": "string" + }, + "ua-rules": { "allOf": [{ "$ref": "#/components/schemas/firewalluablock" }], "type": "object" }, + "ua-rules_components-schemas-description": { + "description": "An informative summary of the rule.", + "example": "Prevent access from abusive clients identified by this User Agent to mitigate a DDoS attack", + "maxLength": 1024, + "type": "string" + }, + "ua-rules_components-schemas-id": { + "description": "The unique identifier of the User Agent Blocking rule.", + "example": "372e67954025e0ba6aaa6d586b9e0b59", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "ua-rules_components-schemas-mode": { + "description": "The action to apply to a matched request.", + "enum": ["block", "challenge", "js_challenge", "managed_challenge"], + "example": "js_challenge", + "maxLength": 12 + }, + "ui_read_only_toggle_reason": { + "description": "A description of the reason why the UI read only field is being toggled.", + "example": "Temporarily turn off the UI read only lock to make a change via the UI", + "type": "string" + }, + "uid": { "description": "The unique API identifier for the user." }, + "uniques": { + "properties": { + "all": { "description": "Total number of unique IP addresses within the time range.", "type": "integer" } + }, + "type": "object" + }, + "unit_price": { "description": "The unit price of the addon.", "example": 1, "readOnly": true, "type": "number" }, + "universal": { + "properties": { "enabled": { "$ref": "#/components/schemas/schemas-enabled" } }, + "type": "object" + }, + "unrevoke_devices_request": { + "description": "A list of device ids to unrevoke.", + "items": { "$ref": "#/components/schemas/uuid-s0SXln0q" }, + "maxLength": 200, + "type": "array" + }, + "unrevoke_devices_request-bkyFobOE": { + "description": "A list of device ids to unrevoke.", + "items": { "$ref": "#/components/schemas/schemas-uuid-lt6l49Ob" }, + "maxLength": 200, + "type": "array" + }, + "until": { + "description": "End date and time of requesting data period in ISO 8601 format.", + "example": "2023-11-11T13:00:00Z", + "format": "date-time", + "type": "string" + }, + "until-HpHDrENT": { + "anyOf": [{ "type": "string" }, { "type": "integer" }], + "default": 0, + "description": "The (exclusive) end of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. If omitted, the time of the request is used.", + "example": "2015-01-02T12:23:00Z" + }, + "until-XGNiH7hs": { + "description": "End date and time of requesting data period in the ISO8601 format.", + "example": "2016-11-11T13:00:00Z", + "format": "date-time", + "type": "string" + }, + "update-zone-settings-response": { + "properties": { + "enabled": { "$ref": "#/components/schemas/enabled-N6CliIvj" }, + "updated_at": { "$ref": "#/components/schemas/updated_at" }, + "use_cloudflare_reporting_endpoint": { "$ref": "#/components/schemas/use_cloudflare_reporting_endpoint" }, + "use_connection_url_path": { "$ref": "#/components/schemas/use_connection_url_path" } + } + }, + "update_catch_all_rule_properties": { + "properties": { + "actions": { "$ref": "#/components/schemas/rule_catchall-actions" }, + "enabled": { "$ref": "#/components/schemas/rule_enabled-VMnvyEOL" }, + "matchers": { "$ref": "#/components/schemas/rule_catchall-matchers" }, + "name": { "$ref": "#/components/schemas/rule_name" } + }, + "required": ["actions", "matchers"], + "type": "object" + }, + "update_custom_profile": { + "properties": { + "allowed_match_count": { "$ref": "#/components/schemas/allowed_match_count" }, + "description": { + "description": "The description of the profile.", + "example": "A standard CVV card number", + "type": "string" + }, + "entries": { + "description": "The custom entries for this profile. Array elements with IDs are modifying the existing entry with that ID. Elements without ID will create new entries. Any entry not in the list will be deleted.", + "items": { "$ref": "#/components/schemas/custom_entry" }, + "type": "array" + }, + "name": { "description": "The name of the profile.", "example": "Generic CVV Card Number", "type": "string" }, + "shared_entries": { + "description": "Entries from other profiles (e.g. pre-defined Cloudflare profiles, or your Microsoft Information Protection profiles).", + "items": { + "oneOf": [ + { "$ref": "#/components/schemas/shared_entry_update_predefined" }, + { "$ref": "#/components/schemas/shared_entry_update_integration" } + ] + }, + "type": "array" + } + }, + "title": "Update custom profile", + "type": "object" + }, + "update_custom_profile-j98uzXOJ": { + "properties": { + "allowed_match_count": { "$ref": "#/components/schemas/allowed_match_count" }, + "description": { + "description": "The description of the profile.", + "example": "A standard CVV card number", + "type": "string" + }, + "entries": { + "description": "The entries for this profile. Array elements with IDs are modifying the existing entry with that ID. Elements without ID will create new entries. Any entry not in the list will be deleted.", + "items": { "$ref": "#/components/schemas/custom_entry-jOfsrCYH" }, + "type": "array" + }, + "name": { "description": "The name of the profile.", "example": "Generic CVV Card Number", "type": "string" } + }, + "title": "Update custom profile", + "type": "object" + }, + "update_input_request": { + "properties": { + "defaultCreator": { "$ref": "#/components/schemas/live_input_default_creator" }, + "meta": { "$ref": "#/components/schemas/live_input_metadata" }, + "recording": { "$ref": "#/components/schemas/live_input_recording_settings" } + } + }, + "update_output_request": { + "properties": { "enabled": { "$ref": "#/components/schemas/output_enabled" } }, + "required": ["enabled"] + }, + "update_predefined_profile": { + "properties": { + "allowed_match_count": { "$ref": "#/components/schemas/allowed_match_count" }, + "entries": { + "description": "The entries for this profile.", + "items": { + "properties": { + "enabled": { "description": "Wheter the entry is enabled or not.", "example": true, "type": "boolean" }, + "id": { "$ref": "#/components/schemas/entry_id-A2p6ZYit" } + } + }, + "type": "array" + } + }, + "title": "Update predefined profile", + "type": "object" + }, + "update_rule_properties": { + "properties": { + "actions": { "$ref": "#/components/schemas/rule_actions" }, + "enabled": { "$ref": "#/components/schemas/rule_enabled-VMnvyEOL" }, + "matchers": { "$ref": "#/components/schemas/rule_matchers" }, + "name": { "$ref": "#/components/schemas/rule_name" }, + "priority": { "$ref": "#/components/schemas/rule_priority" } + }, + "required": ["actions", "matchers"], + "type": "object" + }, + "update_rules": { "items": { "$ref": "#/components/schemas/create_rule" }, "type": "array" }, + "update_ruleset": { + "description": "A ruleset object.", + "properties": { + "description": { "$ref": "#/components/schemas/rulesets_components-schemas-description" }, + "rules": { "$ref": "#/components/schemas/create_update_rules" } + }, + "required": ["rules"], + "type": "object" + }, + "update_settings": { + "description": "Payload log settings", + "properties": { + "public_key": { + "description": "The public key to use when encrypting extracted payloads, as a base64 string", + "example": "EmpOvSXw8BfbrGCi0fhGiD/3yXk2SiV1Nzg2lru3oj0=", + "nullable": true, + "type": "string" + } + }, + "required": ["public_key"], + "title": "Settings", + "type": "object" + }, + "update_settings_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "public_key": { + "example": "EmpOvSXw8BfbrGCi0fhGiD/3yXk2SiV1Nzg2lru3oj0=", + "nullable": true, + "type": "string" + } + }, + "required": ["public_key"] + } + } + } + ] + }, + "updated": { + "description": "When the device was updated.", + "example": "2017-06-14T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "updated_at": { + "description": "The timestamp of when Page Shield was last updated.", + "example": "2022-10-12T17:56:52.083582+01:00", + "type": "string" + }, + "updated_at-AejnlvA8": { + "description": "The time when the certificate was updated.", + "example": "2100-01-01T05:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "updated_at-W25UuRZk": { + "description": "The time when the certificate was updated.", + "example": "2100-01-01T05:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "upgrade_info": { + "description": "Defined when the Railgun version is out of date from the latest release from Cloudflare.", + "properties": { + "download_link": { + "description": "An HTTP link to download the latest Railgun binary.", + "example": "https://www.cloudflare.com/downloads/railgun", + "type": "string" + }, + "latest_version": { + "description": "Latest version of the Railgun receiver available to install.", + "example": "1.0.0", + "type": "string" + } + }, + "type": "object" + }, + "upload_length": { + "description": "Indicates the size of the entire upload in bytes. The value must be a non-negative integer.", + "minimum": 0, + "type": "integer" + }, + "uploaded": { + "description": "When the media item was uploaded.", + "example": "2014-01-02T02:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "uploaded-3C8O7sGT": { + "description": "The date and time the media item was uploaded.", + "example": "2014-01-02T02:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "uploaded_on": { + "description": "When the certificate was uploaded to Cloudflare.", + "example": "2014-01-01T05:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "uptycs_config_request": { + "properties": { + "client_key": { + "description": "The Uptycs client secret.", + "example": "example client key", + "type": "string" + }, + "client_secret": { + "description": "The Uptycs client secret.", + "example": "example client secret", + "type": "string" + }, + "customer_id": { + "description": "The Uptycs customer ID.", + "example": "example customer id", + "type": "string" + } + }, + "required": ["client_key", "customer_id", "client_secret"], + "type": "object" + }, + "uri_search": { + "description": "A single URI to search for in the list of URLs of existing rules.", + "example": "/some/path", + "type": "string" + }, + "url": { + "default": "", + "description": "The URL associated with the custom page.", + "example": "http://www.example.com", + "format": "uri", + "type": "string" + }, + "url_id": { "description": "Submission ID(s) to filter submission results by.", "type": "integer" }, + "url_id_param": { "properties": { "url_id": { "$ref": "#/components/schemas/url_id" } }, "type": "object" }, + "url_normalization_components-schemas-type": { + "description": "The type of URL normalization performed by Cloudflare.", + "example": "cloudflare", + "type": "string" + }, + "url_param": { + "properties": { "url": { "$ref": "#/components/schemas/components-schemas-url" } }, + "type": "object" + }, + "url_target": { + "description": "URL target.", + "properties": { + "constraint": { + "allOf": [ + { "$ref": "#/components/schemas/string_constraint" }, + { + "properties": { + "value": { + "description": "The URL pattern to match against the current request. The pattern may contain up to four asterisks ('*') as placeholders.", + "example": "*example.com/images/*", + "pattern": "^(https?://)?(([-a-zA-Z0-9*]*\\.)+[-a-zA-Z0-9]{2,20})(:(8080|8443|443|80))?(/[\\S]+)?$", + "type": "string" + } + } + } + ], + "description": "The constraint of a target.", + "type": "object" + }, + "target": { "description": "A target based on the URL of the request.", "enum": ["url"], "example": "url" } + }, + "type": "object" + }, + "urls": { + "description": "The URLs to include in the current WAF override. You can use wildcards. Each entered URL will be escaped before use, which means you can only use simple wildcard patterns.", + "items": { "example": "shop.example.com/*", "type": "string" }, + "type": "array" + }, + "usage-model-response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { "properties": { "result": { "properties": { "usage_model": { "readOnly": true } }, "type": "object" } } } + ] + }, + "usage_model": { + "description": "Specifies the usage model for the Worker (e.g. 'bundled' or 'unbound').", + "example": "unbound", + "pattern": "^(bundled|unbound)$", + "type": "string" + }, + "use_cloudflare_reporting_endpoint": { + "description": "When true, CSP reports will be sent to https://csp-reporting.cloudflare.com/cdn-cgi/script_monitor/report", + "example": true, + "type": "boolean" + }, + "use_connection_url_path": { + "description": "When true, the paths associated with connections URLs will also be analyzed.", + "example": true, + "type": "boolean" + }, + "user": { + "properties": { + "email": { "$ref": "#/components/schemas/email-sNyq81Xd" }, + "id": { "$ref": "#/components/schemas/uuid-s0SXln0q" }, + "name": { "description": "The enrolled device user's name.", "example": "John Appleseed", "type": "string" } + }, + "type": "object" + }, + "user-L6j8gcON": { + "properties": { + "email": { "$ref": "#/components/schemas/email-rXr4fRvz" }, + "id": { "$ref": "#/components/schemas/components-schemas-uuid-nWj9wBDf" }, + "name": { "description": "The enrolled device user's name.", "example": "John Appleseed", "type": "string" } + }, + "type": "object" + }, + "user_invite": { + "allOf": [ + { "$ref": "#/components/schemas/base-bSfRyaRZ" }, + { + "properties": { + "status": { + "description": "Current status of the invitation.", + "enum": ["pending", "accepted", "rejected", "expired"], + "example": "accepted" + } + } + } + ] + }, + "user_seat_expiration_inactive_time": { + "description": "The amount of time a user seat is inactive before it expires. When the user seat exceeds the set time of inactivity, the user is removed as an active seat and no longer counts against your Teams seat count. Must be in the format `300ms` or `2h45m`. Valid time units are: `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`.", + "example": "720h", + "type": "string" + }, + "user_subscription_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { "result": { "items": { "$ref": "#/components/schemas/subscription" }, "type": "array" } }, + "type": "object" + } + ] + }, + "user_subscription_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } }, "type": "object" } + ] + }, + "users": { + "properties": { + "access_seat": { "$ref": "#/components/schemas/schemas-access_seat" }, + "active_device_count": { "$ref": "#/components/schemas/active_device_count" }, + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "email": { "$ref": "#/components/schemas/schemas-email" }, + "gateway_seat": { "$ref": "#/components/schemas/schemas-gateway_seat" }, + "id": { "$ref": "#/components/schemas/schemas-id" }, + "last_successful_login": { "$ref": "#/components/schemas/last_successful_login" }, + "name": { "$ref": "#/components/schemas/users_components-schemas-name" }, + "seat_uid": { "$ref": "#/components/schemas/seat_uid" }, + "uid": { "$ref": "#/components/schemas/uid" }, + "updated_at": { "$ref": "#/components/schemas/timestamp" } + }, + "type": "object" + }, + "users-OYnvPFO3": { + "properties": { + "access_seat": { "$ref": "#/components/schemas/schemas-access_seat" }, + "active_device_count": { "$ref": "#/components/schemas/active_device_count" }, + "created_at": { "$ref": "#/components/schemas/timestamp" }, + "email": { "$ref": "#/components/schemas/components-schemas-email" }, + "gateway_seat": { "$ref": "#/components/schemas/schemas-gateway_seat" }, + "id": { "$ref": "#/components/schemas/users_components-schemas-id" }, + "last_successful_login": { "$ref": "#/components/schemas/last_successful_login" }, + "name": { "$ref": "#/components/schemas/users_components-schemas-name" }, + "seat_uid": { "$ref": "#/components/schemas/seat_uid" }, + "uid": { "$ref": "#/components/schemas/uid" }, + "updated_at": { "$ref": "#/components/schemas/timestamp" } + }, + "type": "object" + }, + "users_components-schemas-id": { + "description": "The ID of the user.", + "example": "f3b12456-80dd-4e89-9f5f-ba3dfff12365" + }, + "users_components-schemas-name": { + "description": "The name of the user.", + "example": "Jane Doe", + "type": "string" + }, + "users_components-schemas-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result_info": { + "properties": { + "count": { "example": 1 }, + "page": { "example": 1 }, + "per_page": { "example": 100 }, + "total_count": { "example": 1 } + }, + "type": "object" + } + } + }, + { + "properties": { "result": { "items": { "$ref": "#/components/schemas/users-OYnvPFO3" }, "type": "array" } } + } + ] + }, + "uuid": { + "description": "API Resource UUID tag.", + "example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", + "maxLength": 36, + "type": "string" + }, + "uuid-EBZK5Bp1": { + "description": "UUID", + "example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", + "maxLength": 36, + "readOnly": true, + "type": "string" + }, + "uuid-l20MFQPz": { + "description": "API uuid tag.", + "example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", + "maxLength": 36, + "type": "string" + }, + "uuid-lbOWhPVX": { + "description": "UUID", + "example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", + "maxLength": 36, + "readOnly": true, + "type": "string" + }, + "uuid-s0SXln0q": { + "description": "UUID", + "example": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415", + "maxLength": 36, + "readOnly": true, + "type": "string" + }, + "validate_ownership_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { + "properties": { + "result": { + "nullable": true, + "properties": { "valid": { "example": true, "type": "boolean" } }, + "type": "object" + } + } + } + ] + }, + "validate_pattern": { + "description": "A request to validate a pattern", + "properties": { "regex": { "description": "The regex pattern.", "example": "^4[0-9]{6,}$", "type": "string" } }, + "required": ["regex"], + "title": "Pattern", + "type": "object" + }, + "validate_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "properties": { "valid": { "example": true, "type": "boolean" } } } } } + ] + }, + "validate_response-PaQpkUV3": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { + "properties": { + "result": { + "nullable": true, + "properties": { + "message": { "example": "", "type": "string" }, + "valid": { "example": true, "type": "boolean" } + }, + "type": "object" + } + } + } + ] + }, + "validation_method": { + "description": "Validation Method selected for the order.", + "enum": ["txt", "http", "email"], + "example": "txt", + "type": "string" + }, + "validation_method_components-schemas-status": { + "description": "Result status.", + "example": "pending_validation", + "type": "string" + }, + "validation_method_definition": { + "description": "Desired validation method.", + "enum": ["http", "cname", "txt", "email"], + "example": "txt", + "type": "string" + }, + "validation_record": { + "description": "Certificate's required validation record.", + "properties": { + "emails": { + "description": "The set of email addresses that the certificate authority (CA) will use to complete domain validation.", + "example": ["administrator@example.com", "webmaster@example.com"], + "items": {}, + "type": "array" + }, + "http_body": { + "description": "The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.", + "example": "ca3-574923932a82475cb8592200f1a2a23d", + "type": "string" + }, + "http_url": { + "description": "The url that will be checked during domain validation.", + "example": "http://app.example.com/.well-known/pki-validation/ca3-da12a1c25e7b48cf80408c6c1763b8a2.txt", + "type": "string" + }, + "txt_name": { + "description": "The hostname that the certificate authority (CA) will check for a TXT record during domain validation .", + "example": "_acme-challenge.app.example.com", + "type": "string" + }, + "txt_value": { + "description": "The TXT record that the certificate authority (CA) will check during domain validation.", + "example": "810b7d5f01154524b961ba0cd578acc2", + "type": "string" + } + }, + "type": "object" + }, + "validity_days": { + "description": "Validity Days selected for the order.", + "enum": [14, 30, 90, 365], + "type": "integer" + }, + "value": { "description": "The value of the item in a List.", "example": "8GE8721REF", "type": "string" }, + "value-V4GUo1Bz": { + "description": "The token value.", + "example": "8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T", + "maxLength": 80, + "minLength": 40, + "readOnly": true, + "type": "string" + }, + "vanity_name_servers": { + "description": "An array of domains used for custom name servers. This is only\navailable for Business and Enterprise plans.", + "example": ["ns1.example.com", "ns2.example.com"], + "items": { "format": "hostname", "maxLength": 253, "type": "string" }, + "type": "array" + }, + "variant_generation_request": { + "properties": { + "id": { "$ref": "#/components/schemas/variants_components-schemas-identifier" }, + "neverRequireSignedURLs": { "$ref": "#/components/schemas/neverRequireSignedURLs" }, + "options": { "$ref": "#/components/schemas/options" } + }, + "required": ["id", "options"], + "type": "object" + }, + "variant_list_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "$ref": "#/components/schemas/variants_response" } } } + ] + }, + "variant_patch_request": { + "properties": { + "neverRequireSignedURLs": { "$ref": "#/components/schemas/neverRequireSignedURLs" }, + "options": { "$ref": "#/components/schemas/options" } + }, + "required": ["options"], + "type": "object" + }, + "variant_public_request": { "properties": { "hero": { "type": "object" } }, "type": "object" }, + "variant_response": { "properties": { "variant": { "type": "object" } }, "type": "object" }, + "variant_simple_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/variant_response" } } } + ] + }, + "variants": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-base" }, + { + "properties": { + "id": { "description": "ID of the zone setting.", "enum": ["variants"], "example": "variants" } + } + } + ], + "description": "Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.", + "title": "Variants Caching" + }, + "variants_components-schemas-identifier": { "example": "hero", "maxLength": 99, "pattern": "^[a-zA-Z0-9]$" }, + "variants_response": { + "properties": { "variants": { "$ref": "#/components/schemas/variant_public_request" } }, + "type": "object" + }, + "variants_response_value": { + "properties": { + "result": { + "allOf": [ + { "$ref": "#/components/schemas/variants" }, + { "properties": { "value": { "$ref": "#/components/schemas/variants_value" } }, "required": ["value"] } + ] + } + } + }, + "variants_value": { + "description": "Value of the zone setting.", + "properties": { + "avif": { + "description": "List of strings with the MIME types of all the variants that should be served for avif.", + "example": ["image/webp", "image/jpeg"], + "items": {}, + "type": "array", + "uniqueItems": true + }, + "bmp": { + "description": "List of strings with the MIME types of all the variants that should be served for bmp.", + "example": ["image/webp", "image/jpeg"], + "items": {}, + "type": "array", + "uniqueItems": true + }, + "gif": { + "description": "List of strings with the MIME types of all the variants that should be served for gif.", + "example": ["image/webp", "image/jpeg"], + "items": {}, + "type": "array", + "uniqueItems": true + }, + "jp2": { + "description": "List of strings with the MIME types of all the variants that should be served for jp2.", + "example": ["image/webp", "image/avif"], + "items": {}, + "type": "array", + "uniqueItems": true + }, + "jpeg": { + "description": "List of strings with the MIME types of all the variants that should be served for jpeg.", + "example": ["image/webp", "image/avif"], + "items": {}, + "type": "array", + "uniqueItems": true + }, + "jpg": { + "description": "List of strings with the MIME types of all the variants that should be served for jpg.", + "example": ["image/webp", "image/avif"], + "items": {}, + "type": "array", + "uniqueItems": true + }, + "jpg2": { + "description": "List of strings with the MIME types of all the variants that should be served for jpg2.", + "example": ["image/webp", "image/avif"], + "items": {}, + "type": "array", + "uniqueItems": true + }, + "png": { + "description": "List of strings with the MIME types of all the variants that should be served for png.", + "example": ["image/webp", "image/avif"], + "items": {}, + "type": "array", + "uniqueItems": true + }, + "tif": { + "description": "List of strings with the MIME types of all the variants that should be served for tif.", + "example": ["image/webp", "image/avif"], + "items": {}, + "type": "array", + "uniqueItems": true + }, + "tiff": { + "description": "List of strings with the MIME types of all the variants that should be served for tiff.", + "example": ["image/webp", "image/avif"], + "items": {}, + "type": "array", + "uniqueItems": true + }, + "webp": { + "description": "List of strings with the MIME types of all the variants that should be served for webp.", + "example": ["image/jpeg", "image/avif"], + "items": {}, + "type": "array", + "uniqueItems": true + } + }, + "type": "object" + }, + "verification": { + "properties": { + "brand_check": { "$ref": "#/components/schemas/brand_check" }, + "cert_pack_uuid": { "$ref": "#/components/schemas/cert_pack_uuid" }, + "certificate_status": { "$ref": "#/components/schemas/certificate_status" }, + "signature": { "$ref": "#/components/schemas/schemas-signature" }, + "validation_method": { "$ref": "#/components/schemas/schemas-validation_method" }, + "verification_info": { "$ref": "#/components/schemas/verification_info" }, + "verification_status": { "$ref": "#/components/schemas/verification_status" }, + "verification_type": { "$ref": "#/components/schemas/verification_type" } + }, + "required": ["certificate_status"], + "type": "object" + }, + "verification_errors": { + "description": "These are errors that were encountered while trying to activate a hostname.", + "example": [ + "None of the A or AAAA records are owned by this account and the pre-generated ownership verification token was not found." + ], + "items": {}, + "type": "array" + }, + "verification_info": { + "description": "Certificate's required verification information.", + "enum": [ + "record_name", + "record_value", + "http_url", + "http_body", + "cname", + "cname_target", + "txt_name", + "txt_value" + ], + "properties": { + "record_name": { + "description": "Name of CNAME record.", + "example": "b3b90cfedd89a3e487d3e383c56c4267.example.com", + "format": "hostname", + "type": "string" + }, + "record_target": { + "description": "Target of CNAME record.", + "example": "6979be7e4cfc9e5c603e31df7efac9cc60fee82d.comodoca.com", + "format": "hostname", + "type": "string" + } + }, + "type": "object" + }, + "verification_status": { + "description": "Status of the required verification information, omitted if verification status is unknown.", + "example": true, + "type": "boolean" + }, + "verification_type": { + "description": "Method of verification.", + "enum": ["cname", "meta tag"], + "example": "cname", + "type": "string" + }, + "verified": { + "description": "The date and time the destination address has been verified. Null means not verified yet.", + "example": "2014-01-02T02:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "version": { + "description": "The version of the analyzed script.", + "properties": { + "fetched_at": { "$ref": "#/components/schemas/fetched_at" }, + "hash": { "$ref": "#/components/schemas/hash" }, + "js_integrity_score": { "$ref": "#/components/schemas/js_integrity_score" } + }, + "type": "object" + }, + "version-SGF9qNGE": { "description": "The WARP client version.", "example": "1.0.0", "type": "string" }, + "version-VHkxmcSG": { + "description": "The version of the ruleset.", + "example": "1", + "pattern": "^[0-9]+$", + "type": "string" + }, + "videoClipStandard": { + "properties": { + "allowedOrigins": { "$ref": "#/components/schemas/allowedOrigins" }, + "clippedFromVideoUID": { "$ref": "#/components/schemas/clipped_from_video_uid" }, + "creator": { "$ref": "#/components/schemas/creator" }, + "endTimeSeconds": { "$ref": "#/components/schemas/end_time_seconds" }, + "maxDurationSeconds": { "$ref": "#/components/schemas/maxDurationSeconds" }, + "requireSignedURLs": { "$ref": "#/components/schemas/requireSignedURLs-9DKWYMwu" }, + "startTimeSeconds": { "$ref": "#/components/schemas/start_time_seconds" }, + "thumbnailTimestampPct": { "$ref": "#/components/schemas/thumbnailTimestampPct" }, + "watermark": { "$ref": "#/components/schemas/watermarkAtUpload" } + }, + "required": ["clippedFromVideoUID", "startTimeSeconds", "endTimeSeconds"], + "type": "object" + }, + "video_copy_request": { + "properties": { + "allowedOrigins": { "$ref": "#/components/schemas/allowedOrigins" }, + "creator": { "$ref": "#/components/schemas/creator" }, + "requireSignedURLs": { "$ref": "#/components/schemas/requireSignedURLs-9DKWYMwu" }, + "thumbnailTimestampPct": { "$ref": "#/components/schemas/thumbnailTimestampPct" }, + "url": { + "description": "A video's URL. The server must be publicly routable and support `HTTP HEAD` requests and `HTTP GET` range requests. The server should respond to `HTTP HEAD` requests with a `content-range` header that includes the size of the file.", + "example": "https://example.com/myvideo.mp4", + "format": "uri", + "type": "string" + }, + "watermark": { "$ref": "#/components/schemas/watermark_at_upload" } + }, + "required": ["url"] + }, + "video_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/videos" }, "type": "array" } } }, + { + "properties": { + "range": { + "description": "The total number of remaining videos based on cursor position.", + "example": 1000, + "readOnly": true, + "type": "integer" + }, + "total": { + "description": "The total number of videos that match the provided filters.", + "example": 35586, + "readOnly": true, + "type": "integer" + } + } + } + ] + }, + "video_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/videos" } } } + ] + }, + "video_update": { + "properties": { + "allowedOrigins": { "$ref": "#/components/schemas/allowedOrigins" }, + "creator": { "$ref": "#/components/schemas/creator" }, + "maxDurationSeconds": { "$ref": "#/components/schemas/maxDurationSeconds" }, + "meta": { "$ref": "#/components/schemas/media_metadata" }, + "requireSignedURLs": { "$ref": "#/components/schemas/requireSignedURLs-9DKWYMwu" }, + "thumbnailTimestampPct": { "$ref": "#/components/schemas/thumbnailTimestampPct" }, + "uploadExpiry": { "$ref": "#/components/schemas/oneTimeUploadExpiry" } + }, + "type": "object" + }, + "videos": { + "properties": { + "allowedOrigins": { "$ref": "#/components/schemas/allowedOrigins" }, + "created": { "$ref": "#/components/schemas/created-GBc463rN" }, + "creator": { "$ref": "#/components/schemas/creator" }, + "duration": { "$ref": "#/components/schemas/duration-nfHavjWr" }, + "input": { "$ref": "#/components/schemas/input-kvQ6FpFL" }, + "liveInput": { "$ref": "#/components/schemas/liveInput" }, + "maxDurationSeconds": { "$ref": "#/components/schemas/maxDurationSeconds" }, + "meta": { "$ref": "#/components/schemas/media_metadata" }, + "modified": { "$ref": "#/components/schemas/modified-5P46cImn" }, + "playback": { "$ref": "#/components/schemas/playback" }, + "preview": { "$ref": "#/components/schemas/preview" }, + "readyToStream": { "$ref": "#/components/schemas/readyToStream" }, + "requireSignedURLs": { "$ref": "#/components/schemas/requireSignedURLs-9DKWYMwu" }, + "size": { "$ref": "#/components/schemas/size" }, + "status": { "$ref": "#/components/schemas/media_status" }, + "thumbnail": { "$ref": "#/components/schemas/thumbnail_url-GZVIYimZ" }, + "thumbnailTimestampPct": { "$ref": "#/components/schemas/thumbnailTimestampPct" }, + "uid": { "$ref": "#/components/schemas/identifier-XSj9HnWY" }, + "uploadExpiry": { "$ref": "#/components/schemas/oneTimeUploadExpiry" }, + "uploaded": { "$ref": "#/components/schemas/uploaded-3C8O7sGT" }, + "watermark": { "$ref": "#/components/schemas/watermarks" } + }, + "type": "object" + }, + "virtual-network": { + "properties": { + "comment": { "$ref": "#/components/schemas/schemas-comment" }, + "created_at": { "description": "Timestamp of when the virtual network was created." }, + "deleted_at": { + "description": "Timestamp of when the virtual network was deleted. If `null`, the virtual network has not been deleted." + }, + "id": { "$ref": "#/components/schemas/vnet_id" }, + "is_default_network": { "$ref": "#/components/schemas/is_default_network" }, + "name": { "$ref": "#/components/schemas/vnet_name" } + }, + "required": ["id", "name", "is_default_network", "comment", "created_at"], + "type": "object" + }, + "virtual_network_id": { + "description": "The virtual network subnet ID the origin belongs in. Virtual network must also belong to the account.", + "example": "a5624d4e-044a-4ff0-b3e1-e2465353d4b4", + "type": "string" + }, + "vnc_props": { + "allOf": [ + { "$ref": "#/components/schemas/self_hosted_props-pFu7lQyL" }, + { "properties": { "type": { "description": "The application type.", "example": "vnc", "type": "string" } } } + ] + }, + "vnet_id": { + "description": "UUID of the virtual network.", + "example": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415", + "maxLength": 36, + "readOnly": true, + "type": "string" + }, + "vnet_name": { + "description": "A user-friendly name for the virtual network.", + "example": "us-east-1-vpc", + "type": "string" + }, + "vnet_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/virtual-network" }, "type": "array" } + }, + "type": "object" + } + ] + }, + "vnet_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } }, "type": "object" } + ] + }, + "waf": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { "description": "ID of the zone setting.", "enum": ["waf"], "example": "waf" }, + "value": { "$ref": "#/components/schemas/waf_value" } + } + } + ], + "description": "The WAF examines HTTP requests to your website. It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will 'challenge' the web visitor with a page that asks them to submit a CAPTCHA successfully to continue their action. If the challenge is failed, the action will be stopped. What this means is that Cloudflare's WAF will block any traffic identified as illegitimate before it reaches your origin web server. (https://support.cloudflare.com/hc/en-us/articles/200172016).", + "title": "Web Application Firewall" + }, + "waf_action": { + "description": "The WAF rule action to apply.", + "enum": ["challenge", "block", "simulate", "disable", "default"] + }, + "waf_rewrite_action": { + "description": "The WAF rule action to apply.", + "enum": ["challenge", "block", "simulate", "disable", "default"] + }, + "waf_value": { + "default": "off", + "description": "Value of the zone setting.", + "enum": ["on", "off"], + "type": "string" + }, + "wait_time": { + "default": 1, + "description": "Set the time (in seconds) to wait for a response to a probe.", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, + "waiting_room_id": { "example": "699d98642c564d2e855e9661899b7252" }, + "waiting_room_id_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { "properties": { "id": { "$ref": "#/components/schemas/waiting_room_id" } }, "type": "object" } + } + } + ] + }, + "waitingroom": { + "properties": { + "cookie_attributes": { "$ref": "#/components/schemas/cookie_attributes" }, + "created_on": { "$ref": "#/components/schemas/timestamp" }, + "custom_page_html": { "$ref": "#/components/schemas/custom_page_html" }, + "default_template_language": { "$ref": "#/components/schemas/default_template_language" }, + "description": { "$ref": "#/components/schemas/description-DIf6mz41" }, + "disable_session_renewal": { "$ref": "#/components/schemas/disable_session_renewal" }, + "host": { "$ref": "#/components/schemas/host" }, + "id": { "$ref": "#/components/schemas/waiting_room_id" }, + "json_response_enabled": { "$ref": "#/components/schemas/json_response_enabled" }, + "modified_on": { "$ref": "#/components/schemas/timestamp" }, + "name": { "$ref": "#/components/schemas/name-jYNmruXY" }, + "new_users_per_minute": { "$ref": "#/components/schemas/new_users_per_minute" }, + "next_event_prequeue_start_time": { "$ref": "#/components/schemas/next_event_prequeue_start_time" }, + "next_event_start_time": { "$ref": "#/components/schemas/next_event_start_time" }, + "path": { "$ref": "#/components/schemas/path" }, + "queue_all": { "$ref": "#/components/schemas/queue_all" }, + "queueing_method": { "$ref": "#/components/schemas/queueing_method" }, + "session_duration": { "$ref": "#/components/schemas/session_duration" }, + "suspended": { "$ref": "#/components/schemas/suspended-qdpN2ZN2" }, + "total_active_users": { "$ref": "#/components/schemas/total_active_users" } + }, + "type": "object" + }, + "warp_props": { + "allOf": [ + { "$ref": "#/components/schemas/feature_app_props-g2VC0WUC" }, + { + "properties": { + "domain": { "example": "authdomain.cloudflareaccess.com/warp", "readOnly": true }, + "name": { "default": "Warp Login App", "example": "Warp Login App", "readOnly": true }, + "type": { "description": "The application type.", "example": "warp", "type": "string" } + } + } + ] + }, + "wasm_module_binding": { + "properties": { + "name": { "$ref": "#/components/schemas/binding_name" }, + "type": { + "description": "The class of resource that the binding provides.", + "enum": ["wasm_module"], + "example": "wasm_module", + "type": "string" + } + }, + "required": ["name", "type"], + "type": "object" + }, + "watermarkAtUpload": { + "properties": { + "uid": { + "description": "The unique identifier for the watermark profile.", + "example": "ea95132c15732412d22c1476fa83f27a", + "maxLength": 32, + "type": "string" + } + }, + "type": "object" + }, + "watermark_at_upload": { + "properties": { + "uid": { + "description": "The unique identifier for the watermark profile.", + "example": "ea95132c15732412d22c1476fa83f27a", + "maxLength": 32, + "type": "string" + } + }, + "type": "object" + }, + "watermark_basic_upload": { + "properties": { + "file": { + "description": "The image file to upload.", + "example": "@/Users/rchen/Downloads/watermark.png", + "type": "string" + }, + "name": { "$ref": "#/components/schemas/name-0M1mwjDs" }, + "opacity": { "$ref": "#/components/schemas/opacity" }, + "padding": { "$ref": "#/components/schemas/padding" }, + "position": { "$ref": "#/components/schemas/position" }, + "scale": { "$ref": "#/components/schemas/scale" } + }, + "required": ["file"], + "type": "object" + }, + "watermark_created": { + "description": "The date and a time a watermark profile was created.", + "example": "2014-01-02T02:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "watermark_identifier": { + "description": "The unique identifier for a watermark profile.", + "example": "ea95132c15732412d22c1476fa83f27a", + "maxLength": 32, + "readOnly": true, + "type": "string" + }, + "watermark_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/watermarks" }, "type": "array" } } } + ] + }, + "watermark_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } } } + ] + }, + "watermark_size": { + "description": "The size of the image in bytes.", + "example": 29472, + "readOnly": true, + "type": "number" + }, + "watermarks": { + "properties": { + "created": { "$ref": "#/components/schemas/watermark_created" }, + "downloadedFrom": { "$ref": "#/components/schemas/downloadedFrom" }, + "height": { "$ref": "#/components/schemas/height-YS9whiRo" }, + "name": { "$ref": "#/components/schemas/name-0M1mwjDs" }, + "opacity": { "$ref": "#/components/schemas/opacity" }, + "padding": { "$ref": "#/components/schemas/padding" }, + "position": { "$ref": "#/components/schemas/position" }, + "scale": { "$ref": "#/components/schemas/scale" }, + "size": { "$ref": "#/components/schemas/watermark_size" }, + "uid": { "$ref": "#/components/schemas/watermark_identifier" }, + "width": { "$ref": "#/components/schemas/width-bMHL5ne3" } + }, + "type": "object" + }, + "web3-hostname": { + "properties": { + "created_on": { "$ref": "#/components/schemas/timestamp" }, + "description": { "$ref": "#/components/schemas/web3-hostname_components-schemas-description" }, + "dnslink": { "$ref": "#/components/schemas/dnslink" }, + "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" }, + "modified_on": { "$ref": "#/components/schemas/timestamp" }, + "name": { "$ref": "#/components/schemas/web3-hostname_components-schemas-name" }, + "status": { "$ref": "#/components/schemas/web3-hostname_components-schemas-status" }, + "target": { "$ref": "#/components/schemas/schemas-target" } + }, + "type": "object" + }, + "web3-hostname_components-schemas-description": { + "description": "An optional description of the hostname.", + "example": "This is my IPFS gateway.", + "maxLength": 500, + "type": "string" + }, + "web3-hostname_components-schemas-name": { + "description": "The hostname that will point to the target gateway via CNAME.", + "example": "gateway.example.com", + "maxLength": 255, + "readOnly": true, + "type": "string" + }, + "web3-hostname_components-schemas-single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/web3-hostname" } } } + ] + }, + "web3-hostname_components-schemas-status": { + "description": "Status of the hostname's activation.", + "enum": ["active", "pending", "deleting", "error"], + "example": "active", + "readOnly": true, + "type": "string" + }, + "webhook_request": { + "properties": { "notificationUrl": { "$ref": "#/components/schemas/notificationUrl" } }, + "required": ["notificationUrl"] + }, + "webhook_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } } } + ] + }, + "webhooks": { + "properties": { + "created_at": { "$ref": "#/components/schemas/webhooks_components-schemas-created_at" }, + "id": { "$ref": "#/components/schemas/uuid-s0SXln0q" }, + "last_failure": { "$ref": "#/components/schemas/last_failure" }, + "last_success": { "$ref": "#/components/schemas/last_success" }, + "name": { "$ref": "#/components/schemas/webhooks_components-schemas-name" }, + "secret": { "$ref": "#/components/schemas/secret-QjCIBSp3" }, + "type": { "$ref": "#/components/schemas/webhooks_components-schemas-type" }, + "url": { "$ref": "#/components/schemas/webhooks_components-schemas-url" } + }, + "type": "object" + }, + "webhooks_components-schemas-created_at": { + "description": "Timestamp of when the webhook destination was created.", + "example": "2020-10-26T18:25:04.532316Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "webhooks_components-schemas-id_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { "properties": { "id": { "$ref": "#/components/schemas/uuid-s0SXln0q" } }, "type": "object" } + } + } + ] + }, + "webhooks_components-schemas-name": { + "description": "The name of the webhook destination. This will be included in the request body when you receive a webhook notification.", + "example": "Slack Webhook", + "type": "string" + }, + "webhooks_components-schemas-response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "items": { "$ref": "#/components/schemas/webhooks" }, "type": "array" } } } + ] + }, + "webhooks_components-schemas-single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/webhooks" } } } + ] + }, + "webhooks_components-schemas-type": { + "description": "Type of webhook endpoint.", + "enum": ["slack", "generic", "gchat"], + "example": "slack", + "type": "string" + }, + "webhooks_components-schemas-url": { + "description": "The POST endpoint to call when dispatching a notification.", + "example": "https://hooks.slack.com/services/Ds3fdBFbV/456464Gdd", + "type": "string" + }, + "webp": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { "description": "ID of the zone setting.", "enum": ["webp"], "example": "webp" }, + "value": { "$ref": "#/components/schemas/webp_value" } + } + } + ], + "description": "When the client requesting the image supports the WebP image codec, and WebP offers a performance advantage over the original image format, Cloudflare will serve a WebP version of the original image.", + "title": "Polish WebP Conversion" + }, + "webp_value": { + "default": "off", + "description": "Value of the zone setting.", + "enum": ["off", "on"], + "type": "string" + }, + "websockets": { + "allOf": [ + { "$ref": "#/components/schemas/base-ozkeixvx" }, + { + "properties": { + "id": { "description": "ID of the zone setting.", "enum": ["websockets"], "example": "websockets" }, + "value": { "$ref": "#/components/schemas/websockets_value" } + } + } + ], + "description": "WebSockets are open connections sustained between the client and the origin server. Inside a WebSockets connection, the client and the origin can pass data back and forth without having to reestablish sessions. This makes exchanging data within a WebSockets connection fast. WebSockets are often used for real-time applications such as live chat and gaming. For more information refer to [Can I use Cloudflare with Websockets](https://support.cloudflare.com/hc/en-us/articles/200169466-Can-I-use-Cloudflare-with-WebSockets-).", + "title": "WebSockets" + }, + "websockets_value": { + "default": "off", + "description": "Value of the zone setting.", + "enum": ["off", "on"], + "type": "string" + }, + "weight": { "description": "Optional weight of the ECMP scope - if provided.", "type": "integer" }, + "weight-6YtMahm8": { + "default": 1, + "description": "The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool.", + "example": 0.6, + "maximum": 1, + "minimum": 0, + "multipleOf": 0.01, + "type": "number" + }, + "weight-9aFRWjMy": { + "default": 1, + "description": "The weight of this origin relative to other origins in the pool. Based on the configured weight the total traffic is distributed among origins within the pool.", + "example": 0.6, + "maximum": 1, + "minimum": 0, + "multipleOf": 0.01, + "type": "number" + }, + "whois": { + "properties": { + "created_date": { "example": "2009-02-17", "format": "date", "type": "string" }, + "domain": { "$ref": "#/components/schemas/schemas-domain_name" }, + "nameservers": { + "example": [ + "ns3.cloudflare.com", + "ns4.cloudflare.com", + "ns5.cloudflare.com", + "ns6.cloudflare.com", + "ns7.cloudflare.com" + ], + "items": { "type": "string" }, + "type": "array" + }, + "registrant": { "example": "DATA REDACTED", "type": "string" }, + "registrant_country": { "example": "United States", "type": "string" }, + "registrant_email": { + "example": "https://domaincontact.cloudflareregistrar.com/cloudflare.com", + "type": "string" + }, + "registrant_org": { "example": "DATA REDACTED", "type": "string" }, + "registrar": { "example": "Cloudflare, Inc.", "type": "string" }, + "updated_date": { "example": "2017-05-24", "format": "date", "type": "string" } + } + }, + "whois_components-schemas-single_response": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/whois" } } } + ] + }, + "width": { "description": "Maximum width in image pixels.", "example": 1366, "minimum": 1, "type": "number" }, + "width-bMHL5ne3": { "description": "The width of the image in pixels.", "readOnly": true, "type": "integer" }, + "workspace_one_config_request": { + "properties": { + "api_url": { + "description": "The Workspace One API URL provided in the Workspace One Admin Dashboard.", + "example": "https://as123.awmdm.com/API", + "type": "string" + }, + "auth_url": { + "description": "The Workspace One Authorization URL depending on your region.", + "example": "https://na.uemauth.vmwservices.com/connect/token", + "type": "string" + }, + "client_id": { + "description": "The Workspace One client ID provided in the Workspace One Admin Dashboard.", + "example": "example client id", + "type": "string" + }, + "client_secret": { + "description": "The Workspace One client secret provided in the Workspace One Admin Dashboard.", + "example": "example client secret", + "type": "string" + } + }, + "required": ["api_url", "auth_url", "client_id", "client_secret"], + "type": "object" + }, + "workspace_one_config_response": { + "description": "The Workspace One Config Response.", + "properties": { + "api_url": { + "description": "The Workspace One API URL provided in the Workspace One Admin Dashboard.", + "example": "https://as123.awmdm.com/API", + "type": "string" + }, + "auth_url": { + "description": "The Workspace One Authorization URL depending on your region.", + "example": "https://na.uemauth.vmwservices.com/connect/token", + "type": "string" + }, + "client_id": { + "description": "The Workspace One client ID provided in the Workspace One Admin Dashboard.", + "example": "example client id", + "type": "string" + } + }, + "required": ["api_url", "auth_url", "client_id"], + "type": "object" + }, + "yandex": { + "allOf": [ + { "$ref": "#/components/schemas/identity-provider" }, + { "properties": { "config": { "$ref": "#/components/schemas/generic-oauth-config" } }, "type": "object" } + ], + "title": "Yandex", + "type": "object" + }, + "zipcode": { + "description": "The zipcode or postal code where the user lives.", + "example": "12345", + "maxLength": 20, + "nullable": true, + "type": "string" + }, + "zone": { + "properties": { + "activated_on": { + "description": "The last time proof of ownership was detected and the zone was made\nactive", + "example": "2014-01-02T00:01:00.12345Z", + "format": "date-time", + "nullable": true, + "readOnly": true, + "type": "string" + }, + "created_on": { + "description": "When the zone was created", + "example": "2014-01-01T05:20:00.12345Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "development_mode": { + "description": "The interval (in seconds) from when development mode expires\n(positive integer) or last expired (negative integer) for the\ndomain. If development mode has never been enabled, this value is 0.", + "example": 7200, + "readOnly": true, + "type": "number" + }, + "id": { "$ref": "#/components/schemas/identifier-MZFDye9j" }, + "modified_on": { + "description": "When the zone was last modified", + "example": "2014-01-01T05:20:00.12345Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The domain name", + "example": "example.com", + "maxLength": 253, + "pattern": "^([a-zA-Z0-9][\\-a-zA-Z0-9]*\\.)+[\\-a-zA-Z0-9]{2,20}$", + "type": "string" + }, + "original_dnshost": { + "description": "DNS host at the time of switching to Cloudflare", + "example": "NameCheap", + "maxLength": 50, + "nullable": true, + "readOnly": true, + "type": "string" + }, + "original_name_servers": { + "description": "Original name servers before moving to Cloudflare\nNotes: Is this only available for full zones?", + "example": ["ns1.originaldnshost.com", "ns2.originaldnshost.com"], + "items": { "format": "hostname", "type": "string" }, + "nullable": true, + "readOnly": true, + "type": "array" + }, + "original_registrar": { + "description": "Registrar for the domain at the time of switching to Cloudflare", + "example": "GoDaddy", + "nullable": true, + "readOnly": true, + "type": "string" + } + }, + "required": [ + "id", + "name", + "development_mode", + "owner", + "account", + "meta", + "original_name_servers", + "original_registrar", + "original_dnshost", + "created_on", + "modified_on", + "activated_on" + ], + "type": "object" + }, + "zone-NCQbmiTF": { + "description": "A simple zone object. May have null properties if not a zone subscription.", + "properties": { + "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" }, + "name": { "$ref": "#/components/schemas/zone-properties-name" } + }, + "type": "object" + }, + "zone-authenticated-origin-pull": { + "allOf": [{ "$ref": "#/components/schemas/certificateObject" }], + "properties": { + "certificate": { + "$ref": "#/components/schemas/zone-authenticated-origin-pull_components-schemas-certificate" + }, + "enabled": { "$ref": "#/components/schemas/zone-authenticated-origin-pull_components-schemas-enabled" }, + "id": { "$ref": "#/components/schemas/identifier-tZwYoMuc" }, + "private_key": { "$ref": "#/components/schemas/private_key" } + }, + "type": "object" + }, + "zone-authenticated-origin-pull-aLOWlDXy": { + "allOf": [{ "$ref": "#/components/schemas/certificateObject-ymFm5Oiv" }], + "properties": { + "certificate": { + "$ref": "#/components/schemas/zone-authenticated-origin-pull_components-schemas-certificate" + }, + "enabled": { "$ref": "#/components/schemas/zone-authenticated-origin-pull_components-schemas-enabled" }, + "id": { "$ref": "#/components/schemas/zone-authenticated-origin-pull_components-schemas-identifier" }, + "private_key": { "$ref": "#/components/schemas/private_key" } + }, + "type": "object" + }, + "zone-authenticated-origin-pull_components-schemas-certificate": { + "description": "The zone's leaf certificate.", + "example": "-----BEGIN CERTIFICATE-----\nMIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX\naWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF\nMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50\nZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB\nCgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1\nCGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB\nKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5\n0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI\ndZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2\nizNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4\n9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI\nGKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV\nBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF\nMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2\n2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP\nMlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG\nSvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq\n2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw\nYbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=\n-----END CERTIFICATE-----\n", + "type": "string" + }, + "zone-authenticated-origin-pull_components-schemas-enabled": { + "description": "Indicates whether zone-level authenticated origin pulls is enabled.", + "example": true, + "type": "boolean" + }, + "zone-authenticated-origin-pull_components-schemas-expires_on": { + "description": "When the certificate from the authority expires.", + "example": "2100-01-01T05:20:00Z", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "zone-authenticated-origin-pull_components-schemas-identifier": { + "description": "Certificate identifier tag.", + "example": "2458ce5a-0c35-4c7f-82c7-8e9487d3ff60", + "maxLength": 36, + "readOnly": true, + "type": "string" + }, + "zone-authenticated-origin-pull_components-schemas-status": { + "description": "Status of the certificate activation.", + "enum": [ + "initializing", + "pending_deployment", + "pending_deletion", + "active", + "deleted", + "deployment_timed_out", + "deletion_timed_out" + ], + "example": "active" + }, + "zone-properties-name": { + "description": "The domain name", + "example": "example.com", + "maxLength": 253, + "pattern": "^([a-zA-Z0-9][\\-a-zA-Z0-9]*\\.)+[\\-a-zA-Z0-9]{2,20}$", + "readOnly": true, + "type": "string" + }, + "zone_cache_settings_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } } } + ] + }, + "zone_identifier": { "description": "Identifier of the zone.", "example": "593c9c94de529bbbfaac7c53ced0447d" }, + "zone_identifier-jLr6NCq8": { "$ref": "#/components/schemas/identifier-YhmC5GTP" }, + "zone_metadata": { + "properties": { + "enabled": { + "description": "Whether zone uses account-level custom nameservers.", + "example": true, + "type": "boolean" + } + }, + "type": "object" + }, + "zone_name": { "description": "Name of the zone.", "example": "example.com", "type": "string" }, + "zone_settings_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common-jkxlh21Y" }, + { + "properties": { + "result": { + "items": { + "anyOf": [ + { "$ref": "#/components/schemas/0rtt" }, + { "$ref": "#/components/schemas/advanced_ddos" }, + { "$ref": "#/components/schemas/always_online" }, + { "$ref": "#/components/schemas/always_use_https" }, + { "$ref": "#/components/schemas/automatic_https_rewrites" }, + { "$ref": "#/components/schemas/brotli" }, + { "$ref": "#/components/schemas/browser_cache_ttl" }, + { "$ref": "#/components/schemas/browser_check" }, + { "$ref": "#/components/schemas/cache_level" }, + { "$ref": "#/components/schemas/challenge_ttl" }, + { "$ref": "#/components/schemas/ciphers" }, + { "$ref": "#/components/schemas/cname_flattening" }, + { "$ref": "#/components/schemas/development_mode" }, + { "$ref": "#/components/schemas/early_hints" }, + { "$ref": "#/components/schemas/edge_cache_ttl" }, + { "$ref": "#/components/schemas/email_obfuscation" }, + { "$ref": "#/components/schemas/h2_prioritization" }, + { "$ref": "#/components/schemas/hotlink_protection" }, + { "$ref": "#/components/schemas/http2" }, + { "$ref": "#/components/schemas/http3" }, + { "$ref": "#/components/schemas/image_resizing" }, + { "$ref": "#/components/schemas/ip_geolocation" }, + { "$ref": "#/components/schemas/ipv6" }, + { "$ref": "#/components/schemas/max_upload" }, + { "$ref": "#/components/schemas/min_tls_version" }, + { "$ref": "#/components/schemas/minify" }, + { "$ref": "#/components/schemas/mirage" }, + { "$ref": "#/components/schemas/mobile_redirect" }, + { "$ref": "#/components/schemas/nel" }, + { "$ref": "#/components/schemas/opportunistic_encryption" }, + { "$ref": "#/components/schemas/opportunistic_onion" }, + { "$ref": "#/components/schemas/orange_to_orange" }, + { "$ref": "#/components/schemas/origin_error_page_pass_thru" }, + { "$ref": "#/components/schemas/origin_max_http_version" }, + { "$ref": "#/components/schemas/polish" }, + { "$ref": "#/components/schemas/prefetch_preload" }, + { "$ref": "#/components/schemas/privacy_pass" }, + { "$ref": "#/components/schemas/proxy_read_timeout" }, + { "$ref": "#/components/schemas/pseudo_ipv4" }, + { "$ref": "#/components/schemas/response_buffering" }, + { "$ref": "#/components/schemas/rocket_loader" }, + { "$ref": "#/components/schemas/schemas-automatic_platform_optimization" }, + { "$ref": "#/components/schemas/security_header" }, + { "$ref": "#/components/schemas/security_level" }, + { "$ref": "#/components/schemas/server_side_exclude" }, + { "$ref": "#/components/schemas/sha1_support" }, + { "$ref": "#/components/schemas/sort_query_string_for_cache" }, + { "$ref": "#/components/schemas/ssl" }, + { "$ref": "#/components/schemas/ssl_recommender" }, + { "$ref": "#/components/schemas/tls_1_2_only" }, + { "$ref": "#/components/schemas/tls_1_3" }, + { "$ref": "#/components/schemas/tls_client_auth" }, + { "$ref": "#/components/schemas/true_client_ip_header" }, + { "$ref": "#/components/schemas/waf" }, + { "$ref": "#/components/schemas/webp" }, + { "$ref": "#/components/schemas/websockets" } + ] + }, + "type": "array" + } + } + } + ] + }, + "zone_settings_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } } } + ] + }, + "zone_settings_response_single-WcbmxR67": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common-jkxlh21Y" }, + { "properties": { "result": { "type": "object" } } } + ] + }, + "zone_subscription_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "type": "object" } }, "type": "object" } + ] + }, + "zonelockdown": { + "additionalProperties": false, + "properties": { + "configurations": { "$ref": "#/components/schemas/configurations" }, + "created_on": { "$ref": "#/components/schemas/created_on-k2n1y7eG" }, + "description": { "$ref": "#/components/schemas/lockdowns_components-schemas-description" }, + "id": { "$ref": "#/components/schemas/lockdowns_components-schemas-id" }, + "modified_on": { "$ref": "#/components/schemas/components-schemas-modified_on" }, + "paused": { "$ref": "#/components/schemas/schemas-paused" }, + "urls": { "$ref": "#/components/schemas/schemas-urls" } + }, + "required": ["id", "created_on", "modified_on", "paused", "description", "urls", "configurations"] + }, + "zonelockdown_response_collection": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { "result": { "items": { "$ref": "#/components/schemas/zonelockdown" }, "type": "array" } }, + "required": ["result"], + "type": "object" + } + ] + }, + "zonelockdown_response_single": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { "result": { "$ref": "#/components/schemas/zonelockdown" } }, + "required": ["result"], + "type": "object" + } + ] + }, + "zones_connected": { + "description": "The number of zones using this Railgun.", + "example": 2, + "readOnly": true, + "type": "number" + } + }, + "securitySchemes": { + "api_email": { "in": "header", "name": "X-Auth-Email", "type": "apiKey" }, + "api_key": { "in": "header", "name": "X-Auth-Key", "type": "apiKey" }, + "api_token": { "scheme": "bearer", "type": "http" }, + "user_service_key": { "in": "header", "name": "X-Auth-User-Service-Key", "type": "apiKey" } + } + }, + "info": { + "description": "Interact with Cloudflare's products and services via the Cloudflare API.\nFor more information on how to create and troubleshoot API tokens, refer to\nour [API fundamentals](https://developers.cloudflare.com/fundamentals/api/).\n\nTotally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/).", + "license": { "name": "BSD-3-Clause", "url": "https://opensource.org/licenses/BSD-3-Clause" }, + "title": "Cloudflare API", + "version": "4.0.0" + }, + "openapi": "3.0.3", + "paths": { + "/accounts": { + "get": { + "description": "List all accounts you have ownership or verified access to.", + "operationId": "accounts-list-accounts", + "parameters": [ + { + "in": "query", + "name": "name", + "schema": { + "description": "Name of the account.", + "example": "example.com", + "readOnly": true, + "type": "string" + } + }, + { + "in": "query", + "name": "page", + "schema": { + "default": 1, + "description": "Page number of paginated results.", + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { + "default": 20, + "description": "Maximum number of results per page.", + "maximum": 50, + "minimum": 5, + "type": "number" + } + }, + { + "in": "query", + "name": "direction", + "schema": { + "description": "Direction to order results.", + "enum": ["asc", "desc"], + "example": "desc", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/response_collection-NcnbjEgN" } } + }, + "description": "List Accounts response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/response_collection-NcnbjEgN" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Accounts response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Accounts", + "tags": ["Accounts"], + "x-cfPermissionsRequired": { "enum": ["#organization:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/accounts/{account_identifier1}/addressing/address_maps/{address_map_identifier}/accounts/{account_identifier}": { + "delete": { + "description": "Remove an account as a member of a particular address map.", + "operationId": "ip-address-management-address-maps-remove-an-account-membership-from-an-address-map", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + }, + { + "in": "path", + "name": "address_map_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + }, + { + "in": "path", + "name": "account_identifier1", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-collection" } } }, + "description": "Remove an account membership from an Address Map response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Remove an account membership from an Address Map response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Remove an account membership from an Address Map", + "tags": ["IP Address Management Address Maps"] + }, + "put": { + "description": "Add an account as a member of a particular address map.", + "operationId": "ip-address-management-address-maps-add-an-account-membership-to-an-address-map", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + }, + { + "in": "path", + "name": "address_map_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + }, + { + "in": "path", + "name": "account_identifier1", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-collection" } } }, + "description": "Add an account membership to an Address Map response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Add an account membership to an Address Map response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Add an account membership to an Address Map", + "tags": ["IP Address Management Address Maps"] + } + }, + "/accounts/{account_identifier}/addressing/address_maps": { + "get": { + "description": "List all address maps owned by the account.", + "operationId": "ip-address-management-address-maps-list-address-maps", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-response_collection-R3Nbn4ml" } + } + }, + "description": "List Address Maps response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-response_collection-R3Nbn4ml" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Address Maps response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Address Maps", + "tags": ["IP Address Management Address Maps"] + }, + "post": { + "description": "Create a new address map under the account.", + "operationId": "ip-address-management-address-maps-create-address-map", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "description": { "$ref": "#/components/schemas/schemas-description-Fsn87iOz" }, + "enabled": { "$ref": "#/components/schemas/enabled-i0fFiRwL" } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/full_response" } } }, + "description": "Create Address Map response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/full_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Address Map response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Address Map", + "tags": ["IP Address Management Address Maps"] + } + }, + "/accounts/{account_identifier}/addressing/address_maps/{address_map_identifier}": { + "delete": { + "description": "Delete a particular address map owned by the account. An Address Map must be disabled before it can be deleted.", + "operationId": "ip-address-management-address-maps-delete-address-map", + "parameters": [ + { + "in": "path", + "name": "address_map_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-collection" } } }, + "description": "Delete Address Map response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Address Map response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Address Map", + "tags": ["IP Address Management Address Maps"] + }, + "get": { + "description": "Show a particular address map owned by the account.", + "operationId": "ip-address-management-address-maps-address-map-details", + "parameters": [ + { + "in": "path", + "name": "address_map_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/full_response" } } }, + "description": "Address Map Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/full_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Address Map Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Address Map Details", + "tags": ["IP Address Management Address Maps"] + }, + "patch": { + "description": "Modify properties of an address map owned by the account.", + "operationId": "ip-address-management-address-maps-update-address-map", + "parameters": [ + { + "in": "path", + "name": "address_map_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "default_sni": { "$ref": "#/components/schemas/default_sni" }, + "description": { "$ref": "#/components/schemas/schemas-description-Fsn87iOz" }, + "enabled": { "$ref": "#/components/schemas/enabled-i0fFiRwL" } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-single_response-plUIZwft" } + } + }, + "description": "Update Address Map response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-single_response-plUIZwft" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Address Map response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Address Map", + "tags": ["IP Address Management Address Maps"] + } + }, + "/accounts/{account_identifier}/addressing/address_maps/{address_map_identifier}/ips/{ip_address}": { + "delete": { + "description": "Remove an IP from a particular address map.", + "operationId": "ip-address-management-address-maps-remove-an-ip-from-an-address-map", + "parameters": [ + { + "in": "path", + "name": "ip_address", + "required": true, + "schema": { "$ref": "#/components/schemas/ip_address" } + }, + { + "in": "path", + "name": "address_map_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-collection" } } }, + "description": "Remove an IP from an Address Map response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Remove an IP from an Address Map response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Remove an IP from an Address Map", + "tags": ["IP Address Management Address Maps"] + }, + "put": { + "description": "Add an IP from a prefix owned by the account to a particular address map.", + "operationId": "ip-address-management-address-maps-add-an-ip-to-an-address-map", + "parameters": [ + { + "in": "path", + "name": "ip_address", + "required": true, + "schema": { "$ref": "#/components/schemas/ip_address" } + }, + { + "in": "path", + "name": "address_map_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-collection" } } }, + "description": "Add an IP to an Address Map response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Add an IP to an Address Map response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Add an IP to an Address Map", + "tags": ["IP Address Management Address Maps"] + } + }, + "/accounts/{account_identifier}/addressing/address_maps/{address_map_identifier}/zones/{zone_identifier}": { + "delete": { + "description": "Remove a zone as a member of a particular address map.", + "operationId": "ip-address-management-address-maps-remove-a-zone-membership-from-an-address-map", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + }, + { + "in": "path", + "name": "address_map_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-collection" } } }, + "description": "Remove a zone membership from an Address Map response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Remove a zone membership from an Address Map response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Remove a zone membership from an Address Map", + "tags": ["IP Address Management Address Maps"] + }, + "put": { + "description": "Add a zone as a member of a particular address map.", + "operationId": "ip-address-management-address-maps-add-a-zone-membership-to-an-address-map", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + }, + { + "in": "path", + "name": "address_map_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-collection" } } }, + "description": "Add a zone membership to an Address Map response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Add a zone membership to an Address Map response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Add a zone membership to an Address Map", + "tags": ["IP Address Management Address Maps"] + } + }, + "/accounts/{account_identifier}/addressing/loa_documents": { + "post": { + "description": "Submit LOA document (pdf format) under the account.", + "operationId": "ip-address-management-prefixes-upload-loa-document", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + } + ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "properties": { + "loa_document": { + "description": "LOA document to upload.", + "example": "@document.pdf", + "type": "string" + } + }, + "required": ["loa_document"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loa_upload_response" } } }, + "description": "Upload LOA Document response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/loa_upload_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Upload LOA Document response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Upload LOA Document", + "tags": ["IP Address Management Prefixes"] + } + }, + "/accounts/{account_identifier}/addressing/loa_documents/{loa_document_identifier}/download": { + "get": { + "description": "Download specified LOA document under the account.", + "operationId": "ip-address-management-prefixes-download-loa-document", + "parameters": [ + { + "in": "path", + "name": "loa_document_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/loa_document_identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": {} } }, + "description": "Download LOA Document response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { "allOf": [{}, { "$ref": "#/components/schemas/api-response-common-failure" }] } + } + }, + "description": "Download LOA Document response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Download LOA Document", + "tags": ["IP Address Management Prefixes"] + } + }, + "/accounts/{account_identifier}/addressing/prefixes": { + "get": { + "description": "List all prefixes owned by the account.", + "operationId": "ip-address-management-prefixes-list-prefixes", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/response_collection-wEgS8Oby" } } + }, + "description": "List Prefixes response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/response_collection-wEgS8Oby" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Prefixes response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Prefixes", + "tags": ["IP Address Management Prefixes"] + }, + "post": { + "description": "Add a new prefix under the account.", + "operationId": "ip-address-management-prefixes-add-prefix", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "asn": { "$ref": "#/components/schemas/asn" }, + "cidr": { "$ref": "#/components/schemas/cidr" }, + "loa_document_id": { "$ref": "#/components/schemas/loa_document_identifier" } + }, + "required": ["cidr", "loa_document_id", "asn"] + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response-tparoDL5" } } + }, + "description": "Add Prefix response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response-tparoDL5" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Add Prefix response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Add Prefix", + "tags": ["IP Address Management Prefixes"] + } + }, + "/accounts/{account_identifier}/addressing/prefixes/{prefix_identifier}": { + "delete": { + "description": "Delete an unapproved prefix owned by the account.", + "operationId": "ip-address-management-prefixes-delete-prefix", + "parameters": [ + { + "in": "path", + "name": "prefix_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-collection" } } }, + "description": "Delete Prefix response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Prefix response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Prefix", + "tags": ["IP Address Management Prefixes"] + }, + "get": { + "description": "List a particular prefix owned by the account.", + "operationId": "ip-address-management-prefixes-prefix-details", + "parameters": [ + { + "in": "path", + "name": "prefix_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response-tparoDL5" } } + }, + "description": "Prefix Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response-tparoDL5" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Prefix Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Prefix Details", + "tags": ["IP Address Management Prefixes"] + }, + "patch": { + "description": "Modify the description for a prefix owned by the account.", + "operationId": "ip-address-management-prefixes-update-prefix-description", + "parameters": [ + { + "in": "path", + "name": "prefix_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "description": { "$ref": "#/components/schemas/description-AqNwNwjr" } }, + "required": ["description"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response-tparoDL5" } } + }, + "description": "Update Prefix Description response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response-tparoDL5" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Prefix Description response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Prefix Description", + "tags": ["IP Address Management Prefixes"] + } + }, + "/accounts/{account_identifier}/addressing/prefixes/{prefix_identifier}/bgp/status": { + "get": { + "description": "List the current advertisement state for a prefix.", + "operationId": "ip-address-management-dynamic-advertisement-get-advertisement-status", + "parameters": [ + { + "in": "path", + "name": "prefix_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/advertised_response" } } }, + "description": "Get Advertisement Status response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/advertised_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Advertisement Status response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Advertisement Status", + "tags": ["IP Address Management Dynamic Advertisement"] + }, + "patch": { + "description": "Advertise or withdraw BGP route for a prefix.", + "operationId": "ip-address-management-dynamic-advertisement-update-prefix-dynamic-advertisement-status", + "parameters": [ + { + "in": "path", + "name": "prefix_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "advertised": { "$ref": "#/components/schemas/schemas-advertised" } }, + "required": ["advertised"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/advertised_response" } } }, + "description": "Update Prefix Dynamic Advertisement Status response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/advertised_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Prefix Dynamic Advertisement Status response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Prefix Dynamic Advertisement Status", + "tags": ["IP Address Management Dynamic Advertisement"] + } + }, + "/accounts/{account_identifier}/addressing/prefixes/{prefix_identifier}/delegations": { + "get": { + "description": "List all delegations for a given account IP prefix.", + "operationId": "ip-address-management-prefix-delegation-list-prefix-delegations", + "parameters": [ + { + "in": "path", + "name": "prefix_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-response_collection-NmAY72Ue" } } + }, + "description": "List Prefix Delegations response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-response_collection-NmAY72Ue" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Prefix Delegations response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Prefix Delegations", + "tags": ["IP Address Management Prefix Delegation"] + }, + "post": { + "description": "Create a new account delegation for a given IP prefix.", + "operationId": "ip-address-management-prefix-delegation-create-prefix-delegation", + "parameters": [ + { + "in": "path", + "name": "prefix_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "cidr": { "$ref": "#/components/schemas/cidr" }, + "delegated_account_id": { "$ref": "#/components/schemas/delegated_account_identifier" } + }, + "required": ["cidr", "delegated_account_id"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-single_response-xdmRbZer" } } + }, + "description": "Create Prefix Delegation response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-single_response-xdmRbZer" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Prefix Delegation response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Prefix Delegation", + "tags": ["IP Address Management Prefix Delegation"] + } + }, + "/accounts/{account_identifier}/addressing/prefixes/{prefix_identifier}/delegations/{delegation_identifier}": { + "delete": { + "description": "Delete an account delegation for a given IP prefix.", + "operationId": "ip-address-management-prefix-delegation-delete-prefix-delegation", + "parameters": [ + { + "in": "path", + "name": "delegation_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/delegation_identifier" } + }, + { + "in": "path", + "name": "prefix_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-v0xEcFCj" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/id_response-I5lr4Hc3" } } }, + "description": "Delete Prefix Delegation response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/id_response-I5lr4Hc3" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Prefix Delegation response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Prefix Delegation", + "tags": ["IP Address Management Prefix Delegation"] + } + }, + "/accounts/{account_identifier}/audit_logs": { + "get": { + "description": "Gets a list of audit logs for an account. The list can be filtered by who made the change, which zone was the change made on, and the timeframe of the change.", + "operationId": "audit-logs-get-account-audit-logs", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "query", + "name": "id", + "schema": { + "description": "Finds a specific log by its ID.", + "example": "f174be97-19b1-40d6-954d-70cd5fbd52db", + "type": "string" + } + }, + { + "in": "query", + "name": "export", + "schema": { + "description": "Indicates that this request is an export of logs in CSV format.", + "example": true, + "type": "boolean" + } + }, + { + "in": "query", + "name": "action.type", + "schema": { "description": "Filters by the action type.", "example": "add", "type": "string" } + }, + { + "in": "query", + "name": "actor.ip", + "schema": { + "description": "Filters by the IP address of the request that made the change by specific IP address or valid CIDR Range.", + "example": "17.168.228.63", + "type": "string" + } + }, + { + "in": "query", + "name": "actor.email", + "schema": { + "description": "Filters by the email address of the actor that made the change.", + "example": "alice@example.com", + "format": "email", + "type": "string" + } + }, + { + "in": "query", + "name": "since", + "schema": { + "description": "Limits the returned results to logs newer than the specified date. This can be a date string `2019-04-30` or an absolute timestamp that conforms to RFC3339.", + "example": "2019-04-30T01:12:20Z", + "format": "date-time", + "type": "string" + } + }, + { + "in": "query", + "name": "before", + "schema": { + "description": "Limits the returned results to logs older than the specified date. This can be a date string `2019-04-30` or an absolute timestamp that conforms to RFC3339.", + "example": "2019-04-30T01:12:20Z", + "format": "date-time", + "type": "string" + } + }, + { + "in": "query", + "name": "zone.name", + "schema": { + "description": "Filters by the name of the zone associated to the change.", + "example": "example.com", + "type": "string" + } + }, + { + "in": "query", + "name": "direction", + "schema": { + "default": "desc", + "description": "Changes the direction of the chronological sorting.", + "enum": ["desc", "asc"], + "example": "desc", + "type": "string" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { + "default": 100, + "description": "Sets the number of results to return per page.", + "example": 25, + "maximum": 1000, + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "page", + "schema": { + "default": 1, + "description": "Defines which page of results to return.", + "example": 50, + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "hide_user_logs", + "schema": { + "default": false, + "description": "Indicates whether or not to hide user level audit logs.", + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/audit_logs_response_collection" } } + }, + "description": "Get account audit logs response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/audit_logs_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get account audit logs response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get account audit logs", + "tags": ["Audit Logs"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/accounts/{account_identifier}/billing/profile": { + "get": { + "description": "Gets the current billing profile for the account.", + "operationId": "account-billing-profile-billing-profile-details", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-D3Kod1Eh" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing_response_single" } } }, + "description": "Billing Profile Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/billing_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Billing Profile Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Billing Profile Details", + "tags": ["Account Billing Profile"], + "x-cfPermissionsRequired": { "enum": ["#billing:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/accounts/{account_identifier}/brand-protection/submit": { + "post": { + "operationId": "phishing-url-scanner-submit-suspicious-url-for-scanning", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { "allOf": [{ "$ref": "#/components/schemas/url_param" }], "type": "object" } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/phishing-url-submit_components-schemas-single_response" } + } + }, + "description": "Submit suspicious URL for scanning response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/phishing-url-submit_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Submit suspicious URL for scanning response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Submit suspicious URL for scanning", + "tags": ["Phishing URL Scanner"] + } + }, + "/accounts/{account_identifier}/brand-protection/url-info": { + "get": { + "operationId": "phishing-url-information-get-results-for-a-url-scan", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { "in": "query", "name": "url_id_param", "schema": { "$ref": "#/components/schemas/url_id_param" } }, + { "in": "query", "name": "url", "schema": { "type": "string" } } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/phishing-url-info_components-schemas-single_response" } + } + }, + "description": "Get results for a URL scan response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/phishing-url-info_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get results for a URL scan response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get results for a URL scan", + "tags": ["Phishing URL Information"] + } + }, + "/accounts/{account_identifier}/cfd_tunnel": { + "get": { + "description": "Lists and filters Cloudflare Tunnels in an account.", + "operationId": "cloudflare-tunnel-list-cloudflare-tunnels", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/cf_account_id" } + }, + { "in": "query", "name": "uuid", "schema": { "$ref": "#/components/schemas/tunnel_id" } }, + { "in": "query", "name": "existed_at", "schema": { "$ref": "#/components/schemas/existed_at" } }, + { "in": "query", "name": "per_page", "schema": { "$ref": "#/components/schemas/schemas-per_page" } }, + { "in": "query", "name": "tunnel_id", "schema": { "$ref": "#/components/schemas/tunnel_id" } }, + { + "in": "query", + "name": "is_deleted", + "schema": { + "description": "If `true`, only include deleted tunnels. If `false`, exclude deleted tunnels. If empty, all tunnels will be included.", + "example": true, + "type": "boolean" + } + }, + { + "in": "query", + "name": "page", + "schema": { + "default": 1, + "description": "Page number of paginated results.", + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "tunnel_name", + "schema": { "description": "A user-friendly name for the tunnel.", "example": "blog", "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-tunnel_response_collection" } } + }, + "description": "List Cloudflare Tunnels response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-tunnel_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Cloudflare Tunnels response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Cloudflare Tunnels", + "tags": ["Cloudflare Tunnel"] + }, + "post": { + "description": "Creates a new Cloudflare Tunnel in an account.", + "operationId": "cloudflare-tunnel-create-a-cloudflare-tunnel", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/cf_account_id" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "config_src": { "$ref": "#/components/schemas/config_src" }, + "name": { "$ref": "#/components/schemas/tunnel_name" }, + "tunnel_secret": { "$ref": "#/components/schemas/tunnel_secret" } + }, + "required": ["name", "tunnel_secret"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-tunnel_response_single" } } + }, + "description": "Create a Cloudflare Tunnel response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-tunnel_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create a Cloudflare Tunnel response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create a Cloudflare Tunnel", + "tags": ["Cloudflare Tunnel"] + } + }, + "/accounts/{account_identifier}/cfd_tunnel/{tunnel_id}": { + "delete": { + "description": "Deletes a Cloudflare Tunnel from an account.", + "operationId": "cloudflare-tunnel-delete-a-cloudflare-tunnel", + "parameters": [ + { + "in": "path", + "name": "tunnel_id", + "required": true, + "schema": { "$ref": "#/components/schemas/tunnel_id" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/cf_account_id" } + } + ], + "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-tunnel_response_single" } } + }, + "description": "Delete a Cloudflare Tunnel response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-tunnel_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete a Cloudflare Tunnel response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete a Cloudflare Tunnel", + "tags": ["Cloudflare Tunnel"] + }, + "get": { + "description": "Fetches a single Cloudflare Tunnel.", + "operationId": "cloudflare-tunnel-get-a-cloudflare-tunnel", + "parameters": [ + { + "in": "path", + "name": "tunnel_id", + "required": true, + "schema": { "$ref": "#/components/schemas/tunnel_id" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/cf_account_id" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-tunnel_response_single" } } + }, + "description": "Get a Cloudflare Tunnel response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-tunnel_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get a Cloudflare Tunnel response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a Cloudflare Tunnel", + "tags": ["Cloudflare Tunnel"] + }, + "patch": { + "description": "Updates an existing Cloudflare Tunnel.", + "operationId": "cloudflare-tunnel-update-a-cloudflare-tunnel", + "parameters": [ + { + "in": "path", + "name": "tunnel_id", + "required": true, + "schema": { "$ref": "#/components/schemas/tunnel_id" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/cf_account_id" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "name": { "$ref": "#/components/schemas/tunnel_name" }, + "tunnel_secret": { "$ref": "#/components/schemas/tunnel_secret" } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-tunnel_response_single" } } + }, + "description": "Update a Cloudflare Tunnel response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-tunnel_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update a Cloudflare Tunnel response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update a Cloudflare Tunnel", + "tags": ["Cloudflare Tunnel"] + } + }, + "/accounts/{account_identifier}/cfd_tunnel/{tunnel_id}/configurations": { + "get": { + "description": "Gets the configuration for a remotely-managed tunnel", + "operationId": "cloudflare-tunnel-configuration-get-configuration", + "parameters": [ + { + "in": "path", + "name": "tunnel_id", + "required": true, + "schema": { "$ref": "#/components/schemas/tunnel_id" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/config_response_single" } } }, + "description": "Get configuration response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/config_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get configuration response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get configuration", + "tags": ["Cloudflare Tunnel configuration"] + }, + "put": { + "description": "Adds or updates the configuration for a remotely-managed tunnel.", + "operationId": "cloudflare-tunnel-configuration-put-configuration", + "parameters": [ + { + "in": "path", + "name": "tunnel_id", + "required": true, + "schema": { "$ref": "#/components/schemas/tunnel_id" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "config": { "$ref": "#/components/schemas/components-schemas-config" } }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/config_response_single" } } }, + "description": "Put configuration response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/config_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Put configuration response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Put configuration", + "tags": ["Cloudflare Tunnel configuration"] + } + }, + "/accounts/{account_identifier}/cfd_tunnel/{tunnel_id}/connections": { + "delete": { + "description": "Removes connections that are in a disconnected or pending reconnect state. We recommend running this command after shutting down a tunnel.", + "operationId": "cloudflare-tunnel-clean-up-cloudflare-tunnel-connections", + "parameters": [ + { + "in": "path", + "name": "tunnel_id", + "required": true, + "schema": { "$ref": "#/components/schemas/tunnel_id" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/cf_account_id" } + } + ], + "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/components-schemas-empty_response" } } + }, + "description": "Clean up Cloudflare Tunnel connections response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-empty_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Clean up Cloudflare Tunnel connections response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Clean up Cloudflare Tunnel connections", + "tags": ["Cloudflare Tunnel"] + }, + "get": { + "description": "Fetches connection details for a Cloudflare Tunnel.", + "operationId": "cloudflare-tunnel-list-cloudflare-tunnel-connections", + "parameters": [ + { + "in": "path", + "name": "tunnel_id", + "required": true, + "schema": { "$ref": "#/components/schemas/tunnel_id" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/cf_account_id" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/tunnel_connections_response" } } + }, + "description": "List Cloudflare Tunnel connections response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/tunnel_connections_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Cloudflare Tunnel connections response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Cloudflare Tunnel connections", + "tags": ["Cloudflare Tunnel"] + } + }, + "/accounts/{account_identifier}/cfd_tunnel/{tunnel_id}/token": { + "get": { + "description": "Gets the token used to associate cloudflared with a specific tunnel.", + "operationId": "cloudflare-tunnel-get-a-cloudflare-tunnel-token", + "parameters": [ + { + "in": "path", + "name": "tunnel_id", + "required": true, + "schema": { "$ref": "#/components/schemas/tunnel_id" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/cf_account_id" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tunnel_response_token" } } }, + "description": "Get a Cloudflare Tunnel token response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/tunnel_response_token" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get a Cloudflare Tunnel token response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a Cloudflare Tunnel token", + "tags": ["Cloudflare Tunnel"] + } + }, + "/accounts/{account_identifier}/custom_pages": { + "get": { + "description": "Fetches all the custom pages at the account level.", + "operationId": "custom-pages-for-an-account-list-custom-pages", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/custom_pages_response_collection" } } + }, + "description": "List custom pages response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/custom_pages_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List custom pages response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List custom pages", + "tags": ["Custom pages for an account"], + "x-cfPermissionsRequired": { "enum": ["#organization:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + } + }, + "/accounts/{account_identifier}/custom_pages/{identifier}": { + "get": { + "description": "Fetches the details of a custom page.", + "operationId": "custom-pages-for-an-account-get-a-custom-page", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/custom-pages_components-schemas-identifier-2" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/custom_pages_response_single" } } + }, + "description": "Get a custom page response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/custom_pages_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get a custom page response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a custom page", + "tags": ["Custom pages for an account"], + "x-cfPermissionsRequired": { "enum": ["#organization:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + }, + "put": { + "description": "Updates the configuration of an existing custom page.", + "operationId": "custom-pages-for-an-account-update-a-custom-page", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/custom-pages_components-schemas-identifier-2" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "state": { "$ref": "#/components/schemas/components-schemas-state" }, + "url": { "$ref": "#/components/schemas/url" } + }, + "required": ["url", "state"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/custom_pages_response_single" } } + }, + "description": "Update a custom page response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/custom_pages_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update a custom page response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update a custom page", + "tags": ["Custom pages for an account"], + "x-cfPermissionsRequired": { "enum": ["#organization:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + } + }, + "/accounts/{account_identifier}/diagnostics/traceroute": { + "post": { + "description": "Run traceroutes from Cloudflare colos.", + "operationId": "diagnostics-traceroute", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "colos": { "$ref": "#/components/schemas/colos" }, + "options": { "$ref": "#/components/schemas/schemas-options" }, + "targets": { "$ref": "#/components/schemas/targets-8BcM0LKv" } + }, + "required": ["targets"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/traceroute_response_collection" } } + }, + "description": "Traceroute response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/traceroute_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Traceroute response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Traceroute", + "tags": ["Diagnostics"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/dlp/patterns/validate": { + "post": { + "description": "Validates whether this pattern is a valid regular expression. Rejects it if the regular expression is too complex or can match an unbounded-length string. Your regex will be rejected if it uses the Kleene Star -- be sure to bound the maximum number of characters that can be matched.", + "operationId": "dlp-pattern-validation-validate-pattern", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validate_pattern" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/validate_response" } } }, + "description": "Validate pattern response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/validate_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Validate pattern response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Validate pattern", + "tags": ["DLP Pattern Validation"] + } + }, + "/accounts/{account_identifier}/dlp/payload_log": { + "get": { + "description": "Gets the current DLP payload log settings for this account.", + "operationId": "dlp-payload-log-settings-get-settings", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_settings_response" } } }, + "description": "Get settings response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/get_settings_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get settings response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get settings", + "tags": ["DLP Payload Log Settings"] + }, + "put": { + "description": "Updates the DLP payload log settings for this account.", + "operationId": "dlp-payload-log-settings-update-settings", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_settings" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/update_settings_response" } } + }, + "description": "Update settings response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/update_settings_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update settings response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update settings", + "tags": ["DLP Payload Log Settings"] + } + }, + "/accounts/{account_identifier}/dlp/profiles": { + "get": { + "description": "Lists all DLP profiles in an account.", + "operationId": "dlp-profiles-list-all-profiles", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/profiles_components-schemas-response_collection" } + } + }, + "description": "List all profiles response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/profiles_components-schemas-response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List all profiles response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List all profiles", + "tags": ["DLP Profiles"] + } + }, + "/accounts/{account_identifier}/dlp/profiles/custom": { + "post": { + "description": "Creates a set of DLP custom profiles.", + "operationId": "dlp-profiles-create-custom-profiles", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_custom_profiles" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/create_custom_profile_response" } } + }, + "description": "Create custom profiles response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/create_custom_profile_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create custom profiles response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create custom profiles", + "tags": ["DLP Profiles"] + } + }, + "/accounts/{account_identifier}/dlp/profiles/custom/{profile_id}": { + "delete": { + "description": "Deletes a DLP custom profile.", + "operationId": "dlp-profiles-delete-custom-profile", + "parameters": [ + { + "in": "path", + "name": "profile_id", + "required": true, + "schema": { "$ref": "#/components/schemas/profile_id-JwqwymCp" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single" } } }, + "description": "Delete custom profile response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete custom profile response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete custom profile", + "tags": ["DLP Profiles"] + }, + "get": { + "description": "Fetches a custom DLP profile.", + "operationId": "dlp-profiles-get-custom-profile", + "parameters": [ + { + "in": "path", + "name": "profile_id", + "required": true, + "schema": { "$ref": "#/components/schemas/profile_id-JwqwymCp" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_profile_response" } } }, + "description": "Get custom profile response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/custom_profile_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get custom profile response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get custom profile", + "tags": ["DLP Profiles"] + }, + "put": { + "description": "Updates a DLP custom profile.", + "operationId": "dlp-profiles-update-custom-profile", + "parameters": [ + { + "in": "path", + "name": "profile_id", + "required": true, + "schema": { "$ref": "#/components/schemas/profile_id-JwqwymCp" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/update_custom_profile-j98uzXOJ" } } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_profile" } } }, + "description": "Update custom profile response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/custom_profile" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update custom profile response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update custom profile", + "tags": ["DLP Profiles"] + } + }, + "/accounts/{account_identifier}/dlp/profiles/predefined/{profile_id}": { + "get": { + "description": "Fetches a predefined DLP profile.", + "operationId": "dlp-profiles-get-predefined-profile", + "parameters": [ + { + "in": "path", + "name": "profile_id", + "required": true, + "schema": { "$ref": "#/components/schemas/profile_id-JwqwymCp" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/predefined_profile_response" } } + }, + "description": "Get predefined profile response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/predefined_profile_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get predefined profile response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get predefined profile", + "tags": ["DLP Profiles"] + }, + "put": { + "description": "Updates a DLP predefined profile. Only supports enabling/disabling entries.", + "operationId": "dlp-profiles-update-predefined-profile", + "parameters": [ + { + "in": "path", + "name": "profile_id", + "required": true, + "schema": { "$ref": "#/components/schemas/profile_id-JwqwymCp" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_predefined_profile" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/predefined_profile" } } }, + "description": "Update predefined profile response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/predefined_profile" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update predefined profile response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update predefined profile", + "tags": ["DLP Profiles"] + } + }, + "/accounts/{account_identifier}/dlp/profiles/{profile_id}": { + "get": { + "description": "Fetches a DLP profile by ID. Supports both predefined and custom profiles", + "operationId": "dlp-profiles-get-dlp-profile", + "parameters": [ + { + "in": "path", + "name": "profile_id", + "required": true, + "schema": { "$ref": "#/components/schemas/profile_id-JwqwymCp" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/either_profile_response-G4QJIAYV" } } + }, + "description": "Get DLP Profile response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/either_profile_response-G4QJIAYV" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get DLP Profile response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get DLP Profile", + "tags": ["DLP Profiles"] + } + }, + "/accounts/{account_identifier}/dns_firewall": { + "get": { + "description": "List configured DNS Firewall clusters for an account.", + "operationId": "dns-firewall-list-dns-firewall-clusters", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-b3jdvVAb" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/dns_firewall_response_collection" } } + }, + "description": "List DNS Firewall Clusters response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/dns_firewall_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List DNS Firewall Clusters response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List DNS Firewall Clusters", + "tags": ["DNS Firewall"], + "x-cfPermissionsRequired": { "enum": ["#dns_records:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "post": { + "description": "Create a configured DNS Firewall Cluster.", + "operationId": "dns-firewall-create-dns-firewall-cluster", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-b3jdvVAb" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "attack_mitigation": { "$ref": "#/components/schemas/attack_mitigation" }, + "deprecate_any_requests": { "$ref": "#/components/schemas/deprecate_any_requests" }, + "ecs_fallback": { "$ref": "#/components/schemas/ecs_fallback" }, + "maximum_cache_ttl": { "$ref": "#/components/schemas/maximum_cache_ttl" }, + "minimum_cache_ttl": { "$ref": "#/components/schemas/minimum_cache_ttl" }, + "name": { "$ref": "#/components/schemas/name-SScjQrIN" }, + "negative_cache_ttl": { "$ref": "#/components/schemas/negative_cache_ttl" }, + "origin_ips": { "$ref": "#/components/schemas/origin_ips" }, + "ratelimit": { "$ref": "#/components/schemas/ratelimit" }, + "retries": { "$ref": "#/components/schemas/retries-w39sVXcQ" } + }, + "required": ["name", "origin_ips"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/dns_firewall_single_response" } } + }, + "description": "Create DNS Firewall Cluster response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/dns_firewall_single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create DNS Firewall Cluster response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create DNS Firewall Cluster", + "tags": ["DNS Firewall"], + "x-cfPermissionsRequired": { "enum": ["#dns_records:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/dns_firewall/{identifier}": { + "delete": { + "description": "Delete a configured DNS Firewall Cluster.", + "operationId": "dns-firewall-delete-dns-firewall-cluster", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-b3jdvVAb" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-b3jdvVAb" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { "properties": { "id": { "$ref": "#/components/schemas/identifier-b3jdvVAb" } } } + } + } + ] + } + } + }, + "description": "Delete DNS Firewall Cluster response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { "properties": { "id": { "$ref": "#/components/schemas/identifier-b3jdvVAb" } } } + } + } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete DNS Firewall Cluster response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete DNS Firewall Cluster", + "tags": ["DNS Firewall"], + "x-cfPermissionsRequired": { "enum": ["#dns_records:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "get": { + "description": "Show a single configured DNS Firewall cluster for an account.", + "operationId": "dns-firewall-dns-firewall-cluster-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-b3jdvVAb" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-b3jdvVAb" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/dns_firewall_single_response" } } + }, + "description": "DNS Firewall Cluster Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/dns_firewall_single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "DNS Firewall Cluster Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "DNS Firewall Cluster Details", + "tags": ["DNS Firewall"], + "x-cfPermissionsRequired": { "enum": ["#dns_records:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "patch": { + "description": "Modify a DNS Firewall Cluster configuration.", + "operationId": "dns-firewall-update-dns-firewall-cluster", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-b3jdvVAb" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-b3jdvVAb" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-dns-firewall" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/dns_firewall_single_response" } } + }, + "description": "Update DNS Firewall Cluster response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/dns_firewall_single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update DNS Firewall Cluster response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update DNS Firewall Cluster", + "tags": ["DNS Firewall"], + "x-cfPermissionsRequired": { "enum": ["#dns_records:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/dns_firewall/{identifier}/dns_analytics/report": { + "get": { + "description": "Retrieves a list of summarised aggregate metrics over a given time period.\n\nSee [Analytics API properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/) for detailed information about the available query parameters.", + "operationId": "dns-firewall-analytics-table", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-98VX040R" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-98VX040R" } + }, + { "in": "query", "name": "metrics", "schema": { "$ref": "#/components/schemas/metrics" } }, + { "in": "query", "name": "dimensions", "schema": { "$ref": "#/components/schemas/dimensions" } }, + { "in": "query", "name": "since", "schema": { "$ref": "#/components/schemas/since" } }, + { "in": "query", "name": "until", "schema": { "$ref": "#/components/schemas/until" } }, + { "in": "query", "name": "limit", "schema": { "$ref": "#/components/schemas/limit" } }, + { "in": "query", "name": "sort", "schema": { "$ref": "#/components/schemas/sort" } }, + { "in": "query", "name": "filters", "schema": { "$ref": "#/components/schemas/filters-6K6BiPDe" } } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/report" } }, "type": "object" } + ] + } + } + }, + "description": "Table response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/report" } }, "type": "object" } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Table response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Table", + "tags": ["DNS Firewall Analytics"], + "x-cfPermissionsRequired": { "enum": ["#analytics:read"] } + } + }, + "/accounts/{account_identifier}/dns_firewall/{identifier}/dns_analytics/report/bytime": { + "get": { + "description": "Retrieves a list of aggregate metrics grouped by time interval.\n\nSee [Analytics API properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/) for detailed information about the available query parameters.", + "operationId": "dns-firewall-analytics-by-time", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-98VX040R" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-98VX040R" } + }, + { "in": "query", "name": "metrics", "schema": { "$ref": "#/components/schemas/metrics" } }, + { "in": "query", "name": "dimensions", "schema": { "$ref": "#/components/schemas/dimensions" } }, + { "in": "query", "name": "since", "schema": { "$ref": "#/components/schemas/since" } }, + { "in": "query", "name": "until", "schema": { "$ref": "#/components/schemas/until" } }, + { "in": "query", "name": "limit", "schema": { "$ref": "#/components/schemas/limit" } }, + { "in": "query", "name": "sort", "schema": { "$ref": "#/components/schemas/sort" } }, + { "in": "query", "name": "filters", "schema": { "$ref": "#/components/schemas/filters-6K6BiPDe" } }, + { "in": "query", "name": "time_delta", "schema": { "$ref": "#/components/schemas/time_delta" } } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/report_bytime" } }, "type": "object" } + ] + } + } + }, + "description": "By Time response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { "result": { "$ref": "#/components/schemas/report_bytime" } }, + "type": "object" + } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "By Time response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "By Time", + "tags": ["DNS Firewall Analytics"], + "x-cfPermissionsRequired": { "enum": ["#analytics:read"] } + } + }, + "/accounts/{account_identifier}/email/routing/addresses": { + "get": { + "description": "Lists existing destination addresses.", + "operationId": "email-routing-destination-addresses-list-destination-addresses", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-YhmC5GTP" } + }, + { + "in": "query", + "name": "page", + "schema": { + "default": 1, + "description": "Page number of paginated results.", + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { + "default": 20, + "description": "Maximum number of results per page.", + "maximum": 50, + "minimum": 5, + "type": "number" + } + }, + { + "in": "query", + "name": "direction", + "schema": { + "default": "asc", + "description": "Sorts results in an ascending or descending order.", + "enum": ["asc", "desc"], + "example": "asc", + "type": "string" + } + }, + { + "in": "query", + "name": "verified", + "schema": { + "default": true, + "description": "Filter by verified destination addresses.", + "enum": [true, false], + "example": true, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/destination_addresses_response_collection" } + } + }, + "description": "List destination addresses response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List destination addresses", + "tags": ["Email Routing destination addresses"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.email.routing.address.list"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "post": { + "description": "Create a destination address to forward your emails to. Destination addresses need to be verified before they can be used.", + "operationId": "email-routing-destination-addresses-create-a-destination-address", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-YhmC5GTP" } + } + ], + "requestBody": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/create_destination_address_properties" } } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/destination_address_response_single" } } + }, + "description": "Create a destination address response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create a destination address", + "tags": ["Email Routing destination addresses"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.email.routing.address.create"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/accounts/{account_identifier}/email/routing/addresses/{destination_address_identifier}": { + "delete": { + "description": "Deletes a specific destination address.", + "operationId": "email-routing-destination-addresses-delete-destination-address", + "parameters": [ + { + "in": "path", + "name": "destination_address_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/destination_address_identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-YhmC5GTP" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/destination_address_response_single" } } + }, + "description": "Delete destination address response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete destination address", + "tags": ["Email Routing destination addresses"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.email.routing.address.delete"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "get": { + "description": "Gets information for a specific destination email already created.", + "operationId": "email-routing-destination-addresses-get-a-destination-address", + "parameters": [ + { + "in": "path", + "name": "destination_address_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/destination_address_identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-YhmC5GTP" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/destination_address_response_single" } } + }, + "description": "Get a destination address response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a destination address", + "tags": ["Email Routing destination addresses"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.email.routing.address.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/accounts/{account_identifier}/firewall/access_rules/rules": { + "get": { + "description": "Fetches IP Access rules of an account. These rules apply to all the zones in the account. You can filter the results using several optional parameters.", + "operationId": "ip-access-rules-for-an-account-list-ip-access-rules", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-D3Kod1Eh" } + }, + { "in": "query", "name": "filters", "schema": { "$ref": "#/components/schemas/schemas-filters" } }, + { "in": "query", "name": "egs-pagination.json", "schema": { "$ref": "#/components/schemas/egs-pagination" } }, + { + "in": "query", + "name": "page", + "schema": { + "description": "Requested page within paginated list of results.", + "example": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { "description": "Maximum number of results requested.", "example": 20, "type": "number" } + }, + { + "in": "query", + "name": "order", + "schema": { + "description": "The field used to sort returned rules.", + "enum": ["configuration.target", "configuration.value", "mode"], + "example": "mode", + "type": "string" + } + }, + { + "in": "query", + "name": "direction", + "schema": { + "description": "The direction used to sort returned rules.", + "enum": ["asc", "desc"], + "example": "desc", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/response_collection-NcnbjEgN" } } + }, + "description": "List IP Access rules response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/response_collection-NcnbjEgN" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List IP Access rules response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List IP Access rules", + "tags": ["IP Access rules for an account"], + "x-cfPermissionsRequired": { "enum": ["#waf:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "post": { + "description": "Creates a new IP Access rule for an account. The rule will apply to all zones in the account.\n\nNote: To create an IP Access rule that applies to a single zone, refer to the [IP Access rules for a zone](#ip-access-rules-for-a-zone) endpoints.", + "operationId": "ip-access-rules-for-an-account-create-an-ip-access-rule", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-D3Kod1Eh" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "configuration": { "$ref": "#/components/schemas/schemas-configuration" }, + "mode": { "$ref": "#/components/schemas/schemas-mode" }, + "notes": { "$ref": "#/components/schemas/notes" } + }, + "required": ["mode", "configuration"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_single" } } }, + "description": "Create an IP Access rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create an IP Access rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create an IP Access rule", + "tags": ["IP Access rules for an account"], + "x-cfPermissionsRequired": { "enum": ["#waf:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/accounts/{account_identifier}/firewall/access_rules/rules/{identifier}": { + "delete": { + "description": "Deletes an existing IP Access rule defined at the account level.\n\nNote: This operation will affect all zones in the account.", + "operationId": "ip-access-rules-for-an-account-delete-an-ip-access-rule", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier-3n9sRq0H" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-D3Kod1Eh" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single-id-u7jsvBJu" } } + }, + "description": "Delete an IP Access rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single-id-u7jsvBJu" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete an IP Access rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete an IP Access rule", + "tags": ["IP Access rules for an account"], + "x-cfPermissionsRequired": { "enum": ["#waf:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "get": { + "description": "Fetches the details of an IP Access rule defined at the account level.", + "operationId": "ip-access-rules-for-an-account-get-an-ip-access-rule", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier-3n9sRq0H" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-D3Kod1Eh" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_single" } } }, + "description": "Get an IP Access rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get an IP Access rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get an IP Access rule", + "tags": ["IP Access rules for an account"], + "x-cfPermissionsRequired": { "enum": ["#waf:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Updates an IP Access rule defined at the account level.\n\nNote: This operation will affect all zones in the account.", + "operationId": "ip-access-rules-for-an-account-update-an-ip-access-rule", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier-3n9sRq0H" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-D3Kod1Eh" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-rule" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_single" } } }, + "description": "Update an IP Access rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update an IP Access rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update an IP Access rule", + "tags": ["IP Access rules for an account"], + "x-cfPermissionsRequired": { "enum": ["#waf:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/accounts/{account_identifier}/images/v1": { + "get": { + "description": "List up to 100 images with one request. Use the optional parameters below to get a specific range of images.", + "operationId": "cloudflare-images-list-images", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-account_identifier" } + }, + { + "in": "query", + "name": "page", + "schema": { + "default": 1, + "description": "Page number of paginated results.", + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { + "default": 50, + "description": "Number of items per page.", + "maximum": 100, + "minimum": 10, + "type": "number" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/image_response_collection" } } + }, + "description": "List images response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/image_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List images response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List images", + "tags": ["Cloudflare Images"] + }, + "post": { + "description": "Upload an image via URL with up to 10 Megabytes using a single HTTP POST (multipart/form-data) request.", + "operationId": "cloudflare-images-upload-an-image-via-url", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-account_identifier" } + } + ], + "requestBody": { + "content": { + "multipart/form-data": { "schema": { "$ref": "#/components/schemas/image_basic_upload_via_url" } } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/image_response_single" } } }, + "description": "Upload an image via URL response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/image_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Upload an image via URL response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Upload an image via URL", + "tags": ["Cloudflare Images"] + } + }, + "/accounts/{account_identifier}/images/v1/keys": { + "get": { + "description": "Lists your signing keys. These can be found on your Cloudflare Images dashboard.", + "operationId": "cloudflare-images-keys-list-signing-keys", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/key_response_collection" } } }, + "description": "List Signing Keys response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/key_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Signing Keys response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Signing Keys", + "tags": ["Cloudflare Images Keys"] + } + }, + "/accounts/{account_identifier}/images/v1/stats": { + "get": { + "description": "Fetch usage statistics details for Cloudflare Images.", + "operationId": "cloudflare-images-images-usage-statistics", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-account_identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/images_stats" } } }, + "description": "Images usage statistics response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/images_stats" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Images usage statistics response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Images usage statistics", + "tags": ["Cloudflare Images"] + } + }, + "/accounts/{account_identifier}/images/v1/variants": { + "get": { + "description": "Lists existing variants.", + "operationId": "cloudflare-images-variants-list-variants", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/variant_list_response" } } }, + "description": "List variants response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/variant_list_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List variants response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List variants", + "tags": ["Cloudflare Images Variants"] + }, + "post": { + "description": "Specify variants that allow you to resize images for different use cases.", + "operationId": "cloudflare-images-variants-create-a-variant", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/variant_generation_request" } } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/variant_simple_response" } } }, + "description": "Create a variant response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/variant_simple_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create a variant response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create a variant", + "tags": ["Cloudflare Images Variants"] + } + }, + "/accounts/{account_identifier}/images/v1/variants/{identifier}": { + "delete": { + "description": "Deleting a variant purges the cache for all images associated with the variant.", + "operationId": "cloudflare-images-variants-delete-a-variant", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/variants_components-schemas-identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_response" } } }, + "description": "Delete a variant response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/deleted_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete a variant response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete a variant", + "tags": ["Cloudflare Images Variants"] + }, + "get": { + "description": "Fetch details for a single variant.", + "operationId": "cloudflare-images-variants-variant-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/variants_components-schemas-identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/variant_simple_response" } } }, + "description": "Variant details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/variant_simple_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Variant details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Variant details", + "tags": ["Cloudflare Images Variants"] + }, + "patch": { + "description": "Updating a variant purges the cache for all images associated with the variant.", + "operationId": "cloudflare-images-variants-update-a-variant", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/variants_components-schemas-identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/variant_patch_request" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/variant_simple_response" } } }, + "description": "Update a variant response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/variant_simple_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update a variant response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update a variant", + "tags": ["Cloudflare Images Variants"] + } + }, + "/accounts/{account_identifier}/images/v1/{identifier}": { + "delete": { + "description": "Delete an image on Cloudflare Images. On success, all copies of the image are deleted and purged from cache.", + "operationId": "cloudflare-images-delete-image", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/images_components-schemas-identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-account_identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleted_response" } } }, + "description": "Delete image response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/deleted_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete image response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete image", + "tags": ["Cloudflare Images"] + }, + "get": { + "description": "Fetch details for a single image.", + "operationId": "cloudflare-images-image-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/images_components-schemas-identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-account_identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/image_response_single" } } }, + "description": "Image details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/image_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Image details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Image details", + "tags": ["Cloudflare Images"] + }, + "patch": { + "description": "Update image access control. On access control change, all copies of the image are purged from cache.", + "operationId": "cloudflare-images-update-image", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/images_components-schemas-identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-account_identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/image_patch_request" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/image_response_single" } } }, + "description": "Update image response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/image_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update image response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update image", + "tags": ["Cloudflare Images"] + } + }, + "/accounts/{account_identifier}/images/v1/{identifier}/blob": { + "get": { + "description": "Fetch base image. For most images this will be the originally uploaded file. For larger images it can be a near-lossless version of the original.", + "operationId": "cloudflare-images-base-image", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/images_components-schemas-identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-account_identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/image_response_blob" } } }, + "description": "Base image response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/image_response_blob" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Base image response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Base image", + "tags": ["Cloudflare Images"] + } + }, + "/accounts/{account_identifier}/images/v2/direct_upload": { + "post": { + "description": "Direct uploads allow users to upload images without API keys. A common use case are web apps, client-side applications, or mobile devices where users upload content directly to Cloudflare Images. This method creates a draft record for a future image. It returns an upload URL and an image identifier. To verify if the image itself has been uploaded, send an image details request (accounts/:account_identifier/images/v1/:identifier), and check that the `draft: true` property is not present.", + "operationId": "cloudflare-images-create-authenticated-direct-upload-url-v-2", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-account_identifier" } + } + ], + "requestBody": { + "content": { + "multipart/form-data": { "schema": { "$ref": "#/components/schemas/direct_upload_request_v2" } } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/direct_upload_response_v2" } } + }, + "description": "Create authenticated direct upload URL V2 response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/direct_upload_response_v2" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create authenticated direct upload URL V2 response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create authenticated direct upload URL V2", + "tags": ["Cloudflare Images"] + } + }, + "/accounts/{account_identifier}/intel/asn/{asn}": { + "get": { + "operationId": "asn-intelligence-get-asn-overview", + "parameters": [ + { + "in": "path", + "name": "asn", + "required": true, + "schema": { "$ref": "#/components/schemas/asn_components-schemas-asn" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/asn_components-schemas-response" } } + }, + "description": "Get ASN Overview response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/asn_components-schemas-response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get ASN Overview response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get ASN Overview", + "tags": ["ASN Intelligence"] + } + }, + "/accounts/{account_identifier}/intel/asn/{asn}/subnets": { + "get": { + "operationId": "asn-intelligence-get-asn-subnets", + "parameters": [ + { + "in": "path", + "name": "asn", + "required": true, + "schema": { "$ref": "#/components/schemas/asn_components-schemas-asn" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "asn": { "$ref": "#/components/schemas/components-schemas-asn" }, + "count": { "$ref": "#/components/schemas/count-IxGc2iY9" }, + "ip_count_total": { "type": "integer" }, + "page": { "$ref": "#/components/schemas/page" }, + "per_page": { "$ref": "#/components/schemas/components-schemas-per_page" }, + "subnets": { + "example": ["192.0.2.0/24", "2001:DB8::/32"], + "items": { "type": "string" }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "Get ASN Subnets response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "properties": { + "asn": { "$ref": "#/components/schemas/components-schemas-asn" }, + "count": { "$ref": "#/components/schemas/count-IxGc2iY9" }, + "ip_count_total": { "type": "integer" }, + "page": { "$ref": "#/components/schemas/page" }, + "per_page": { "$ref": "#/components/schemas/components-schemas-per_page" }, + "subnets": { + "example": ["192.0.2.0/24", "2001:DB8::/32"], + "items": { "type": "string" }, + "type": "array" + } + }, + "type": "object" + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get ASN Subnets response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get ASN Subnets", + "tags": ["ASN Intelligence"] + } + }, + "/accounts/{account_identifier}/intel/dns": { + "get": { + "operationId": "passive-dns-by-ip-get-passive-dns-by-ip", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { "in": "query", "name": "start_end_params", "schema": { "$ref": "#/components/schemas/start_end_params" } }, + { "in": "query", "name": "ipv4", "schema": { "type": "string" } }, + { + "in": "query", + "name": "page", + "schema": { + "description": "Requested page within paginated list of results.", + "example": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { "description": "Maximum number of results requested.", "example": 20, "type": "number" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/passive-dns-by-ip_components-schemas-single_response" } + } + }, + "description": "Get Passive DNS by IP response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/passive-dns-by-ip_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Passive DNS by IP response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Passive DNS by IP", + "tags": ["Passive DNS by IP"] + } + }, + "/accounts/{account_identifier}/intel/domain": { + "get": { + "operationId": "domain-intelligence-get-domain-details", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { "in": "query", "name": "domain", "schema": { "type": "string" } } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/domain_components-schemas-single_response" } + } + }, + "description": "Get Domain Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/domain_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Domain Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Domain Details", + "tags": ["Domain Intelligence"] + } + }, + "/accounts/{account_identifier}/intel/domain-history": { + "get": { + "operationId": "domain-history-get-domain-history", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { "in": "query", "name": "domain", "schema": { "type": "string" } } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response" } } }, + "description": "Get Domain History response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Domain History response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Domain History", + "tags": ["Domain History"] + } + }, + "/accounts/{account_identifier}/intel/domain/bulk": { + "get": { + "operationId": "domain-intelligence-get-multiple-domain-details", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "query", + "name": "domain", + "schema": { + "description": "Accepts multiple values, i.e. `?domain=cloudflare.com\u0026domain=example.com`." + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-collection_response" } } + }, + "description": "Get Multiple Domain Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-collection_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Multiple Domain Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Multiple Domain Details", + "tags": ["Domain Intelligence"] + } + }, + "/accounts/{account_identifier}/intel/ip": { + "get": { + "operationId": "ip-intelligence-get-ip-overview", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { "in": "query", "name": "ipv4", "schema": { "type": "string" } }, + { "in": "query", "name": "ipv6", "schema": { "type": "string" } } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-response" } } }, + "description": "Get IP Overview response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get IP Overview response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get IP Overview", + "tags": ["IP Intelligence"] + } + }, + "/accounts/{account_identifier}/intel/ip-list": { + "get": { + "operationId": "ip-list-get-ip-lists", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/components-schemas-response" } } + }, + "description": "Get IP Lists response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get IP Lists response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get IP Lists", + "tags": ["IP List"] + } + }, + "/accounts/{account_identifier}/intel/miscategorization": { + "post": { + "operationId": "miscategorization-create-miscategorization", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/miscategorization" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single" } } }, + "description": "Create Miscategorization response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Miscategorization response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Miscategorization", + "tags": ["Miscategorization"] + } + }, + "/accounts/{account_identifier}/intel/whois": { + "get": { + "operationId": "whois-record-get-whois-record", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { "in": "query", "name": "domain", "schema": { "type": "string" } } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/whois_components-schemas-single_response" } + } + }, + "description": "Get WHOIS Record response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/whois_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get WHOIS Record response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get WHOIS Record", + "tags": ["WHOIS Record"] + } + }, + "/accounts/{account_identifier}/load_balancers/monitors": { + "get": { + "description": "List configured monitors for an account.", + "operationId": "account-load-balancer-monitors-list-monitors", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-identifier-454QZaBH" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/monitor_components-schemas-response_collection-hQYwgX5c" } + } + }, + "description": "List Monitors response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/monitor_components-schemas-response_collection-hQYwgX5c" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Monitors response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Monitors", + "tags": ["Account Load Balancer Monitors"] + }, + "post": { + "description": "Create a configured monitor.", + "operationId": "account-load-balancer-monitors-create-monitor", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-identifier-454QZaBH" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "allow_insecure": { "$ref": "#/components/schemas/allow_insecure" }, + "consecutive_down": { "$ref": "#/components/schemas/consecutive_down" }, + "consecutive_up": { "$ref": "#/components/schemas/consecutive_up" }, + "description": { "$ref": "#/components/schemas/description-Jd6AMFjR" }, + "expected_body": { "$ref": "#/components/schemas/expected_body" }, + "expected_codes": { "$ref": "#/components/schemas/schemas-expected_codes" }, + "follow_redirects": { "$ref": "#/components/schemas/follow_redirects" }, + "header": { "$ref": "#/components/schemas/header" }, + "interval": { "$ref": "#/components/schemas/interval-hA6swy38" }, + "method": { "$ref": "#/components/schemas/method-guvmKTdR" }, + "path": { "$ref": "#/components/schemas/path-I0p9X4oI" }, + "port": { "$ref": "#/components/schemas/schemas-port-uAxZ6zJW" }, + "probe_zone": { "$ref": "#/components/schemas/probe_zone" }, + "retries": { "$ref": "#/components/schemas/retries" }, + "timeout": { "$ref": "#/components/schemas/timeout" }, + "type": { "$ref": "#/components/schemas/type-gTI6cLgq" } + }, + "required": ["expected_codes"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/monitor_components-schemas-single_response" } + } + }, + "description": "Create Monitor response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/monitor_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Monitor response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Monitor", + "tags": ["Account Load Balancer Monitors"] + } + }, + "/accounts/{account_identifier}/load_balancers/monitors/{identifier}": { + "delete": { + "description": "Delete a configured monitor.", + "operationId": "account-load-balancer-monitors-delete-monitor", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-FZThz4k7" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-identifier-454QZaBH" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/id_response-99rIWUZu" } } }, + "description": "Delete Monitor response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/id_response-99rIWUZu" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Monitor response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Monitor", + "tags": ["Account Load Balancer Monitors"] + }, + "get": { + "description": "List a single configured monitor for an account.", + "operationId": "account-load-balancer-monitors-monitor-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-FZThz4k7" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-identifier-454QZaBH" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/monitor_components-schemas-single_response" } + } + }, + "description": "Monitor Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/monitor_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Monitor Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Monitor Details", + "tags": ["Account Load Balancer Monitors"] + }, + "patch": { + "description": "Apply changes to an existing monitor, overwriting the supplied properties.", + "operationId": "account-load-balancer-monitors-patch-monitor", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-FZThz4k7" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-identifier-454QZaBH" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "allow_insecure": { "$ref": "#/components/schemas/allow_insecure" }, + "consecutive_down": { "$ref": "#/components/schemas/consecutive_down" }, + "consecutive_up": { "$ref": "#/components/schemas/consecutive_up" }, + "description": { "$ref": "#/components/schemas/description-Jd6AMFjR" }, + "expected_body": { "$ref": "#/components/schemas/expected_body" }, + "expected_codes": { "$ref": "#/components/schemas/schemas-expected_codes" }, + "follow_redirects": { "$ref": "#/components/schemas/follow_redirects" }, + "header": { "$ref": "#/components/schemas/header" }, + "interval": { "$ref": "#/components/schemas/interval-hA6swy38" }, + "method": { "$ref": "#/components/schemas/method-guvmKTdR" }, + "path": { "$ref": "#/components/schemas/path-I0p9X4oI" }, + "port": { "$ref": "#/components/schemas/schemas-port-uAxZ6zJW" }, + "probe_zone": { "$ref": "#/components/schemas/probe_zone" }, + "retries": { "$ref": "#/components/schemas/retries" }, + "timeout": { "$ref": "#/components/schemas/timeout" }, + "type": { "$ref": "#/components/schemas/type-gTI6cLgq" } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/monitor_components-schemas-single_response" } + } + }, + "description": "Patch Monitor response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/monitor_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Patch Monitor response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Patch Monitor", + "tags": ["Account Load Balancer Monitors"] + }, + "put": { + "description": "Modify a configured monitor.", + "operationId": "account-load-balancer-monitors-update-monitor", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-FZThz4k7" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-identifier-454QZaBH" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "allow_insecure": { "$ref": "#/components/schemas/allow_insecure" }, + "consecutive_down": { "$ref": "#/components/schemas/consecutive_down" }, + "consecutive_up": { "$ref": "#/components/schemas/consecutive_up" }, + "description": { "$ref": "#/components/schemas/description-Jd6AMFjR" }, + "expected_body": { "$ref": "#/components/schemas/expected_body" }, + "expected_codes": { "$ref": "#/components/schemas/schemas-expected_codes" }, + "follow_redirects": { "$ref": "#/components/schemas/follow_redirects" }, + "header": { "$ref": "#/components/schemas/header" }, + "interval": { "$ref": "#/components/schemas/interval-hA6swy38" }, + "method": { "$ref": "#/components/schemas/method-guvmKTdR" }, + "path": { "$ref": "#/components/schemas/path-I0p9X4oI" }, + "port": { "$ref": "#/components/schemas/schemas-port-uAxZ6zJW" }, + "probe_zone": { "$ref": "#/components/schemas/probe_zone" }, + "retries": { "$ref": "#/components/schemas/retries" }, + "timeout": { "$ref": "#/components/schemas/timeout" }, + "type": { "$ref": "#/components/schemas/type-gTI6cLgq" } + }, + "required": ["expected_codes"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/monitor_components-schemas-single_response" } + } + }, + "description": "Update Monitor response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/monitor_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Monitor response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Monitor", + "tags": ["Account Load Balancer Monitors"] + } + }, + "/accounts/{account_identifier}/load_balancers/monitors/{identifier}/preview": { + "post": { + "description": "Preview pools using the specified monitor with provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results.", + "operationId": "account-load-balancer-monitors-preview-monitor", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-FZThz4k7" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-identifier-454QZaBH" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "allow_insecure": { "$ref": "#/components/schemas/allow_insecure" }, + "expected_body": { "$ref": "#/components/schemas/expected_body" }, + "expected_codes": { "$ref": "#/components/schemas/schemas-expected_codes" }, + "follow_redirects": { "$ref": "#/components/schemas/follow_redirects" }, + "header": { "$ref": "#/components/schemas/header" }, + "method": { "$ref": "#/components/schemas/method-guvmKTdR" }, + "path": { "$ref": "#/components/schemas/path-I0p9X4oI" }, + "port": { "$ref": "#/components/schemas/schemas-port-uAxZ6zJW" }, + "probe_zone": { "$ref": "#/components/schemas/probe_zone" }, + "retries": { "$ref": "#/components/schemas/retries" }, + "timeout": { "$ref": "#/components/schemas/timeout" }, + "type": { "$ref": "#/components/schemas/type-gTI6cLgq" } + }, + "required": ["expected_codes"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/preview_response-ZWQ9Fl0k" } } + }, + "description": "Preview Monitor response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/preview_response-ZWQ9Fl0k" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Preview Monitor response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Preview Monitor", + "tags": ["Account Load Balancer Monitors"] + } + }, + "/accounts/{account_identifier}/load_balancers/monitors/{identifier}/references": { + "get": { + "description": "Get the list of resources that reference the provided monitor.", + "operationId": "account-load-balancer-monitors-list-monitor-references", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-FZThz4k7" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-identifier-454QZaBH" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/references_response" } } }, + "description": "List Monitor References response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/references_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Monitor References response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Monitor References", + "tags": ["Account Load Balancer Monitors"] + } + }, + "/accounts/{account_identifier}/load_balancers/pools": { + "get": { + "description": "List configured pools.", + "operationId": "account-load-balancer-pools-list-pools", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-identifier-454QZaBH" } + }, + { + "in": "query", + "name": "monitor", + "schema": { + "description": "The ID of the Monitor to use for checking the health of origins within this pool." + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-response_collection-PNoWMjSR" } } + }, + "description": "List Pools response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-response_collection-PNoWMjSR" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Pools response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Pools", + "tags": ["Account Load Balancer Pools"] + }, + "patch": { + "description": "Apply changes to a number of existing pools, overwriting the supplied properties. Pools are ordered by ascending `name`. Returns the list of affected pools. Supports the standard pagination query parameters, either `limit`/`offset` or `per_page`/`page`.", + "operationId": "account-load-balancer-pools-patch-pools", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-identifier-454QZaBH" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "notification_email": { "$ref": "#/components/schemas/patch_pools_notification_email" } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-response_collection-PNoWMjSR" } } + }, + "description": "Patch Pools response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-response_collection-PNoWMjSR" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Patch Pools response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Patch Pools", + "tags": ["Account Load Balancer Pools"] + }, + "post": { + "description": "Create a new pool.", + "operationId": "account-load-balancer-pools-create-pool", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-identifier-454QZaBH" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "description": { "$ref": "#/components/schemas/schemas-description-XvtZaN2T" }, + "enabled": { "$ref": "#/components/schemas/enabled-WoQtkwsn" }, + "latitude": { "$ref": "#/components/schemas/latitude" }, + "load_shedding": { "$ref": "#/components/schemas/load_shedding" }, + "longitude": { "$ref": "#/components/schemas/longitude" }, + "minimum_origins": { "$ref": "#/components/schemas/minimum_origins" }, + "monitor": { "$ref": "#/components/schemas/schemas-monitor" }, + "name": { "$ref": "#/components/schemas/name-Pky1OOiR" }, + "notification_email": { "$ref": "#/components/schemas/notification_email" }, + "notification_filter": { "$ref": "#/components/schemas/notification_filter" }, + "origin_steering": { "$ref": "#/components/schemas/origin_steering" }, + "origins": { "$ref": "#/components/schemas/origins-BzaDTSuG" } + }, + "required": ["origins", "name"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-single_response-uzr0CVkk" } } + }, + "description": "Create Pool response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-single_response-uzr0CVkk" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Pool response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Pool", + "tags": ["Account Load Balancer Pools"] + } + }, + "/accounts/{account_identifier}/load_balancers/pools/{identifier}": { + "delete": { + "description": "Delete a configured pool.", + "operationId": "account-load-balancer-pools-delete-pool", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier-LDS3pdXe" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-identifier-454QZaBH" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-id_response-n8mMAIdf" } } + }, + "description": "Delete Pool response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-id_response-n8mMAIdf" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Pool response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Pool", + "tags": ["Account Load Balancer Pools"] + }, + "get": { + "description": "Fetch a single configured pool.", + "operationId": "account-load-balancer-pools-pool-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier-LDS3pdXe" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-identifier-454QZaBH" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-single_response-uzr0CVkk" } } + }, + "description": "Pool Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-single_response-uzr0CVkk" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Pool Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Pool Details", + "tags": ["Account Load Balancer Pools"] + }, + "patch": { + "description": "Apply changes to an existing pool, overwriting the supplied properties.", + "operationId": "account-load-balancer-pools-patch-pool", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier-LDS3pdXe" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-identifier-454QZaBH" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "check_regions": { "$ref": "#/components/schemas/check_regions-q46IR1gk" }, + "description": { "$ref": "#/components/schemas/schemas-description-XvtZaN2T" }, + "disabled_at": { "$ref": "#/components/schemas/schemas-disabled_at" }, + "enabled": { "$ref": "#/components/schemas/enabled-WoQtkwsn" }, + "latitude": { "$ref": "#/components/schemas/latitude" }, + "load_shedding": { "$ref": "#/components/schemas/load_shedding" }, + "longitude": { "$ref": "#/components/schemas/longitude" }, + "minimum_origins": { "$ref": "#/components/schemas/minimum_origins" }, + "monitor": { "$ref": "#/components/schemas/schemas-monitor" }, + "name": { "$ref": "#/components/schemas/name-Pky1OOiR" }, + "notification_email": { "$ref": "#/components/schemas/notification_email" }, + "notification_filter": { "$ref": "#/components/schemas/notification_filter" }, + "origin_steering": { "$ref": "#/components/schemas/origin_steering" }, + "origins": { "$ref": "#/components/schemas/origins-BzaDTSuG" } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-single_response-uzr0CVkk" } } + }, + "description": "Patch Pool response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-single_response-uzr0CVkk" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Patch Pool response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Patch Pool", + "tags": ["Account Load Balancer Pools"] + }, + "put": { + "description": "Modify a configured pool.", + "operationId": "account-load-balancer-pools-update-pool", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier-LDS3pdXe" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-identifier-454QZaBH" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "check_regions": { "$ref": "#/components/schemas/check_regions-q46IR1gk" }, + "description": { "$ref": "#/components/schemas/schemas-description-XvtZaN2T" }, + "disabled_at": { "$ref": "#/components/schemas/schemas-disabled_at" }, + "enabled": { "$ref": "#/components/schemas/enabled-WoQtkwsn" }, + "latitude": { "$ref": "#/components/schemas/latitude" }, + "load_shedding": { "$ref": "#/components/schemas/load_shedding" }, + "longitude": { "$ref": "#/components/schemas/longitude" }, + "minimum_origins": { "$ref": "#/components/schemas/minimum_origins" }, + "monitor": { "$ref": "#/components/schemas/schemas-monitor" }, + "name": { "$ref": "#/components/schemas/name-Pky1OOiR" }, + "notification_email": { "$ref": "#/components/schemas/notification_email" }, + "notification_filter": { "$ref": "#/components/schemas/notification_filter" }, + "origin_steering": { "$ref": "#/components/schemas/origin_steering" }, + "origins": { "$ref": "#/components/schemas/origins-BzaDTSuG" } + }, + "required": ["origins", "name"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-single_response-uzr0CVkk" } } + }, + "description": "Update Pool response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-single_response-uzr0CVkk" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Pool response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Pool", + "tags": ["Account Load Balancer Pools"] + } + }, + "/accounts/{account_identifier}/load_balancers/pools/{identifier}/health": { + "get": { + "description": "Fetch the latest pool health status for a single pool.", + "operationId": "account-load-balancer-pools-pool-health-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier-LDS3pdXe" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-identifier-454QZaBH" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/health_details" } } }, + "description": "Pool Health Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/health_details" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Pool Health Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Pool Health Details", + "tags": ["Account Load Balancer Pools"] + } + }, + "/accounts/{account_identifier}/load_balancers/pools/{identifier}/preview": { + "post": { + "description": "Preview pool health using provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results.", + "operationId": "account-load-balancer-pools-preview-pool", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier-LDS3pdXe" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-identifier-454QZaBH" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "allow_insecure": { "$ref": "#/components/schemas/allow_insecure" }, + "expected_body": { "$ref": "#/components/schemas/expected_body" }, + "expected_codes": { "$ref": "#/components/schemas/schemas-expected_codes" }, + "follow_redirects": { "$ref": "#/components/schemas/follow_redirects" }, + "header": { "$ref": "#/components/schemas/header" }, + "method": { "$ref": "#/components/schemas/method-guvmKTdR" }, + "path": { "$ref": "#/components/schemas/path-I0p9X4oI" }, + "port": { "$ref": "#/components/schemas/schemas-port-uAxZ6zJW" }, + "probe_zone": { "$ref": "#/components/schemas/probe_zone" }, + "retries": { "$ref": "#/components/schemas/retries" }, + "timeout": { "$ref": "#/components/schemas/timeout" }, + "type": { "$ref": "#/components/schemas/type-gTI6cLgq" } + }, + "required": ["expected_codes"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/preview_response-ZWQ9Fl0k" } } + }, + "description": "Preview Pool response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/preview_response-ZWQ9Fl0k" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Preview Pool response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Preview Pool", + "tags": ["Account Load Balancer Pools"] + } + }, + "/accounts/{account_identifier}/load_balancers/pools/{identifier}/references": { + "get": { + "description": "Get the list of resources that reference the provided pool.", + "operationId": "account-load-balancer-pools-list-pool-references", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier-LDS3pdXe" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-identifier-454QZaBH" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-references_response" } } + }, + "description": "List Pool References response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-references_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Pool References response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Pool References", + "tags": ["Account Load Balancer Pools"] + } + }, + "/accounts/{account_identifier}/load_balancers/preview/{preview_id}": { + "get": { + "description": "Get the result of a previous preview operation using the provided preview_id.", + "operationId": "account-load-balancer-monitors-preview-result", + "parameters": [ + { + "in": "path", + "name": "preview_id", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-preview_id" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-identifier-454QZaBH" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/preview_result_response-181bkyJU" } } + }, + "description": "Preview Result response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/preview_result_response-181bkyJU" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Preview Result response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Preview Result", + "tags": ["Account Load Balancer Monitors"] + } + }, + "/accounts/{account_identifier}/load_balancers/regions": { + "get": { + "description": "List all region mappings.", + "operationId": "load-balancer-regions-list-regions", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-identifier-454QZaBH" } + }, + { + "in": "query", + "name": "subdivision_code", + "schema": { "$ref": "#/components/schemas/subdivision_code_a2" } + }, + { + "in": "query", + "name": "subdivision_code_a2", + "schema": { "$ref": "#/components/schemas/subdivision_code_a2" } + }, + { + "in": "query", + "name": "country_code_a2", + "schema": { + "description": "Two-letter alpha-2 country code followed in ISO 3166-1.", + "example": "US", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/region_components-schemas-response_collection" } + } + }, + "description": "List Regions response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/region_components-schemas-response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Regions response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Regions", + "tags": ["Load Balancer Regions"] + } + }, + "/accounts/{account_identifier}/load_balancers/regions/{region_code}": { + "get": { + "description": "Get a single region mapping.", + "operationId": "load-balancer-regions-get-region", + "parameters": [ + { + "in": "path", + "name": "region_code", + "required": true, + "schema": { "$ref": "#/components/schemas/region_code" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-identifier-454QZaBH" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-single_response-AhobaCUU" } + } + }, + "description": "Get Region response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-single_response-AhobaCUU" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Region response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Region", + "tags": ["Load Balancer Regions"] + } + }, + "/accounts/{account_identifier}/load_balancers/search": { + "get": { + "description": "Search for Load Balancing resources.", + "operationId": "account-load-balancer-search-search-resources", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-identifier-454QZaBH" } + }, + { "in": "query", "name": "search_params", "schema": { "$ref": "#/components/schemas/search_params" } }, + { "in": "query", "name": "page", "schema": { "minimum": 1 } }, + { "in": "query", "name": "per_page", "schema": { "default": 25, "maximum": 1000, "minimum": 1 } } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "$ref": "#/components/schemas/search_result" } + ] + } + } + }, + "description": "Search Resources response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "$ref": "#/components/schemas/search_result" } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Search Resources response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Search Resources", + "tags": ["Account Load Balancer Search"] + } + }, + "/accounts/{account_identifier}/logpush/datasets/{dataset}/fields": { + "get": { + "description": "Lists all fields available for a dataset. The response result is an object with key-value pairs, where keys are field names, and values are descriptions.", + "operationId": "get-accounts-account_identifier-logpush-datasets-dataset-fields", + "parameters": [ + { "in": "path", "name": "dataset", "required": true, "schema": { "$ref": "#/components/schemas/dataset" } }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Gw95Cj70" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/logpush_field_response_collection" } } + }, + "description": "List fields response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/logpush_field_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List fields response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List fields", + "tags": ["Logpush jobs for an account"], + "x-cfPermissionsRequired": { "enum": ["#logs:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/logpush/datasets/{dataset}/jobs": { + "get": { + "description": "Lists Logpush jobs for an account for a dataset.", + "operationId": "get-accounts-account_identifier-logpush-datasets-dataset-jobs", + "parameters": [ + { "in": "path", "name": "dataset", "required": true, "schema": { "$ref": "#/components/schemas/dataset" } }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Gw95Cj70" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/logpush_job_response_collection" } } + }, + "description": "List Logpush jobs for a dataset response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/logpush_job_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Logpush jobs for a dataset response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Logpush jobs for a dataset", + "tags": ["Logpush jobs for an account"], + "x-cfPermissionsRequired": { "enum": ["#logs:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/logpush/jobs": { + "get": { + "description": "Lists Logpush jobs for an account.", + "operationId": "get-accounts-account_identifier-logpush-jobs", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Gw95Cj70" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/logpush_job_response_collection" } } + }, + "description": "List Logpush jobs response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/logpush_job_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Logpush jobs response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Logpush jobs", + "tags": ["Logpush jobs for an account"], + "x-cfPermissionsRequired": { "enum": ["#logs:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "post": { + "description": "Creates a new Logpush job for an account.", + "operationId": "post-accounts-account_identifier-logpush-jobs", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Gw95Cj70" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "dataset": { "$ref": "#/components/schemas/dataset" }, + "destination_conf": { "$ref": "#/components/schemas/destination_conf" }, + "enabled": { "$ref": "#/components/schemas/enabled-A6pti18n" }, + "frequency": { "$ref": "#/components/schemas/frequency" }, + "logpull_options": { "$ref": "#/components/schemas/logpull_options" }, + "name": { "$ref": "#/components/schemas/name-rRqaJzmt" }, + "ownership_challenge": { "$ref": "#/components/schemas/ownership_challenge" } + }, + "required": ["destination_conf"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/logpush_job_response_single" } } + }, + "description": "Create Logpush job response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/logpush_job_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Logpush job response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Logpush job", + "tags": ["Logpush jobs for an account"], + "x-cfPermissionsRequired": { "enum": ["#logs:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/logpush/jobs/{job_identifier}": { + "delete": { + "description": "Deletes a Logpush job.", + "operationId": "delete-accounts-account_identifier-logpush-jobs-job_identifier", + "parameters": [ + { + "in": "path", + "name": "job_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/id-Un5diNDY" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Gw95Cj70" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { "properties": { "result": { "example": {}, "nullable": true, "type": "object" } } } + ] + } + } + }, + "description": "Delete Logpush job response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { "properties": { "result": { "example": {}, "nullable": true, "type": "object" } } } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Logpush job response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Logpush job", + "tags": ["Logpush jobs for an account"], + "x-cfPermissionsRequired": { "enum": ["#logs:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "get": { + "description": "Gets the details of a Logpush job.", + "operationId": "get-accounts-account_identifier-logpush-jobs-job_identifier", + "parameters": [ + { + "in": "path", + "name": "job_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/id-Un5diNDY" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Gw95Cj70" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/logpush_job_response_single" } } + }, + "description": "Get Logpush job details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/logpush_job_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Logpush job details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Logpush job details", + "tags": ["Logpush jobs for an account"], + "x-cfPermissionsRequired": { "enum": ["#logs:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "put": { + "description": "Updates a Logpush job.", + "operationId": "put-accounts-account_identifier-logpush-jobs-job_identifier", + "parameters": [ + { + "in": "path", + "name": "job_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/id-Un5diNDY" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Gw95Cj70" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "destination_conf": { "$ref": "#/components/schemas/destination_conf" }, + "enabled": { "$ref": "#/components/schemas/enabled-A6pti18n" }, + "frequency": { "$ref": "#/components/schemas/frequency" }, + "logpull_options": { "$ref": "#/components/schemas/logpull_options" }, + "ownership_challenge": { "$ref": "#/components/schemas/ownership_challenge" } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/logpush_job_response_single" } } + }, + "description": "Update Logpush job response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/logpush_job_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Logpush job response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Logpush job", + "tags": ["Logpush jobs for an account"], + "x-cfPermissionsRequired": { "enum": ["#logs:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/logpush/ownership": { + "post": { + "description": "Gets a new ownership challenge sent to your destination.", + "operationId": "post-accounts-account_identifier-logpush-ownership", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Gw95Cj70" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "destination_conf": { "$ref": "#/components/schemas/destination_conf" } }, + "required": ["destination_conf"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_ownership_response" } } }, + "description": "Get ownership challenge response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/get_ownership_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get ownership challenge response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get ownership challenge", + "tags": ["Logpush jobs for an account"], + "x-cfPermissionsRequired": { "enum": ["#logs:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/logpush/ownership/validate": { + "post": { + "description": "Validates ownership challenge of the destination.", + "operationId": "post-accounts-account_identifier-logpush-ownership-validate", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Gw95Cj70" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "destination_conf": { "$ref": "#/components/schemas/destination_conf" }, + "ownership_challenge": { "$ref": "#/components/schemas/ownership_challenge" } + }, + "required": ["destination_conf", "ownership_challenge"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/validate_ownership_response" } } + }, + "description": "Validate ownership challenge response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/validate_ownership_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Validate ownership challenge response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Validate ownership challenge", + "tags": ["Logpush jobs for an account"], + "x-cfPermissionsRequired": { "enum": ["#logs:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/logpush/validate/destination/exists": { + "post": { + "description": "Checks if there is an existing job with a destination.", + "operationId": "delete-accounts-account_identifier-logpush-validate-destination-exists", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Gw95Cj70" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "destination_conf": { "$ref": "#/components/schemas/destination_conf" } }, + "required": ["destination_conf"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/destination_exists_response" } } + }, + "description": "Check destination exists response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/destination_exists_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Check destination exists response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Check destination exists", + "tags": ["Logpush jobs for an account"], + "x-cfPermissionsRequired": { "enum": ["#logs:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/logpush/validate/origin": { + "post": { + "description": "Validates logpull origin with logpull_options.", + "operationId": "post-accounts-account_identifier-logpush-validate-origin", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Gw95Cj70" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "logpull_options": { "$ref": "#/components/schemas/logpull_options" } }, + "required": ["logpull_options"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/validate_response-PaQpkUV3" } } + }, + "description": "Validate origin response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/validate_response-PaQpkUV3" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Validate origin response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Validate origin", + "tags": ["Logpush jobs for an account"], + "x-cfPermissionsRequired": { "enum": ["#logs:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/logs/control/cmb/config": { + "delete": { + "description": "Deletes CMB config.", + "operationId": "delete-accounts-account_identifier-logs-control-cmb-config", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-59LodGbZ" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { "properties": { "result": { "example": {}, "nullable": true, "type": "object" } } } + ] + } + } + }, + "description": "Delete CMB config response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { "properties": { "result": { "example": {}, "nullable": true, "type": "object" } } } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete CMB config response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete CMB config", + "tags": ["Logcontrol CMB config for an account"], + "x-cfPermissionsRequired": { "enum": ["#logs:edit"] } + }, + "get": { + "description": "Gets CMB config.", + "operationId": "get-accounts-account_identifier-logs-control-cmb-config", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-59LodGbZ" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/cmb_config_response_single" } } + }, + "description": "Get CMB config response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { "allOf": [{ "$ref": "#/components/schemas/api-response-common-failure" }] } + } + }, + "description": "Get CMB config response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get CMB config", + "tags": ["Logcontrol CMB config for an account"], + "x-cfPermissionsRequired": { "enum": ["#logs:edit"] } + }, + "post": { + "description": "Updates CMB config.", + "operationId": "put-accounts-account_identifier-logs-control-cmb-config", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-59LodGbZ" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cmb_config" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/cmb_config_response_single" } } + }, + "description": "Update CMB config response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { "allOf": [{ "$ref": "#/components/schemas/api-response-common-failure" }] } + } + }, + "description": "Update CMB config response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update CMB config", + "tags": ["Logcontrol CMB config for an account"], + "x-cfPermissionsRequired": { "enum": ["#logs:edit"] } + } + }, + "/accounts/{account_identifier}/magic/cf_interconnects": { + "get": { + "description": "Lists interconnects associated with an account.", + "operationId": "magic-interconnects-list-interconnects", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-tunnels_collection_response" } + } + }, + "description": "List interconnects response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-tunnels_collection_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List interconnects response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List interconnects", + "tags": ["Magic Interconnects"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "put": { + "description": "Updates multiple interconnects associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.", + "operationId": "magic-interconnects-update-multiple-interconnects", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + } + ], + "requestBody": { "content": { "application/json": { "schema": { "required": ["id"] } } }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-modified_tunnels_collection_response" } + } + }, + "description": "Update multiple interconnects response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-modified_tunnels_collection_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update multiple interconnects response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update multiple interconnects", + "tags": ["Magic Interconnects"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/magic/cf_interconnects/{tunnel_identifier}": { + "get": { + "description": "Lists details for a specific interconnect.", + "operationId": "magic-interconnects-list-interconnect-details", + "parameters": [ + { + "in": "path", + "name": "tunnel_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-tunnel_single_response" } + } + }, + "description": "List interconnect Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-tunnel_single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List interconnect Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List interconnect Details", + "tags": ["Magic Interconnects"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "put": { + "description": "Updates a specific interconnect associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.", + "operationId": "magic-interconnects-update-interconnect", + "parameters": [ + { + "in": "path", + "name": "tunnel_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-tunnel_update_request" } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-tunnel_modified_response" } + } + }, + "description": "Update interconnect response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-tunnel_modified_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update interconnect response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update interconnect", + "tags": ["Magic Interconnects"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/magic/gre_tunnels": { + "get": { + "description": "Lists GRE tunnels associated with an account.", + "operationId": "magic-gre-tunnels-list-gre-tunnels", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/tunnels_collection_response" } } + }, + "description": "List GRE tunnels response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/tunnels_collection_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List GRE tunnels response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List GRE tunnels", + "tags": ["Magic GRE tunnels"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "post": { + "description": "Creates new GRE tunnels. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.", + "operationId": "magic-gre-tunnels-create-gre-tunnels", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "required": ["name", "customer_gre_endpoint", "cloudflare_gre_endpoint", "interface_address"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/tunnels_collection_response" } } + }, + "description": "Create GRE tunnels response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/tunnels_collection_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create GRE tunnels response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create GRE tunnels", + "tags": ["Magic GRE tunnels"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "put": { + "description": "Updates multiple GRE tunnels. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.", + "operationId": "magic-gre-tunnels-update-multiple-gre-tunnels", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + } + ], + "requestBody": { "content": { "application/json": { "schema": { "required": ["id"] } } }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/modified_tunnels_collection_response" } } + }, + "description": "Update multiple GRE tunnels response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/modified_tunnels_collection_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update multiple GRE tunnels response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update multiple GRE tunnels", + "tags": ["Magic GRE tunnels"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/magic/gre_tunnels/{tunnel_identifier}": { + "delete": { + "description": "Disables and removes a specific static GRE tunnel. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.", + "operationId": "magic-gre-tunnels-delete-gre-tunnel", + "parameters": [ + { + "in": "path", + "name": "tunnel_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tunnel_deleted_response" } } }, + "description": "Delete GRE Tunnel response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/tunnel_deleted_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete GRE Tunnel response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete GRE Tunnel", + "tags": ["Magic GRE tunnels"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "get": { + "description": "Lists informtion for a specific GRE tunnel.", + "operationId": "magic-gre-tunnels-list-gre-tunnel-details", + "parameters": [ + { + "in": "path", + "name": "tunnel_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tunnel_single_response" } } }, + "description": "List GRE Tunnel Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/tunnel_single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List GRE Tunnel Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List GRE Tunnel Details", + "tags": ["Magic GRE tunnels"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "put": { + "description": "Updates a specific GRE tunnel. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.", + "operationId": "magic-gre-tunnels-update-gre-tunnel", + "parameters": [ + { + "in": "path", + "name": "tunnel_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tunnel_update_request" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/tunnel_modified_response" } } + }, + "description": "Update GRE Tunnel response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/tunnel_modified_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update GRE Tunnel response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update GRE Tunnel", + "tags": ["Magic GRE tunnels"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/magic/ipsec_tunnels": { + "get": { + "description": "Lists IPsec tunnels associated with an account.", + "operationId": "magic-i-psec-tunnels-list-i-psec-tunnels", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-tunnels_collection_response" } } + }, + "description": "List IPsec tunnels response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-tunnels_collection_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List IPsec tunnels response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List IPsec tunnels", + "tags": ["Magic IPsec tunnels"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "post": { + "description": "Creates new IPsec tunnels associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.", + "operationId": "magic-i-psec-tunnels-create-i-psec-tunnels", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "required": ["name", "customer_ipsec_endpoint", "cloudflare_ipsec_endpoint", "interface_address"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-tunnels_collection_response" } } + }, + "description": "Create IPsec tunnels response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-tunnels_collection_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create IPsec tunnels response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create IPsec tunnels", + "tags": ["Magic IPsec tunnels"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "put": { + "description": "Update multiple IPsec tunnels associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.", + "operationId": "magic-i-psec-tunnels-update-multiple-i-psec-tunnels", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + } + ], + "requestBody": { "content": { "application/json": { "schema": { "required": ["id"] } } }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/schemas-modified_tunnels_collection_response" } + } + }, + "description": "Update multiple IPsec tunnels response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-modified_tunnels_collection_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update multiple IPsec tunnels response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update multiple IPsec tunnels", + "tags": ["Magic IPsec tunnels"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/magic/ipsec_tunnels/{tunnel_identifier}": { + "delete": { + "description": "Disables and removes a specific static IPsec Tunnel associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.", + "operationId": "magic-i-psec-tunnels-delete-i-psec-tunnel", + "parameters": [ + { + "in": "path", + "name": "tunnel_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-tunnel_deleted_response" } } + }, + "description": "Delete IPsec Tunnel response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-tunnel_deleted_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete IPsec Tunnel response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete IPsec Tunnel", + "tags": ["Magic IPsec tunnels"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "get": { + "description": "Lists details for a specific IPsec tunnel.", + "operationId": "magic-i-psec-tunnels-list-i-psec-tunnel-details", + "parameters": [ + { + "in": "path", + "name": "tunnel_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-tunnel_single_response" } } + }, + "description": "List IPsec tunnel details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-tunnel_single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List IPsec tunnel details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List IPsec tunnel details", + "tags": ["Magic IPsec tunnels"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "put": { + "description": "Updates a specific IPsec tunnel associated with an account. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes.", + "operationId": "magic-i-psec-tunnels-update-i-psec-tunnel", + "parameters": [ + { + "in": "path", + "name": "tunnel_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + } + ], + "requestBody": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-tunnel_update_request" } } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-tunnel_modified_response" } } + }, + "description": "Update IPsec Tunnel response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-tunnel_modified_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update IPsec Tunnel response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update IPsec Tunnel", + "tags": ["Magic IPsec tunnels"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/magic/ipsec_tunnels/{tunnel_identifier}/psk_generate": { + "post": { + "description": "Generates a Pre Shared Key for a specific IPsec tunnel used in the IKE session. Use `?validate_only=true` as an optional query parameter to only run validation without persisting changes. After a PSK is generated, the PSK is immediately persisted to Cloudflare's edge and cannot be retrieved later. Note the PSK in a safe place.", + "operationId": "magic-i-psec-tunnels-generate-pre-shared-key-(-psk)-for-i-psec-tunnels", + "parameters": [ + { + "in": "path", + "name": "tunnel_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/psk_generation_response" } } }, + "description": "Generate Pre Shared Key (PSK) for IPsec tunnels response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/psk_generation_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Generate Pre Shared Key (PSK) for IPsec tunnels response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Generate Pre Shared Key (PSK) for IPsec tunnels", + "tags": ["Magic IPsec tunnels"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/magic/routes": { + "delete": { + "description": "Delete multiple Magic static routes.", + "operationId": "magic-static-routes-delete-many-routes", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/route_delete_many_request" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/multiple_route_delete_response" } } + }, + "description": "Delete Many Routes response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/multiple_route_delete_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Many Routes response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Many Routes", + "tags": ["Magic Static Routes"], + "x-cfPermissionsRequired": { "enum": ["#organization:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "get": { + "description": "List all Magic static routes.", + "operationId": "magic-static-routes-list-routes", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/routes_collection_response" } } + }, + "description": "List Routes response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/routes_collection_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Routes response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Routes", + "tags": ["Magic Static Routes"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "post": { + "description": "Creates a new Magic static route. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes.", + "operationId": "magic-static-routes-create-routes", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "required": ["prefix", "nexthop", "priority"] } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/routes_collection_response" } } + }, + "description": "Create Routes response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/routes_collection_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Routes response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Routes", + "tags": ["Magic Static Routes"], + "x-cfPermissionsRequired": { "enum": ["#organization:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "put": { + "description": "Update multiple Magic static routes. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes. Only fields for a route that need to be changed need be provided.", + "operationId": "magic-static-routes-update-many-routes", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/route_update_many_request" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/multiple_route_modified_response" } } + }, + "description": "Update Many Routes response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/multiple_route_modified_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Many Routes response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Many Routes", + "tags": ["Magic Static Routes"], + "x-cfPermissionsRequired": { "enum": ["#organization:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/magic/routes/{route_identifier}": { + "delete": { + "description": "Disable and remove a specific Magic static route.", + "operationId": "magic-static-routes-delete-route", + "parameters": [ + { + "in": "path", + "name": "route_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/route_deleted_response" } } }, + "description": "Delete Route response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/route_deleted_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Route response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Route", + "tags": ["Magic Static Routes"], + "x-cfPermissionsRequired": { "enum": ["#organization:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "get": { + "description": "Get a specific Magic static route.", + "operationId": "magic-static-routes-route-details", + "parameters": [ + { + "in": "path", + "name": "route_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/route_single_response" } } }, + "description": "Route Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/route_single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Route Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Route Details", + "tags": ["Magic Static Routes"], + "x-cfPermissionsRequired": { "enum": ["#organization:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "put": { + "description": "Update a specific Magic static route. Use `?validate_only=true` as an optional query parameter to run validation only without persisting changes.", + "operationId": "magic-static-routes-update-route", + "parameters": [ + { + "in": "path", + "name": "route_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-5dNKLCP5" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/route_update_request" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/route_modified_response" } } }, + "description": "Update Route response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/route_modified_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Route response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Route", + "tags": ["Magic Static Routes"], + "x-cfPermissionsRequired": { "enum": ["#organization:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/members": { + "get": { + "description": "List all members of an account.", + "operationId": "account-members-list-members", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-D3Kod1Eh" } + }, + { + "in": "query", + "name": "order", + "schema": { + "description": "Field to order results by.", + "enum": ["user.first_name", "user.last_name", "user.email", "status"], + "example": "status" + } + }, + { + "in": "query", + "name": "status", + "schema": { + "description": "A member's status in the account.", + "enum": ["accepted", "pending", "rejected"], + "example": "accepted", + "type": "string" + } + }, + { + "in": "query", + "name": "page", + "schema": { + "default": 1, + "description": "Page number of paginated results.", + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { + "default": 20, + "description": "Maximum number of results per page.", + "maximum": 50, + "minimum": 5, + "type": "number" + } + }, + { + "in": "query", + "name": "direction", + "schema": { + "description": "Direction to order results.", + "enum": ["asc", "desc"], + "example": "desc", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/response_collection-NcnbjEgN" } } + }, + "description": "List Members response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/response_collection-NcnbjEgN" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Members response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Members", + "tags": ["Account Members"], + "x-cfPermissionsRequired": { "enum": ["#organization:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "post": { + "description": "Add a user to the list of members for this account.", + "operationId": "account-members-add-member", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-D3Kod1Eh" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_single" } } }, + "description": "Add Member response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Add Member response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Add Member", + "tags": ["Account Members"], + "x-cfPermissionsRequired": { "enum": ["#organization:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/accounts/{account_identifier}/members/{identifier}": { + "delete": { + "description": "Remove a member from an account.", + "operationId": "account-members-remove-member", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier-3n9sRq0H" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-D3Kod1Eh" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single-id-u7jsvBJu" } } + }, + "description": "Remove Member response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single-id-u7jsvBJu" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Remove Member response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Remove Member", + "tags": ["Account Members"], + "x-cfPermissionsRequired": { "enum": ["#organization:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "get": { + "description": "Get information about a specific member of an account.", + "operationId": "account-members-member-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier-3n9sRq0H" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-D3Kod1Eh" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_single" } } }, + "description": "Member Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Member Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Member Details", + "tags": ["Account Members"], + "x-cfPermissionsRequired": { "enum": ["#organization:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "put": { + "description": "Modify an account member.", + "operationId": "account-members-update-member", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier-3n9sRq0H" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-D3Kod1Eh" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-member" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_single" } } }, + "description": "Update Member response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Member response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Member", + "tags": ["Account Members"], + "x-cfPermissionsRequired": { "enum": ["#organization:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/accounts/{account_identifier}/mnm/config": { + "delete": { + "description": "Delete an existing network monitoring configuration.", + "operationId": "magic-network-monitoring-configuration-delete-account-configuration", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/config_components-schemas-account_identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/mnm_config_single_response" } } + }, + "description": "Delete account configuration response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/mnm_config_single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete account configuration response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete account configuration", + "tags": ["Magic Network Monitoring Configuration"] + }, + "get": { + "description": "Lists default sampling and router IPs for account.", + "operationId": "magic-network-monitoring-configuration-list-account-configuration", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/config_components-schemas-account_identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/mnm_config_single_response" } } + }, + "description": "List account configuration response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/mnm_config_single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List account configuration response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List account configuration", + "tags": ["Magic Network Monitoring Configuration"] + }, + "patch": { + "description": "Update fields in an existing network monitoring configuration.", + "operationId": "magic-network-monitoring-configuration-update-account-configuration-fields", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/config_components-schemas-account_identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/mnm_config_single_response" } } + }, + "description": "Update account configuration fields response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/mnm_config_single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update account configuration fields response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update account configuration fields", + "tags": ["Magic Network Monitoring Configuration"] + }, + "post": { + "description": "Create a new network monitoring configuration.", + "operationId": "magic-network-monitoring-configuration-create-account-configuration", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/config_components-schemas-account_identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/mnm_config_single_response" } } + }, + "description": "Create account configuration response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/mnm_config_single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create account configuration response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create account configuration", + "tags": ["Magic Network Monitoring Configuration"] + }, + "put": { + "description": "Update an existing network monitoring configuration, requires the entire configuration to be updated at once.", + "operationId": "magic-network-monitoring-configuration-update-an-entire-account-configuration", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/config_components-schemas-account_identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/mnm_config_single_response" } } + }, + "description": "Update an entire account configuration response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/mnm_config_single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update an entire account configuration response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update an entire account configuration", + "tags": ["Magic Network Monitoring Configuration"] + } + }, + "/accounts/{account_identifier}/mnm/config/full": { + "get": { + "description": "Lists default sampling, router IPs, and rules for account.", + "operationId": "magic-network-monitoring-configuration-list-rules-and-account-configuration", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/config_components-schemas-account_identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/mnm_config_single_response" } } + }, + "description": "List rules and account configuration response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/mnm_config_single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List rules and account configuration response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List rules and account configuration", + "tags": ["Magic Network Monitoring Configuration"] + } + }, + "/accounts/{account_identifier}/mnm/rules": { + "get": { + "description": "Lists network monitoring rules for account.", + "operationId": "magic-network-monitoring-rules-list-rules", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/rules_components-schemas-account_identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/mnm_rules_collection_response" } } + }, + "description": "List rules response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/mnm_rules_collection_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List rules response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List rules", + "tags": ["Magic Network Monitoring Rules"] + }, + "post": { + "description": "Create network monitoring rules for account.", + "operationId": "magic-network-monitoring-rules-create-rules", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/rules_components-schemas-account_identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/mnm_rules_single_response" } } + }, + "description": "Create rules response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/mnm_rules_single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create rules response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create rules", + "tags": ["Magic Network Monitoring Rules"] + }, + "put": { + "description": "Update network monitoring rules for account.", + "operationId": "magic-network-monitoring-rules-update-rules", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/rules_components-schemas-account_identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/mnm_rules_single_response" } } + }, + "description": "Update rules response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/mnm_rules_single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update rules response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update rules", + "tags": ["Magic Network Monitoring Rules"] + } + }, + "/accounts/{account_identifier}/mnm/rules/{rule_identifier}": { + "delete": { + "description": "Delete a network monitoring rule for account.", + "operationId": "magic-network-monitoring-rules-delete-rule", + "parameters": [ + { + "in": "path", + "name": "rule_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/rule_identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/rules_components-schemas-account_identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/mnm_rules_single_response" } } + }, + "description": "Delete rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/mnm_rules_single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete rule", + "tags": ["Magic Network Monitoring Rules"] + }, + "get": { + "description": "List a single network monitoring rule for account.", + "operationId": "magic-network-monitoring-rules-get-rule", + "parameters": [ + { + "in": "path", + "name": "rule_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/rule_identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/rules_components-schemas-account_identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/mnm_rules_single_response" } } + }, + "description": "Get rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/mnm_rules_single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get rule", + "tags": ["Magic Network Monitoring Rules"] + }, + "patch": { + "description": "Update a network monitoring rule for account.", + "operationId": "magic-network-monitoring-rules-update-rule", + "parameters": [ + { + "in": "path", + "name": "rule_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/rule_identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/rules_components-schemas-account_identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/mnm_rules_single_response" } } + }, + "description": "Update rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/mnm_rules_single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update rule", + "tags": ["Magic Network Monitoring Rules"] + } + }, + "/accounts/{account_identifier}/mnm/rules/{rule_identifier}/advertisement": { + "patch": { + "description": "Update advertisement for rule.", + "operationId": "magic-network-monitoring-rules-update-advertisement-for-rule", + "parameters": [ + { + "in": "path", + "name": "rule_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/rule_identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/rules_components-schemas-account_identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/mnm_rule_advertisement_single_response" } + } + }, + "description": "Update advertisement for rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/mnm_rule_advertisement_single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update advertisement for rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update advertisement for rule", + "tags": ["Magic Network Monitoring Rules"] + } + }, + "/accounts/{account_identifier}/mtls_certificates": { + "get": { + "description": "Lists all mTLS certificates.", + "operationId": "m-tls-certificate-management-list-m-tls-certificates", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/mtls-management_components-schemas-certificate_response_collection" + } + } + }, + "description": "List mTLS certificates response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/mtls-management_components-schemas-certificate_response_collection" + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List mTLS certificates response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List mTLS certificates", + "tags": ["mTLS Certificate Management"], + "x-cfPermissionsRequired": { "enum": ["#ssl:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "post": { + "description": "Upload a certificate that you want to use with mTLS-enabled Cloudflare services.", + "operationId": "m-tls-certificate-management-upload-m-tls-certificate", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "ca": { "$ref": "#/components/schemas/ca" }, + "certificates": { "$ref": "#/components/schemas/schemas-certificates" }, + "name": { "$ref": "#/components/schemas/mtls-management_components-schemas-name" }, + "private_key": { "$ref": "#/components/schemas/components-schemas-private_key" } + }, + "required": ["certificates", "private_key", "ca"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/certificate_response_single_post" } } + }, + "description": "Upload mTLS certificate response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/certificate_response_single_post" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Upload mTLS certificate response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Upload mTLS certificate", + "tags": ["mTLS Certificate Management"], + "x-cfPermissionsRequired": { "enum": ["#ssl:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/accounts/{account_identifier}/mtls_certificates/{identifier}": { + "delete": { + "description": "Deletes the mTLS certificate unless the certificate is in use by one or more Cloudflare services.", + "operationId": "m-tls-certificate-management-delete-m-tls-certificate", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/mtls-management_components-schemas-identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/mtls-management_components-schemas-certificate_response_single" + } + } + }, + "description": "Delete mTLS certificate response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/mtls-management_components-schemas-certificate_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete mTLS certificate response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete mTLS certificate", + "tags": ["mTLS Certificate Management"], + "x-cfPermissionsRequired": { "enum": ["#ssl:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "get": { + "description": "Fetches a single mTLS certificate.", + "operationId": "m-tls-certificate-management-get-m-tls-certificate", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/mtls-management_components-schemas-identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/mtls-management_components-schemas-certificate_response_single" + } + } + }, + "description": "Get mTLS certificate response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/mtls-management_components-schemas-certificate_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get mTLS certificate response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get mTLS certificate", + "tags": ["mTLS Certificate Management"], + "x-cfPermissionsRequired": { "enum": ["#ssl:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/accounts/{account_identifier}/mtls_certificates/{identifier}/associations": { + "get": { + "description": "Lists all active associations between the certificate and Cloudflare services.", + "operationId": "m-tls-certificate-management-list-m-tls-certificate-associations", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/mtls-management_components-schemas-identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/association_response_collection" } } + }, + "description": "List mTLS certificate associations response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/association_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List mTLS certificate associations response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List mTLS certificate associations", + "tags": ["mTLS Certificate Management"], + "x-cfPermissionsRequired": { "enum": ["#ssl:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/accounts/{account_identifier}/pages/projects": { + "get": { + "description": "Fetch a list of all user projects.", + "operationId": "pages-project-get-projects", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-g7jwPNXP" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/projects-response" } } }, + "description": "Get projects response." + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/projects-response" }, + { "$ref": "#/components/schemas/api-response-common-failure-C6O0X824" } + ] + } + } + }, + "description": "Get projects response failure." + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get projects", + "tags": ["Pages Project"] + }, + "post": { + "description": "Create a new project.", + "operationId": "pages-project-create-project", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-g7jwPNXP" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/projects" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/new-project-response" } } }, + "description": "Create project response." + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/new-project-response" }, + { "$ref": "#/components/schemas/api-response-common-failure-C6O0X824" } + ] + } + } + }, + "description": "Create project response failure." + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create project", + "tags": ["Pages Project"] + } + }, + "/accounts/{account_identifier}/pages/projects/{project_name}": { + "delete": { + "description": "Delete a project by name.", + "operationId": "pages-project-delete-project", + "parameters": [ + { + "in": "path", + "name": "project_name", + "required": true, + "schema": { "$ref": "#/components/schemas/project_name" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-g7jwPNXP" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "example": { "errors": [], "messages": [], "result": null, "success": true } } + } + }, + "description": "Delete project response." + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "example": { "errors": [], "messages": [], "result": null, "success": true } }, + { "$ref": "#/components/schemas/api-response-common-failure-C6O0X824" } + ] + } + } + }, + "description": "Delete project response failure." + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete project", + "tags": ["Pages Project"] + }, + "get": { + "description": "Fetch a project by name.", + "operationId": "pages-project-get-project", + "parameters": [ + { + "in": "path", + "name": "project_name", + "required": true, + "schema": { "$ref": "#/components/schemas/project_name" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-g7jwPNXP" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project-response" } } }, + "description": "Get project response." + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/project-response" }, + { "$ref": "#/components/schemas/api-response-common-failure-C6O0X824" } + ] + } + } + }, + "description": "Get project response failure." + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get project", + "tags": ["Pages Project"] + }, + "patch": { + "description": "Set new attributes for an existing project. Modify environment variables. To delete an environment variable, set the key to null.", + "operationId": "pages-project-update-project", + "parameters": [ + { + "in": "path", + "name": "project_name", + "required": true, + "schema": { "$ref": "#/components/schemas/project_name" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-g7jwPNXP" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project-patch" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/new-project-response" } } }, + "description": "Update project response." + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/new-project-response" }, + { "$ref": "#/components/schemas/api-response-common-failure-C6O0X824" } + ] + } + } + }, + "description": "Update project response failure." + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update project", + "tags": ["Pages Project"] + } + }, + "/accounts/{account_identifier}/pages/projects/{project_name}/deployments": { + "get": { + "description": "Fetch a list of project deployments.", + "operationId": "pages-deployment-get-deployments", + "parameters": [ + { + "in": "path", + "name": "project_name", + "required": true, + "schema": { "$ref": "#/components/schemas/project_name" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-g7jwPNXP" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/deployment-list-response" } } + }, + "description": "Get deployments response." + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/deployment-list-response" }, + { "$ref": "#/components/schemas/api-response-common-failure-C6O0X824" } + ] + } + } + }, + "description": "Get deployments response failure." + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get deployments", + "tags": ["Pages Deployment"] + }, + "post": { + "description": "Start a new deployment from production. The repository and account must have already been authorized on the Cloudflare Pages dashboard.", + "operationId": "pages-deployment-create-deployment", + "parameters": [ + { + "in": "path", + "name": "project_name", + "required": true, + "schema": { "$ref": "#/components/schemas/project_name" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-g7jwPNXP" } + } + ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "properties": { + "branch": { + "description": "The branch to build the new deployment from. The `HEAD` of the branch will be used. If omitted, the production branch will be used by default.", + "example": "staging", + "type": "string" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/deployment-new-deployment" } } + }, + "description": "Create deployment response." + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/deployment-new-deployment" }, + { "$ref": "#/components/schemas/api-response-common-failure-C6O0X824" } + ] + } + } + }, + "description": "Create deployment response failure." + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create deployment", + "tags": ["Pages Deployment"] + } + }, + "/accounts/{account_identifier}/pages/projects/{project_name}/deployments/{deployment_identifier}": { + "delete": { + "description": "Delete a deployment.", + "operationId": "pages-deployment-delete-deployment", + "parameters": [ + { + "in": "path", + "name": "deployment_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-g7jwPNXP" } + }, + { + "in": "path", + "name": "project_name", + "required": true, + "schema": { "$ref": "#/components/schemas/project_name" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-g7jwPNXP" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "example": { "errors": [], "messages": [], "result": null, "success": true } } + } + }, + "description": "Delete deployment response." + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "example": { "errors": [], "messages": [], "result": null, "success": true } }, + { "$ref": "#/components/schemas/api-response-common-failure-C6O0X824" } + ] + } + } + }, + "description": "Delete deployment response failure." + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete deployment", + "tags": ["Pages Deployment"] + }, + "get": { + "description": "Fetch information about a deployment.", + "operationId": "pages-deployment-get-deployment-info", + "parameters": [ + { + "in": "path", + "name": "deployment_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-g7jwPNXP" } + }, + { + "in": "path", + "name": "project_name", + "required": true, + "schema": { "$ref": "#/components/schemas/project_name" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-g7jwPNXP" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/deployment-response-details" } } + }, + "description": "Get deployment info response." + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/deployment-response-details" }, + { "$ref": "#/components/schemas/api-response-common-failure-C6O0X824" } + ] + } + } + }, + "description": "Get deployment info response failure." + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get deployment info", + "tags": ["Pages Deployment"] + } + }, + "/accounts/{account_identifier}/pages/projects/{project_name}/deployments/{deployment_identifier}/history/logs": { + "get": { + "description": "Fetch deployment logs for a project.", + "operationId": "pages-deployment-get-deployment-logs", + "parameters": [ + { + "in": "path", + "name": "deployment_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-g7jwPNXP" } + }, + { + "in": "path", + "name": "project_name", + "required": true, + "schema": { "$ref": "#/components/schemas/project_name" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-g7jwPNXP" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/deployment-response-logs" } } + }, + "description": "Get deployment logs response." + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/deployment-response-logs" }, + { "$ref": "#/components/schemas/api-response-common-failure-C6O0X824" } + ] + } + } + }, + "description": "Get deployment logs response failure." + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get deployment logs", + "tags": ["Pages Deployment"] + } + }, + "/accounts/{account_identifier}/pages/projects/{project_name}/deployments/{deployment_identifier}/retry": { + "post": { + "description": "Retry a previous deployment.", + "operationId": "pages-deployment-retry-deployment", + "parameters": [ + { + "in": "path", + "name": "deployment_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-g7jwPNXP" } + }, + { + "in": "path", + "name": "project_name", + "required": true, + "schema": { "$ref": "#/components/schemas/project_name" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-g7jwPNXP" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/deployment-new-deployment" } } + }, + "description": "Retry deployment response." + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/deployment-new-deployment" }, + { "$ref": "#/components/schemas/api-response-common-failure-C6O0X824" } + ] + } + } + }, + "description": "Retry deployment response failure." + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Retry deployment", + "tags": ["Pages Deployment"] + } + }, + "/accounts/{account_identifier}/pages/projects/{project_name}/deployments/{deployment_identifier}/rollback": { + "post": { + "description": "Rollback the production deployment to a previous deployment. You can only rollback to succesful builds on production.", + "operationId": "pages-deployment-rollback-deployment", + "parameters": [ + { + "in": "path", + "name": "deployment_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-g7jwPNXP" } + }, + { + "in": "path", + "name": "project_name", + "required": true, + "schema": { "$ref": "#/components/schemas/project_name" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-g7jwPNXP" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/deployment-response-details" } } + }, + "description": "Rollback deployment response." + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/deployment-response-details" }, + { "$ref": "#/components/schemas/api-response-common-failure-C6O0X824" } + ] + } + } + }, + "description": "Rollback deployment response failure." + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Rollback deployment", + "tags": ["Pages Deployment"] + } + }, + "/accounts/{account_identifier}/pages/projects/{project_name}/domains": { + "get": { + "description": "Fetch a list of all domains associated with a Pages project.", + "operationId": "pages-domains-get-domains", + "parameters": [ + { + "in": "path", + "name": "project_name", + "required": true, + "schema": { "$ref": "#/components/schemas/project_name" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-g7jwPNXP" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/domain-response-collection" } } + }, + "description": "Get domains response." + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/domain-response-collection" }, + { "$ref": "#/components/schemas/api-response-common-failure-C6O0X824" } + ] + } + } + }, + "description": "Get domains response failure." + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get domains", + "tags": ["Pages Domains"] + }, + "post": { + "description": "Add a new domain for the Pages project.", + "operationId": "pages-domains-add-domain", + "parameters": [ + { + "in": "path", + "name": "project_name", + "required": true, + "schema": { "$ref": "#/components/schemas/project_name" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-g7jwPNXP" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/domains-post" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/domain-response-single" } } }, + "description": "Add domain response." + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/domain-response-single" }, + { "$ref": "#/components/schemas/api-response-common-failure-C6O0X824" } + ] + } + } + }, + "description": "Add domain response failure." + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Add domain", + "tags": ["Pages Domains"] + } + }, + "/accounts/{account_identifier}/pages/projects/{project_name}/domains/{domain_name}": { + "delete": { + "description": "Delete a Pages project's domain.", + "operationId": "pages-domains-delete-domain", + "parameters": [ + { + "in": "path", + "name": "domain_name", + "required": true, + "schema": { "$ref": "#/components/schemas/domain_name" } + }, + { + "in": "path", + "name": "project_name", + "required": true, + "schema": { "$ref": "#/components/schemas/project_name" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-g7jwPNXP" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "example": { "errors": [], "messages": [], "result": null, "success": true } } + } + }, + "description": "Delete domain response." + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "example": { "errors": [], "messages": [], "result": null, "success": true } }, + { "$ref": "#/components/schemas/api-response-common-failure-C6O0X824" } + ] + } + } + }, + "description": "Delete domain response failure." + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete domain", + "tags": ["Pages Domains"] + }, + "get": { + "description": "Fetch a single domain.", + "operationId": "pages-domains-get-domain", + "parameters": [ + { + "in": "path", + "name": "domain_name", + "required": true, + "schema": { "$ref": "#/components/schemas/domain_name" } + }, + { + "in": "path", + "name": "project_name", + "required": true, + "schema": { "$ref": "#/components/schemas/project_name" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-g7jwPNXP" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/domain-response-single" } } }, + "description": "Get domain response." + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/domain-response-single" }, + { "$ref": "#/components/schemas/api-response-common-failure-C6O0X824" } + ] + } + } + }, + "description": "Get domain response failure." + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get domain", + "tags": ["Pages Domains"] + }, + "patch": { + "description": "Retry the validation status of a single domain.", + "operationId": "pages-domains-patch-domain", + "parameters": [ + { + "in": "path", + "name": "domain_name", + "required": true, + "schema": { "$ref": "#/components/schemas/domain_name" } + }, + { + "in": "path", + "name": "project_name", + "required": true, + "schema": { "$ref": "#/components/schemas/project_name" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-g7jwPNXP" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/domain-response-single" } } }, + "description": "Patch domain response." + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/domain-response-single" }, + { "$ref": "#/components/schemas/api-response-common-failure-C6O0X824" } + ] + } + } + }, + "description": "Patch domain response failure." + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Patch domain", + "tags": ["Pages Domains"] + } + }, + "/accounts/{account_identifier}/pcaps": { + "get": { + "description": "Lists all packet capture requests for an account.", + "operationId": "magic-pcap-collection-list-packet-capture-requests", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/pcaps_collection_response" } } + }, + "description": "List packet capture requests response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/pcaps_collection_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List packet capture requests response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List packet capture requests", + "tags": ["Magic PCAP collection"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "post": { + "description": "Create new PCAP request for account.", + "operationId": "magic-pcap-collection-create-pcap-request", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pcaps_request_pcap" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pcaps_single_response" } } }, + "description": "Create PCAP request response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/pcaps_single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create PCAP request response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create PCAP request", + "tags": ["Magic PCAP collection"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/pcaps/ownership": { + "get": { + "description": "List all buckets configured for use with PCAPs API.", + "operationId": "magic-pcap-collection-list-pca-ps-bucket-ownership", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/pcaps_ownership_collection" } } + }, + "description": "List PCAPs Bucket Ownership response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/pcaps_ownership_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List PCAPs Bucket Ownership response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List PCAPs Bucket Ownership", + "tags": ["Magic PCAP collection"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "post": { + "description": "Adds an AWS or GCP bucket to use with full packet captures.", + "operationId": "magic-pcap-collection-add-buckets-for-full-packet-captures", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pcaps_ownership_request" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/pcaps_ownership_single_response" } } + }, + "description": "Add buckets for full packet captures response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/pcaps_ownership_single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Add buckets for full packet captures response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Add buckets for full packet captures", + "tags": ["Magic PCAP collection"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/pcaps/ownership/validate": { + "post": { + "description": "Validates buckets added to the packet captures API.", + "operationId": "magic-pcap-collection-validate-buckets-for-full-packet-captures", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/pcaps_ownership_validate_request" } } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/pcaps_ownership_single_response" } } + }, + "description": "Validate buckets for full packet captures response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/pcaps_ownership_single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Validate buckets for full packet captures response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Validate buckets for full packet captures", + "tags": ["Magic PCAP collection"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/pcaps/ownership/{identifier}": { + "delete": { + "description": "Deletes buckets added to the packet captures API.", + "operationId": "magic-pcap-collection-delete-buckets-for-full-packet-captures", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": {} }, + "description": "Delete buckets for full packet captures response" + }, + "4xx": { + "content": { "application/json": {} }, + "description": "Delete buckets for full packet captures response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete buckets for full packet captures", + "tags": ["Magic PCAP collection"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/pcaps/{identifier}": { + "get": { + "description": "Get information for a PCAP request by id.", + "operationId": "magic-pcap-collection-get-pcap-request", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pcaps_single_response" } } }, + "description": "Get PCAP request response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/pcaps_single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get PCAP request response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get PCAP request", + "tags": ["Magic PCAP collection"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/pcaps/{identifier}/download": { + "get": { + "description": "Download PCAP information into a file. Response is a binary PCAP file.", + "operationId": "magic-pcap-collection-download-simple-pcap", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { "content": { "application/json": {} }, "description": "Download Simple PCAP response" }, + "4xx": { "content": { "application/json": {} }, "description": "Download Simple PCAP response failure" } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Download Simple PCAP", + "tags": ["Magic PCAP collection"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/r2/buckets": { + "get": { + "description": "Lists all R2 buckets on your account", + "operationId": "r-2-bucket-list-buckets", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "query", + "name": "name_contains", + "schema": { + "description": "Bucket names to filter by. Only buckets with this phrase in their name will be returned.", + "example": "my-bucket", + "type": "string" + } + }, + { + "in": "query", + "name": "start_after", + "schema": { + "description": "Bucket name to start searching after. Buckets are ordered lexicographically.", + "example": "my-bucket", + "type": "string" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { + "default": 20, + "description": "Maximum number of buckets to return in a single call", + "maximum": 1000, + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "order", + "schema": { "description": "Field to order buckets by", "enum": ["name"], "type": "string" } + }, + { + "in": "query", + "name": "direction", + "schema": { + "description": "Direction to order buckets", + "enum": ["asc", "desc"], + "example": "desc", + "type": "string" + } + }, + { + "in": "query", + "name": "cursor", + "schema": { + "description": "Pagination cursor received during the last List Buckets call. R2 buckets are paginated using cursors instead of page numbers.", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/r2-single-bucket-operation-response" } } + }, + "description": "List Buckets response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/r2-single-bucket-operation-response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Buckets response failure" + } + }, + "security": [{ "api_token": [] }], + "summary": "List Buckets", + "tags": ["R2 Bucket"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.r2.bucket.list"] } + }, + "post": { + "description": "Creates a new R2 bucket.", + "operationId": "r-2-bucket-create-bucket", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "example": "{'name': 'example-bucket'}" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/r2-single-bucket-operation-response" } } + }, + "description": "Create Bucket response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/r2-single-bucket-operation-response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Bucket response failure" + } + }, + "security": [{ "api_token": [] }], + "summary": "Create Bucket", + "tags": ["R2 Bucket"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.r2.bucket.create"] } + } + }, + "/accounts/{account_identifier}/r2/buckets/{bucket_name}": { + "delete": { + "description": "Deletes an existing R2 bucket.", + "operationId": "r-2-bucket-delete-bucket", + "parameters": [ + { + "in": "path", + "name": "bucket_name", + "required": true, + "schema": { "$ref": "#/components/schemas/bucket_name" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/r2-single-bucket-operation-response" } } + }, + "description": "Delete Bucket response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/r2-single-bucket-operation-response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Bucket response failure" + } + }, + "security": [{ "api_token": [] }], + "summary": "Delete Bucket", + "tags": ["R2 Bucket"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.r2.bucket.delete"] } + } + }, + "/accounts/{account_identifier}/railguns": { + "get": { + "description": "List, search, sort and filter your Railguns.", + "operationId": "account-railguns-list-railguns", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "query", + "name": "page", + "schema": { + "default": 1, + "description": "Page number of paginated results.", + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { + "default": 20, + "description": "Number of items per page.", + "maximum": 50, + "minimum": 5, + "type": "number" + } + }, + { + "in": "query", + "name": "direction", + "schema": { + "description": "Sort Railguns in ascending or descending order.", + "enum": ["asc", "desc"], + "example": "desc" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/railgun_response_collection" } } + }, + "description": "List Railguns response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/railgun_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Railguns response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Railguns", + "tags": ["Account Railguns"], + "x-cfPermissionsRequired": { "enum": ["#organization:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + }, + "post": { + "operationId": "account-railguns-create-railgun", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "name": { "$ref": "#/components/schemas/railgun_components-schemas-name" } }, + "required": ["name"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/railgun_response_single" } } }, + "description": "Create Railgun response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/railgun_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Railgun response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Railgun", + "tags": ["Account Railguns"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/railguns/{identifier}": { + "delete": { + "description": "Disable and delete a Railgun. This will immediately disable the Railgun for any connected zones.", + "operationId": "account-railguns-delete-a-railgun", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/railgun_components-schemas-identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/railgun_response_single_id" } } + }, + "description": "Delete a Railgun response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/railgun_response_single_id" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete a Railgun response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete a Railgun", + "tags": ["Account Railguns"], + "x-cfPermissionsRequired": { "enum": ["#organization:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + }, + "get": { + "operationId": "account-railguns-railgun-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/railgun_components-schemas-identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/railgun_response_single" } } }, + "description": "Railgun details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/railgun_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Railgun details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Railgun details", + "tags": ["Account Railguns"], + "x-cfPermissionsRequired": { "enum": ["#organization:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + }, + "put": { + "description": "Update a Railgun.", + "operationId": "account-railguns-update-railgun", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/railgun_components-schemas-identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-railgun" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/railgun_response_single" } } }, + "description": "Update Railgun response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/railgun_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Railgun response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Railgun", + "tags": ["Account Railguns"], + "x-cfPermissionsRequired": { "enum": ["#organization:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/railguns/{railgun_identifier}/connections": { + "get": { + "description": "List connections associated with the Railgun.", + "operationId": "railgun-connections-list-connections", + "parameters": [ + { + "in": "path", + "name": "railgun_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/railgun_components-schemas-identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "query", + "name": "enabled", + "schema": { "$ref": "#/components/schemas/connection_components-schemas-enabled" } + }, + { + "in": "query", + "name": "page", + "schema": { + "description": "Requested page within paginated list of results.", + "example": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { "description": "Maximum number of results requested.", "example": 20, "type": "number" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/connection_collection_response" } } + }, + "description": "List Connections response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/connection_collection_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Connections response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Connections", + "tags": ["Railgun Connections"], + "x-cfPermissionsRequired": { "enum": ["#organization:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + }, + "post": { + "description": "Associates a zone to the Railgun.", + "operationId": "railgun-connections-create-connection", + "parameters": [ + { + "in": "path", + "name": "railgun_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/railgun_components-schemas-identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/connection_single_request" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/connection_single_response" } } + }, + "description": "Create connection response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/connection_single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create connection response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create connection", + "tags": ["Railgun Connections"], + "x-cfPermissionsRequired": { "enum": ["#organization:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/railguns/{railgun_identifier}/connections/{identifier}": { + "delete": { + "description": "Disable and remove the connection to a zone.", + "operationId": "railgun-connections-delete-connection", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/connection_components-schemas-identifier" } + }, + { + "in": "path", + "name": "railgun_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/railgun_components-schemas-identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/connection_single_id_response" } } + }, + "description": "Delete connection response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/connection_single_id_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete connection response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete connection", + "tags": ["Railgun Connections"], + "x-cfPermissionsRequired": { "enum": ["#organization:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + }, + "get": { + "description": "Get a connection by ID.", + "operationId": "railgun-connections-connection-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/connection_components-schemas-identifier" } + }, + { + "in": "path", + "name": "railgun_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/railgun_components-schemas-identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/connection_single_response" } } + }, + "description": "Connection details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/connection_single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Connection details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Connection details", + "tags": ["Railgun Connections"], + "x-cfPermissionsRequired": { "enum": ["#organization:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + }, + "put": { + "description": "Enable or disable a connection.", + "operationId": "railgun-connections-update-connection", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/connection_components-schemas-identifier" } + }, + { + "in": "path", + "name": "railgun_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/railgun_components-schemas-identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/connection-Xm0br0wV" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/connection_single_response" } } + }, + "description": "Update connection response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/connection_single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update connection response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update connection", + "tags": ["Railgun Connections"], + "x-cfPermissionsRequired": { "enum": ["#organization:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/registrar/domains": { + "post": { + "description": "List domains handled by Registrar.", + "operationId": "registrar-domains-list-domains", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { "properties": { "id": { "$ref": "#/components/schemas/domain_names" } }, "required": ["id"] } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/domain_response_collection" } } + }, + "description": "List domains response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/domain_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List domains response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List domains", + "tags": ["Registrar Domains"] + } + }, + "/accounts/{account_identifier}/registrar/domains/{domain_name}": { + "get": { + "description": "Show individual domain.", + "operationId": "registrar-domains-get-domain", + "parameters": [ + { + "in": "path", + "name": "domain_name", + "required": true, + "schema": { "$ref": "#/components/schemas/domain_name-lovco9gj" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/domain_response_single" } } }, + "description": "Get domain response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/domain_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get domain response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get domain", + "tags": ["Registrar Domains"] + }, + "put": { + "description": "Update individual domain.", + "operationId": "registrar-domains-update-domain", + "parameters": [ + { + "in": "path", + "name": "domain_name", + "required": true, + "schema": { "$ref": "#/components/schemas/domain_name-lovco9gj" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { "schema": { "allOf": [{ "$ref": "#/components/schemas/domain_update_properties" }] } } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/domain_response_single" } } }, + "description": "Update domain response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/domain_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update domain response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update domain", + "tags": ["Registrar Domains"] + } + }, + "/accounts/{account_identifier}/request-tracer/trace": { + "post": { + "operationId": "account-request-tracer-request-trace", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-gI2sCanq" } + } + ], + "requestBody": { + "content": { + "application/json": { + "example": { + "body": { "base64": "c29tZV9yZXF1ZXN0X2JvZHk=" }, + "context": { "geoloc": { "city": "London" }, "skip_challenge": true }, + "cookies": { "cookie_name_1": "cookie_value_1", "cookie_name_2": "cookie_value_2" }, + "headers": { "header_name_1": "header_value_1", "header_name_2": "header_value_2" }, + "method": "PUT", + "protocol": "HTTP/1.1", + "url": "https://some.zone/some_path" + }, + "schema": { + "properties": { + "body": { + "properties": { + "base64": { + "description": "Base64 encoded request body", + "example": "c29tZV9yZXF1ZXN0X2JvZHk=", + "type": "string" + }, + "json": { "description": "Arbitrary json as request body", "type": "object" }, + "plain_text": { "description": "Request body as plain text", "type": "string" } + }, + "type": "object" + }, + "context": { + "description": "Additional request parameters", + "properties": { + "bot_score": { + "description": "Bot score used for evaluating tracing request processing", + "type": "integer" + }, + "geoloc": { + "description": "Geodata for tracing request", + "properties": { + "city": { "example": "London", "type": "string" }, + "continent": { "type": "string" }, + "is_eu_country": { "type": "boolean" }, + "iso_code": { "type": "string" }, + "latitude": { "type": "number" }, + "longitude": { "type": "number" }, + "postal_code": { "type": "string" }, + "region_code": { "type": "string" }, + "subdivision_2_iso_code": { "type": "string" }, + "timezone": { "type": "string" } + }, + "type": "object" + }, + "skip_challenge": { + "description": "Whether to skip any challenges for tracing request (e.g.: captcha)", + "example": true, + "type": "boolean" + }, + "threat_score": { + "description": "Threat score used for evaluating tracing request processing", + "type": "integer" + } + }, + "type": "object" + }, + "cookies": { + "additionalProperties": { "type": "string" }, + "description": "Cookies added to tracing request", + "example": { "cookie_name_1": "cookie_value_1", "cookie_name_2": "cookie_value_2" }, + "type": "object" + }, + "headers": { + "additionalProperties": { "type": "string" }, + "description": "Headers added to tracing request", + "example": { "header_name_1": "header_value_1", "header_name_2": "header_value_2" }, + "type": "object" + }, + "method": { "description": "HTTP Method of tracing request", "example": "PUT", "type": "string" }, + "protocol": { + "description": "HTTP Protocol of tracing request", + "example": "HTTP/1.1", + "type": "string" + }, + "skip_response": { + "description": "Skip sending the request to the Origin server after all rules evaluation", + "type": "boolean" + }, + "url": { + "description": "URL to which perform tracing request", + "example": "https://some.zone/some_path", + "type": "string" + } + }, + "required": ["url", "method"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { + "properties": { + "result": { + "description": "Trace result with an origin status code", + "properties": { + "status_code": { "description": "HTTP Status code of zone response", "type": "integer" }, + "trace": { "$ref": "#/components/schemas/trace" } + }, + "type": "object" + } + }, + "type": "object" + } + ], + "type": "object" + } + } + }, + "description": "Request Trace response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { "allOf": [{ "$ref": "#/components/schemas/api-response-common-failure" }] } + } + }, + "description": "Request Trace response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Request Trace", + "tags": ["Account Request Tracer"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/accounts/{account_identifier}/roles": { + "get": { + "description": "Get all available roles for an account.", + "operationId": "account-roles-list-roles", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-D3Kod1Eh" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/response_collection-NcnbjEgN" } } + }, + "description": "List Roles response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/response_collection-NcnbjEgN" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Roles response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Roles", + "tags": ["Account Roles"], + "x-cfPermissionsRequired": { "enum": ["#organization:read"] } + } + }, + "/accounts/{account_identifier}/roles/{identifier}": { + "get": { + "description": "Get information about a specific role for an account.", + "operationId": "account-roles-role-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier-3n9sRq0H" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-D3Kod1Eh" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_single" } } }, + "description": "Role Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Role Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Role Details", + "tags": ["Account Roles"], + "x-cfPermissionsRequired": { "enum": ["#organization:read"] } + } + }, + "/accounts/{account_identifier}/rules/lists": { + "get": { + "description": "Fetches all lists in the account.", + "operationId": "lists-get-lists", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/lists-response-collection" } } + }, + "description": "Get lists response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/lists-response-collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get lists response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get lists", + "tags": ["Lists"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "post": { + "description": "Creates a new list of the specified type.", + "operationId": "lists-create-a-list", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "description": { "$ref": "#/components/schemas/lists_components-schemas-description" }, + "kind": { "$ref": "#/components/schemas/kind-ZDHCkJmG" }, + "name": { "$ref": "#/components/schemas/lists_components-schemas-name" } + }, + "required": ["name", "kind"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/list-response-collection" } } + }, + "description": "Create a list response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/list-response-collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create a list response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create a list", + "tags": ["Lists"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/accounts/{account_identifier}/rules/lists/bulk_operations/{operation_id}": { + "get": { + "description": "Gets the current status of an asynchronous operation on a list.\n\nThe `status` property can have one of the following values: `pending`, `running`, `completed`, or `failed`. If the status is `failed`, the `error` property will contain a message describing the error.", + "operationId": "lists-get-bulk-operation-status", + "parameters": [ + { + "in": "path", + "name": "operation_id", + "required": true, + "schema": { "$ref": "#/components/schemas/operation_id" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/bulk-operation-response-collection" } } + }, + "description": "Get bulk operation status response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/bulk-operation-response-collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get bulk operation status response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get bulk operation status", + "tags": ["Lists"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/accounts/{account_identifier}/rules/lists/{list_id}": { + "delete": { + "description": "Deletes a specific list and all its items.", + "operationId": "lists-delete-a-list", + "parameters": [ + { "in": "path", "name": "list_id", "required": true, "schema": { "$ref": "#/components/schemas/list_id" } }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/list-delete-response-collection" } } + }, + "description": "Delete a list response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/list-delete-response-collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete a list response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete a list", + "tags": ["Lists"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "get": { + "description": "Fetches the details of a list.", + "operationId": "lists-get-a-list", + "parameters": [ + { "in": "path", "name": "list_id", "required": true, "schema": { "$ref": "#/components/schemas/list_id" } }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/list-response-collection" } } + }, + "description": "Get a list response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/list-response-collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get a list response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a list", + "tags": ["Lists"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "put": { + "description": "Updates the description of a list.", + "operationId": "lists-update-a-list", + "parameters": [ + { "in": "path", "name": "list_id", "required": true, "schema": { "$ref": "#/components/schemas/list_id" } }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "description": { "$ref": "#/components/schemas/lists_components-schemas-description" } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/list-response-collection" } } + }, + "description": "Update a list response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/list-response-collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update a list response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update a list", + "tags": ["Lists"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/accounts/{account_identifier}/rules/lists/{list_id}/items": { + "delete": { + "description": "Removes one or more items from a list.\n\nThis operation is asynchronous. To get current the operation status, invoke the [Get bulk operation status](#lists-get-bulk-operation-status) endpoint with the returned `operation_id`.", + "operationId": "lists-delete-list-items", + "parameters": [ + { "in": "path", "name": "list_id", "required": true, "schema": { "$ref": "#/components/schemas/list_id" } }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "items": { + "items": { "properties": { "id": { "$ref": "#/components/schemas/item_id" } } }, + "minItems": 1, + "type": "array" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lists-async-response" } } }, + "description": "Delete list items response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/lists-async-response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete list items response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete list items", + "tags": ["Lists"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "get": { + "description": "Fetches all the items in the list.", + "operationId": "lists-get-list-items", + "parameters": [ + { "in": "path", "name": "list_id", "required": true, "schema": { "$ref": "#/components/schemas/list_id" } }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "query", + "name": "cursor", + "schema": { + "description": "The pagination cursor. An opaque string token indicating the position from which to continue when requesting the next/previous set of records. Cursor values are provided under `result_info.cursors` in the response. You should make no assumptions about a cursor's content or length.", + "example": "zzz", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/items-list-response-collection" } } + }, + "description": "Get list items response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/items-list-response-collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get list items response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get list items", + "tags": ["Lists"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "post": { + "description": "Appends new items to the list.\n\nThis operation is asynchronous. To get current the operation status, invoke the [Get bulk operation status](#lists-get-bulk-operation-status) endpoint with the returned `operation_id`.", + "operationId": "lists-create-list-items", + "parameters": [ + { "in": "path", "name": "list_id", "required": true, "schema": { "$ref": "#/components/schemas/list_id" } }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/items-update-request-collection" } } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lists-async-response" } } }, + "description": "Create list items response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/lists-async-response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create list items response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create list items", + "tags": ["Lists"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "put": { + "description": "Removes all existing items from the list and adds the provided items to the list.\n\nThis operation is asynchronous. To get current the operation status, invoke the [Get bulk operation status](#lists-get-bulk-operation-status) endpoint with the returned `operation_id`.", + "operationId": "lists-update-all-list-items", + "parameters": [ + { "in": "path", "name": "list_id", "required": true, "schema": { "$ref": "#/components/schemas/list_id" } }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/items-update-request-collection" } } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lists-async-response" } } }, + "description": "Update all list items response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/lists-async-response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update all list items response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update all list items", + "tags": ["Lists"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/accounts/{account_identifier}/rules/lists/{list_id}/items/{item_id}": { + "get": { + "description": "Fetches a list item in the list.", + "operationId": "lists-get-a-list-item", + "parameters": [ + { "in": "path", "name": "item_id", "required": true, "schema": { "$ref": "#/components/schemas/item_id" } }, + { "in": "path", "name": "list_id", "required": true, "schema": { "$ref": "#/components/schemas/list_id" } }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/item-response-collection" } } + }, + "description": "Get a list item response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/item-response-collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get a list item response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a list item", + "tags": ["Lists"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/accounts/{account_identifier}/secondary_dns/acls": { + "get": { + "description": "List ACLs.", + "operationId": "secondary-dns-(-acl)-list-ac-ls", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-DCAPOmrB" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-response_collection-Np6QDZ3m" } + } + }, + "description": "List ACLs response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-response_collection-Np6QDZ3m" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List ACLs response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List ACLs", + "tags": ["Secondary DNS (ACL)"], + "x-cfPermissionsRequired": { "enum": ["#organization:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "post": { + "description": "Create ACL.", + "operationId": "secondary-dns-(-acl)-create-acl", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-DCAPOmrB" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "required": ["name", "ip_range"] } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-single_response-UrWzkhyF" } + } + }, + "description": "Create ACL response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-single_response-UrWzkhyF" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create ACL response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create ACL", + "tags": ["Secondary DNS (ACL)"], + "x-cfPermissionsRequired": { "enum": ["#dns_records:edit", "#organization:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/secondary_dns/acls/{identifier}": { + "delete": { + "description": "Delete ACL.", + "operationId": "secondary-dns-(-acl)-delete-acl", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-DCAPOmrB" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/components-schemas-id_response" } } + }, + "description": "Delete ACL response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-id_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete ACL response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete ACL", + "tags": ["Secondary DNS (ACL)"], + "x-cfPermissionsRequired": { "enum": ["#dns_records:edit", "#organization:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "get": { + "description": "Get ACL.", + "operationId": "secondary-dns-(-acl)-acl-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-DCAPOmrB" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-single_response-UrWzkhyF" } + } + }, + "description": "ACL Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-single_response-UrWzkhyF" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "ACL Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "ACL Details", + "tags": ["Secondary DNS (ACL)"], + "x-cfPermissionsRequired": { "enum": ["#organization:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "put": { + "description": "Modify ACL.", + "operationId": "secondary-dns-(-acl)-update-acl", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-DCAPOmrB" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/acl" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-single_response-UrWzkhyF" } + } + }, + "description": "Update ACL response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-single_response-UrWzkhyF" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update ACL response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update ACL", + "tags": ["Secondary DNS (ACL)"], + "x-cfPermissionsRequired": { "enum": ["#dns_records:edit", "#organization:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/secondary_dns/peers": { + "get": { + "description": "List Peers.", + "operationId": "secondary-dns-(-peer)-list-peers", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-DCAPOmrB" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-response_collection-AREv1gR0" } } + }, + "description": "List Peers response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-response_collection-AREv1gR0" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Peers response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Peers", + "tags": ["Secondary DNS (Peer)"], + "x-cfPermissionsRequired": { "enum": ["#dns_records:read", "#organization:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "post": { + "description": "Create Peer.", + "operationId": "secondary-dns-(-peer)-create-peer", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-DCAPOmrB" } + } + ], + "requestBody": { "content": { "application/json": { "schema": { "required": ["name"] } } }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-single_response-PJU34P3b" } } + }, + "description": "Create Peer response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-single_response-PJU34P3b" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Peer response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Peer", + "tags": ["Secondary DNS (Peer)"], + "x-cfPermissionsRequired": { "enum": ["#dns_records:edit", "#organization:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/secondary_dns/peers/{identifier}": { + "delete": { + "description": "Delete Peer.", + "operationId": "secondary-dns-(-peer)-delete-peer", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-DCAPOmrB" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/components-schemas-id_response" } } + }, + "description": "Delete Peer response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-id_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Peer response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Peer", + "tags": ["Secondary DNS (Peer)"], + "x-cfPermissionsRequired": { "enum": ["#dns_records:edit", "#organization:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "get": { + "description": "Get Peer.", + "operationId": "secondary-dns-(-peer)-peer-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-DCAPOmrB" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-single_response-PJU34P3b" } } + }, + "description": "Peer Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-single_response-PJU34P3b" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Peer Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Peer Details", + "tags": ["Secondary DNS (Peer)"], + "x-cfPermissionsRequired": { "enum": ["#dns_records:read", "#organization:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "put": { + "description": "Modify Peer.", + "operationId": "secondary-dns-(-peer)-update-peer", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-DCAPOmrB" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/peer" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-single_response-PJU34P3b" } } + }, + "description": "Update Peer response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-single_response-PJU34P3b" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Peer response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Peer", + "tags": ["Secondary DNS (Peer)"], + "x-cfPermissionsRequired": { "enum": ["#dns_records:edit", "#organization:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/secondary_dns/tsigs": { + "get": { + "description": "List TSIGs.", + "operationId": "secondary-dns-(-tsig)-list-tsi-gs", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-DCAPOmrB" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/response_collection-7voDH8b3" } } + }, + "description": "List TSIGs response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/response_collection-7voDH8b3" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List TSIGs response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List TSIGs", + "tags": ["Secondary DNS (TSIG)"], + "x-cfPermissionsRequired": { "enum": ["#dns_records:read", "#organization:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "post": { + "description": "Create TSIG.", + "operationId": "secondary-dns-(-tsig)-create-tsig", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-DCAPOmrB" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tsig" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response-X5UPXTbk" } } + }, + "description": "Create TSIG response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response-X5UPXTbk" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create TSIG response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create TSIG", + "tags": ["Secondary DNS (TSIG)"], + "x-cfPermissionsRequired": { "enum": ["#dns_records:edit", "#organization:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/secondary_dns/tsigs/{identifier}": { + "delete": { + "description": "Delete TSIG.", + "operationId": "secondary-dns-(-tsig)-delete-tsig", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier-03kXbNiE" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-DCAPOmrB" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-id_response" } } }, + "description": "Delete TSIG response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-id_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete TSIG response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete TSIG", + "tags": ["Secondary DNS (TSIG)"], + "x-cfPermissionsRequired": { "enum": ["#dns_records:edit", "#organization:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "get": { + "description": "Get TSIG.", + "operationId": "secondary-dns-(-tsig)-tsig-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier-03kXbNiE" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-DCAPOmrB" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response-X5UPXTbk" } } + }, + "description": "TSIG Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response-X5UPXTbk" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "TSIG Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "TSIG Details", + "tags": ["Secondary DNS (TSIG)"], + "x-cfPermissionsRequired": { "enum": ["#dns_records:read", "#organization:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "put": { + "description": "Modify TSIG.", + "operationId": "secondary-dns-(-tsig)-update-tsig", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier-03kXbNiE" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-DCAPOmrB" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tsig" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response-X5UPXTbk" } } + }, + "description": "Update TSIG response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response-X5UPXTbk" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update TSIG response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update TSIG", + "tags": ["Secondary DNS (TSIG)"], + "x-cfPermissionsRequired": { "enum": ["#dns_records:edit", "#organization:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{account_identifier}/storage/analytics": { + "get": { + "description": "Retrieves Workers KV request metrics for the given account.", + "operationId": "workers-kv-request-analytics-query-request-analytics", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "query", + "name": "query", + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/query-ju6G02HL" }, + { + "properties": { + "dimensions": { + "example": ["accountId", "responseCode"], + "items": { "enum": ["accountId", "responseCode", "requestType"] } + }, + "filters": { "example": "requestType==read AND responseCode!=200" }, + "metrics": { + "default": "[\"requests\"]", + "example": ["requests", "readKiB"], + "items": { "enum": ["requests", "writeKiB", "readKiB"] } + }, + "sort": { "example": ["+requests", "-responseCode"] } + } + } + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/schemas-result" } }, "type": "object" } + ] + } + } + }, + "description": "Query Request Analytics response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { "result": { "$ref": "#/components/schemas/result-iSgQlUWZ" } }, + "type": "object" + } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Query Request Analytics response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Query Request Analytics", + "tags": ["Workers KV Request Analytics"] + } + }, + "/accounts/{account_identifier}/storage/analytics/stored": { + "get": { + "description": "Retrieves Workers KV stored data metrics for the given account.", + "operationId": "workers-kv-stored-data-analytics-query-stored-data-analytics", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "query", + "name": "query", + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/query-ju6G02HL" }, + { + "properties": { + "dimensions": { "example": ["namespaceId"], "items": { "enum": ["namespaceId"] } }, + "filters": { "example": "namespaceId==a4e8cbb7-1b58-4990-925e-e026d40c4c64" }, + "metrics": { + "default": "[\"storedBytes\"]", + "example": ["storedBytes", "storedKeys"], + "items": { "enum": ["storedBytes", "storedKeys"] } + }, + "sort": { "example": ["+storedBytes", "-namespaceId"] } + } + } + ] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { "result": { "$ref": "#/components/schemas/components-schemas-result" } }, + "type": "object" + } + ] + } + } + }, + "description": "Query Stored Data Analytics response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { "result": { "$ref": "#/components/schemas/result-iSgQlUWZ" } }, + "type": "object" + } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Query Stored Data Analytics response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Query Stored Data Analytics", + "tags": ["Workers KV Stored Data Analytics"] + } + }, + "/accounts/{account_identifier}/storage/kv/namespaces": { + "get": { + "description": "Returns the namespaces owned by an account.", + "operationId": "workers-kv-namespace-list-namespaces", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "query", + "name": "page", + "schema": { + "default": 1, + "description": "Page number of paginated results.", + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { + "default": 20, + "description": "Maximum number of results per page.", + "maximum": 100, + "minimum": 5, + "type": "number" + } + }, + { + "in": "query", + "name": "order", + "schema": { "description": "Field to order results by.", "enum": ["id", "title"], "example": "id" } + }, + { + "in": "query", + "name": "direction", + "schema": { "description": "Direction to order namespaces.", "enum": ["asc", "desc"], "example": "asc" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/namespace" }, "type": "array" } + }, + "type": "object" + } + ] + } + } + }, + "description": "List Namespaces response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/namespace" }, "type": "array" } + }, + "type": "object" + } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Namespaces response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Namespaces", + "tags": ["Workers KV Namespace"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.storage.kv.namespace.list"] } + }, + "post": { + "description": "Creates a namespace under the given title. A 400 is returned if the account already owns a namespace with this title. A namespace must be explicitly deleted to be replaced.", + "operationId": "workers-kv-namespace-create-a-namespace", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/create_rename_namespace_body" } } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/namespace" } }, "type": "object" } + ] + } + } + }, + "description": "Create a Namespace response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/namespace" } }, "type": "object" } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create a Namespace response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create a Namespace", + "tags": ["Workers KV Namespace"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.storage.kv.namespace.create"] } + } + }, + "/accounts/{account_identifier}/storage/kv/namespaces/{namespace_identifier}": { + "delete": { + "description": "Deletes the namespace corresponding to the given ID.", + "operationId": "workers-kv-namespace-remove-a-namespace", + "parameters": [ + { + "in": "path", + "name": "namespace_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/namespace_identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single" } } }, + "description": "Remove a Namespace response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Remove a Namespace response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Remove a Namespace", + "tags": ["Workers KV Namespace"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.storage.kv.namespace.delete"] } + }, + "put": { + "description": "Modifies a namespace's title.", + "operationId": "workers-kv-namespace-rename-a-namespace", + "parameters": [ + { + "in": "path", + "name": "namespace_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/namespace_identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/create_rename_namespace_body" } } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single" } } }, + "description": "Rename a Namespace response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Rename a Namespace response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Rename a Namespace", + "tags": ["Workers KV Namespace"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.storage.kv.namespace.delete"] } + } + }, + "/accounts/{account_identifier}/storage/kv/namespaces/{namespace_identifier}/bulk": { + "delete": { + "description": "Remove multiple KV pairs from the Namespace. Body should be an array of up to 10,000 keys to be removed.", + "operationId": "workers-kv-namespace-delete-multiple-key-value-pairs", + "parameters": [ + { + "in": "path", + "name": "namespace_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/namespace_identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulk_delete" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single" } } }, + "description": "Delete multiple key-value pairs response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete multiple key-value pairs response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete multiple key-value pairs", + "tags": ["Workers KV Namespace"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.storage.kv.key.delete"] } + }, + "put": { + "description": "Write multiple keys and values at once. Body should be an array of up to 10,000 key-value pairs to be stored, along with optional expiration information. Existing values and expirations will be overwritten. If neither expiration nor expiration_ttl is specified, the key-value pair will never expire. If both are set, `expiration_ttl` is used and `expiration` is ignored. The entire request size must be 100 megabytes or less.", + "operationId": "workers-kv-namespace-write-multiple-key-value-pairs", + "parameters": [ + { + "in": "path", + "name": "namespace_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/namespace_identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bulk_write" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single" } } }, + "description": "Write multiple key-value pairs response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Write multiple key-value pairs response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Write multiple key-value pairs", + "tags": ["Workers KV Namespace"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.storage.kv.key.update"] } + } + }, + "/accounts/{account_identifier}/storage/kv/namespaces/{namespace_identifier}/keys": { + "get": { + "description": "Lists a namespace's keys.", + "operationId": "workers-kv-namespace-list-a-namespace'-s-keys", + "parameters": [ + { + "in": "path", + "name": "namespace_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/namespace_identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "query", + "name": "limit", + "schema": { + "default": 1000, + "description": "The number of keys to return. The cursor attribute may be used to iterate over the next batch of keys if there are more than the limit.", + "maximum": 1000, + "minimum": 10, + "type": "number" + } + }, + { + "in": "query", + "name": "prefix", + "schema": { + "description": "A string prefix used to filter down which keys will be returned. Exact matches and any key names that begin with the prefix will be returned.", + "example": "My-Prefix", + "type": "string" + } + }, + { + "in": "query", + "name": "cursor", + "schema": { + "description": "Opaque token indicating the position from which to continue when requesting the next set of records if the amount of list results was limited by the limit parameter. A valid value for the cursor can be obtained from the cursors object in the result_info structure.", + "example": "6Ck1la0VxJ0djhidm1MdX2FyDGxLKVeeHZZmORS_8XeSuhz9SjIJRaSa2lnsF01tQOHrfTGAP3R5X1Kv5iVUuMbNKhWNAXHOl6ePB0TUL8nw", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/key" }, "type": "array" }, + "result_info": { + "properties": { + "count": { + "description": "Total results returned based on your list parameters.", + "example": 1, + "type": "number" + }, + "cursor": { "$ref": "#/components/schemas/cursor" } + } + } + } + } + ] + } + } + }, + "description": "List a Namespace's Keys response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/key" }, "type": "array" }, + "result_info": { + "properties": { + "count": { + "description": "Total results returned based on your list parameters.", + "example": 1, + "type": "number" + }, + "cursor": { "$ref": "#/components/schemas/cursor" } + } + } + } + } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List a Namespace's Keys response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List a Namespace's Keys", + "tags": ["Workers KV Namespace"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.storage.kv.key.list"] } + } + }, + "/accounts/{account_identifier}/storage/kv/namespaces/{namespace_identifier}/metadata/{key_name}": { + "get": { + "description": "Returns the metadata associated with the given key in the given namespace. Use URL-encoding to use special characters (e.g. :, !, %) in the key name.", + "operationId": "workers-kv-namespace-read-the-metadata-for-a-key", + "parameters": [ + { "in": "path", "name": "key_name", "required": true, "schema": { "$ref": "#/components/schemas/key_name" } }, + { + "in": "path", + "name": "namespace_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/namespace_identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/list_metadata" } } } + ] + } + } + }, + "description": "Read the metadata for a key response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/list_metadata" } } } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Read the metadata for a key response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Read the metadata for a key", + "tags": ["Workers KV Namespace"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.storage.kv.key.read"] } + } + }, + "/accounts/{account_identifier}/storage/kv/namespaces/{namespace_identifier}/values/{key_name}": { + "delete": { + "description": "Remove a KV pair from the Namespace. Use URL-encoding to use special characters (e.g. :, !, %) in the key name.", + "operationId": "workers-kv-namespace-delete-key-value-pair", + "parameters": [ + { "in": "path", "name": "key_name", "required": true, "schema": { "$ref": "#/components/schemas/key_name" } }, + { + "in": "path", + "name": "namespace_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/namespace_identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single" } } }, + "description": "Delete key-value pair response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete key-value pair response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete key-value pair", + "tags": ["Workers KV Namespace"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.storage.kv.key.delete"] } + }, + "get": { + "description": "Returns the value associated with the given key in the given namespace. Use URL-encoding to use special characters (e.g. :, !, %) in the key name. If the KV-pair is set to expire at some point, the expiration time as measured in seconds since the UNIX epoch will be returned in the \"Expiration\" response header.", + "operationId": "workers-kv-namespace-read-key-value-pair", + "parameters": [ + { "in": "path", "name": "key_name", "required": true, "schema": { "$ref": "#/components/schemas/key_name" } }, + { + "in": "path", + "name": "namespace_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/namespace_identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/kv_components-schemas-value" } } + }, + "description": "Read key-value pair response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/kv_components-schemas-value" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Read key-value pair response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Read key-value pair", + "tags": ["Workers KV Namespace"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.storage.kv.key.read"] } + }, + "put": { + "description": "Write a value identified by a key. Use URL-encoding to use special characters (e.g. :, !, %) in the key name. Body should be the value to be stored along with json metadata to be associated with the key/value pair. Existing values, expirations and metadata will be overwritten. If neither `expiration` nor `expiration_ttl` is specified, the key-value pair will never expire. If both are set, `expiration_ttl` is used and `expiration` is ignored.", + "operationId": "workers-kv-namespace-write-key-value-pair-with-metadata", + "parameters": [ + { "in": "path", "name": "key_name", "required": true, "schema": { "$ref": "#/components/schemas/key_name" } }, + { + "in": "path", + "name": "namespace_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/namespace_identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "properties": { + "metadata": { "$ref": "#/components/schemas/components-schemas-metadata" }, + "value": { "$ref": "#/components/schemas/kv_components-schemas-value" } + }, + "required": ["value", "metadata"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single" } } }, + "description": "Write key-value pair with metadata response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Write key-value pair with metadata response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Write key-value pair with metadata", + "tags": ["Workers KV Namespace"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.storage.kv.key.update"] } + } + }, + "/accounts/{account_identifier}/stream": { + "get": { + "description": "Lists up to 1000 videos from a single request. For a specific range, refer to the optional parameters.", + "operationId": "stream-videos-list-videos", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-u0eFsPPd" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/video_response_collection" } } + }, + "description": "List videos response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "List videos response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List videos", + "tags": ["Stream Videos"] + }, + "post": { + "description": "Initiates a video upload using the TUS protocol. On success, the server responds with a status code 201 (created) and includes a `location` header to indicate where the content should be uploaded. Refer to https://tus.io for protocol details.", + "operationId": "stream-videos-initiate-video-uploads-using-tus", + "parameters": [ + { + "in": "header", + "name": "Tus-Resumable", + "required": true, + "schema": { "$ref": "#/components/schemas/tus_resumable" } + }, + { "in": "header", "name": "Upload-Creator", "schema": { "$ref": "#/components/schemas/creator" } }, + { + "in": "header", + "name": "Upload-Length", + "required": true, + "schema": { "$ref": "#/components/schemas/upload_length" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-u0eFsPPd" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { "content": { "application/json": {} }, "description": "Initiate video uploads using TUS response" }, + "4xx": { + "content": { "application/json": {} }, + "description": "Initiate video uploads using TUS response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Initiate video uploads using TUS", + "tags": ["Stream Videos"] + } + }, + "/accounts/{account_identifier}/stream/clip": { + "post": { + "description": "Clips a video based on the specified start and end times provided in seconds.", + "operationId": "stream-video-clipping-clip-videos-given-a-start-and-end-time", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-u0eFsPPd" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/videoClipStandard" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clipResponseSingle" } } }, + "description": "Clip videos given a start and end time response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "Clip videos given a start and end time response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Clip videos given a start and end time", + "tags": ["Stream Video Clipping"] + } + }, + "/accounts/{account_identifier}/stream/copy": { + "post": { + "description": "Uploads a video to Stream from a provided URL.", + "operationId": "stream-videos-upload-videos-from-a-url", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-u0eFsPPd" } + }, + { "in": "header", "name": "Upload-Creator", "schema": { "$ref": "#/components/schemas/creator" } } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video_copy_request" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video_response_single" } } }, + "description": "Upload videos from a URL response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "Upload videos from a URL response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Upload videos from a URL", + "tags": ["Stream Videos"] + } + }, + "/accounts/{account_identifier}/stream/direct_upload": { + "post": { + "description": "Creates a direct upload that allows video uploads without an API key.", + "operationId": "stream-videos-upload-videos-via-direct-upload-ur-ls", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-u0eFsPPd" } + }, + { "in": "header", "name": "Upload-Creator", "schema": { "$ref": "#/components/schemas/creator" } } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/direct_upload_request" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/direct_upload_response" } } }, + "description": "Upload videos via direct upload URLs response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "Upload videos via direct upload URLs response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Upload videos via direct upload URLs", + "tags": ["Stream Videos"] + } + }, + "/accounts/{account_identifier}/stream/keys": { + "get": { + "description": "Lists the video ID and creation date and time when a signing key was created.", + "operationId": "stream-signing-keys-list-signing-keys", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/key_response_collection-FpLR6Wht" } } + }, + "description": "List signing keys response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "List signing keys response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List signing keys", + "tags": ["Stream Signing Keys"] + }, + "post": { + "description": "Creates an RSA private key in PEM and JWK formats. Key files are only displayed once after creation. Keys are created, used, and deleted independently of videos, and every key can sign any video.", + "operationId": "stream-signing-keys-create-signing-keys", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/key_generation_response" } } }, + "description": "Create signing keys response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "Create signing keys response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create signing keys", + "tags": ["Stream Signing Keys"] + } + }, + "/accounts/{account_identifier}/stream/keys/{identifier}": { + "delete": { + "description": "Deletes signing keys and revokes all signed URLs generated with the key.", + "operationId": "stream-signing-keys-delete-signing-keys", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/deleted_response-7kko7sFR" } } + }, + "description": "Delete signing keys response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "Delete signing keys response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete signing keys", + "tags": ["Stream Signing Keys"] + } + }, + "/accounts/{account_identifier}/stream/live_inputs": { + "get": { + "description": "Lists the live inputs created for an account. To get the credentials needed to stream to a specific live input, request a single live input.", + "operationId": "stream-live-inputs-list-live-inputs", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/live_input_response_collection" } } + }, + "description": "List live inputs response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "List live inputs response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List live inputs", + "tags": ["Stream Live Inputs"] + }, + "post": { + "description": "Creates a live input, and returns credentials that you or your users can use to stream live video to Cloudflare Stream.", + "operationId": "stream-live-inputs-create-a-live-input", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_input_request" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/live_input_response_single" } } + }, + "description": "Create a live input response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "Create a live input response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create a live input", + "tags": ["Stream Live Inputs"] + } + }, + "/accounts/{account_identifier}/stream/live_inputs/{live_input_identifier}": { + "delete": { + "description": "Prevents a live input from being streamed to and makes the live input inaccessible to any future API calls.", + "operationId": "stream-live-inputs-delete-a-live-input", + "parameters": [ + { + "in": "path", + "name": "live_input_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/live_input_identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { "content": { "application/json": {} }, "description": "Delete a live input response" }, + "4xx": { "content": { "application/json": {} }, "description": "Delete a live input response failure" } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete a live input", + "tags": ["Stream Live Inputs"] + }, + "get": { + "description": "Retrieves details of an existing live input.", + "operationId": "stream-live-inputs-retrieve-a-live-input", + "parameters": [ + { + "in": "path", + "name": "live_input_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/live_input_identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/live_input_response_single" } } + }, + "description": "Retrieve a live input response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "Retrieve a live input response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Retrieve a live input", + "tags": ["Stream Live Inputs"] + }, + "put": { + "description": "Updates a specified live input.", + "operationId": "stream-live-inputs-update-a-live-input", + "parameters": [ + { + "in": "path", + "name": "live_input_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/live_input_identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_input_request" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/live_input_response_single" } } + }, + "description": "Update a live input response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "Update a live input response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update a live input", + "tags": ["Stream Live Inputs"] + } + }, + "/accounts/{account_identifier}/stream/live_inputs/{live_input_identifier}/outputs": { + "get": { + "description": "Retrieves all outputs associated with a specified live input.", + "operationId": "stream-live-inputs-list-all-outputs-associated-with-a-specified-live-input", + "parameters": [ + { + "in": "path", + "name": "live_input_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/live_input_identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/output_response_collection" } } + }, + "description": "List all outputs associated with a specified live input response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "List all outputs associated with a specified live input response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List all outputs associated with a specified live input", + "tags": ["Stream Live Inputs"] + }, + "post": { + "description": "Creates a new output that can be used to simulcast or restream live video to other RTMP or SRT destinations. Outputs are always linked to a specific live input — one live input can have many outputs.", + "operationId": "stream-live-inputs-create-a-new-output,-connected-to-a-live-input", + "parameters": [ + { + "in": "path", + "name": "live_input_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/live_input_identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_output_request" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/output_response_single" } } }, + "description": "Create a new output, connected to a live input response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "Create a new output, connected to a live input response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create a new output, connected to a live input", + "tags": ["Stream Live Inputs"] + } + }, + "/accounts/{account_identifier}/stream/live_inputs/{live_input_identifier}/outputs/{output_identifier}": { + "delete": { + "description": "Deletes an output and removes it from the associated live input.", + "operationId": "stream-live-inputs-delete-an-output", + "parameters": [ + { + "in": "path", + "name": "output_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/output_identifier" } + }, + { + "in": "path", + "name": "live_input_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/live_input_identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { "content": { "application/json": {} }, "description": "Delete an output response" }, + "4xx": { "content": { "application/json": {} }, "description": "Delete an output response failure" } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete an output", + "tags": ["Stream Live Inputs"] + }, + "put": { + "description": "Updates the state of an output.", + "operationId": "stream-live-inputs-update-an-output", + "parameters": [ + { + "in": "path", + "name": "output_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/output_identifier" } + }, + { + "in": "path", + "name": "live_input_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/live_input_identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_output_request" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/output_response_single" } } }, + "description": "Update an output response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "Update an output response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update an output", + "tags": ["Stream Live Inputs"] + } + }, + "/accounts/{account_identifier}/stream/watermarks": { + "get": { + "description": "Lists all watermark profiles for an account.", + "operationId": "stream-watermark-profile-list-watermark-profiles", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-u0eFsPPd" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/watermark_response_collection" } } + }, + "description": "List watermark profiles response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "List watermark profiles response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List watermark profiles", + "tags": ["Stream Watermark Profile"] + }, + "post": { + "description": "Creates watermark profiles using a single `HTTP POST multipart/form-data` request.", + "operationId": "stream-watermark-profile-create-watermark-profiles-via-basic-upload", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-u0eFsPPd" } + } + ], + "requestBody": { + "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/watermark_basic_upload" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/watermark_response_single" } } + }, + "description": "Create watermark profiles via basic upload response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "Create watermark profiles via basic upload response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create watermark profiles via basic upload", + "tags": ["Stream Watermark Profile"] + } + }, + "/accounts/{account_identifier}/stream/watermarks/{identifier}": { + "delete": { + "description": "Deletes a watermark profile.", + "operationId": "stream-watermark-profile-delete-watermark-profiles", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/watermark_identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-u0eFsPPd" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "example": "", "type": "string" } } } + ] + } + } + }, + "description": "Delete watermark profiles response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "Delete watermark profiles response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete watermark profiles", + "tags": ["Stream Watermark Profile"] + }, + "get": { + "description": "Retrieves details for a single watermark profile.", + "operationId": "stream-watermark-profile-watermark-profile-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/watermark_identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-u0eFsPPd" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/watermark_response_single" } } + }, + "description": "Watermark profile details response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "Watermark profile details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Watermark profile details", + "tags": ["Stream Watermark Profile"] + } + }, + "/accounts/{account_identifier}/stream/webhook": { + "delete": { + "description": "Deletes a webhook.", + "operationId": "stream-webhook-delete-webhooks", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-u0eFsPPd" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/deleted_response-7kko7sFR" } } + }, + "description": "Delete webhooks response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "Delete webhooks response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete webhooks", + "tags": ["Stream Webhook"] + }, + "get": { + "description": "Retrieves a list of webhooks.", + "operationId": "stream-webhook-view-webhooks", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-u0eFsPPd" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_response_single" } } }, + "description": "View webhooks response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "View webhooks response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "View webhooks", + "tags": ["Stream Webhook"] + }, + "put": { + "description": "Creates a webhook notification.", + "operationId": "stream-webhook-create-webhooks", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-u0eFsPPd" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_request" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_response_single" } } }, + "description": "Create webhooks response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "Create webhooks response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create webhooks", + "tags": ["Stream Webhook"] + } + }, + "/accounts/{account_identifier}/stream/{identifier}": { + "delete": { + "description": "Deletes a video and its copies from Cloudflare Stream.", + "operationId": "stream-videos-delete-video", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-XSj9HnWY" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-u0eFsPPd" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { "content": { "application/json": {} }, "description": "Delete video response" }, + "4xx": { "content": { "application/json": {} }, "description": "Delete video response failure" } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete video", + "tags": ["Stream Videos"] + }, + "get": { + "description": "Fetches details for a single video.", + "operationId": "stream-videos-retrieve-video-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-XSj9HnWY" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-u0eFsPPd" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video_response_single" } } }, + "description": "Retrieve video details response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "Retrieve video details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Retrieve video details", + "tags": ["Stream Videos"] + }, + "post": { + "description": "Update details for a single video.", + "operationId": "stream-videos-update-video-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-XSj9HnWY" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-u0eFsPPd" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video_update" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/video_response_single" } } }, + "description": "Update video details response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "Update video details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update video details", + "tags": ["Stream Videos"] + } + }, + "/accounts/{account_identifier}/stream/{identifier}/captions": { + "get": { + "description": "Lists the available captions or subtitles for a specific video.", + "operationId": "stream-subtitles/-captions-list-captions-or-subtitles", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-XSj9HnWY" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/language_response_collection" } } + }, + "description": "List captions or subtitles response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "List captions or subtitles response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List captions or subtitles", + "tags": ["Stream Subtitles/Captions"] + } + }, + "/accounts/{account_identifier}/stream/{identifier}/captions/{language}": { + "delete": { + "description": "Removes the captions or subtitles from a video.", + "operationId": "stream-subtitles/-captions-delete-captions-or-subtitles", + "parameters": [ + { "in": "path", "name": "language", "required": true, "schema": { "$ref": "#/components/schemas/language" } }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-XSj9HnWY" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "result": { "example": "", "type": "string" } } } + ] + } + } + }, + "description": "Delete captions or subtitles response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "Delete captions or subtitles response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete captions or subtitles", + "tags": ["Stream Subtitles/Captions"] + }, + "put": { + "description": "Uploads the caption or subtitle file to the endpoint for a specific BCP47 language. One caption or subtitle file per language is allowed.", + "operationId": "stream-subtitles/-captions-upload-captions-or-subtitles", + "parameters": [ + { "in": "path", "name": "language", "required": true, "schema": { "$ref": "#/components/schemas/language" } }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-XSj9HnWY" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { + "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/caption_basic_upload" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/language_response_single" } } + }, + "description": "Upload captions or subtitles response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "Upload captions or subtitles response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Upload captions or subtitles", + "tags": ["Stream Subtitles/Captions"] + } + }, + "/accounts/{account_identifier}/stream/{identifier}/downloads": { + "delete": { + "description": "Delete the downloads for a video.", + "operationId": "stream-m-p-4-downloads-delete-downloads", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-XSj9HnWY" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/deleted_response-7kko7sFR" } } + }, + "description": "Delete downloads response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "Delete downloads response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete downloads", + "tags": ["Stream MP4 Downloads"] + }, + "get": { + "description": "Lists the downloads created for a video.", + "operationId": "stream-m-p-4-downloads-list-downloads", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-XSj9HnWY" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/downloads_response" } } }, + "description": "List downloads response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "List downloads response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List downloads", + "tags": ["Stream MP4 Downloads"] + }, + "post": { + "description": "Creates a download for a video when a video is ready to view.", + "operationId": "stream-m-p-4-downloads-create-downloads", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-XSj9HnWY" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/downloads_response" } } }, + "description": "Create downloads response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "Create downloads response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create downloads", + "tags": ["Stream MP4 Downloads"] + } + }, + "/accounts/{account_identifier}/stream/{identifier}/embed": { + "get": { + "description": "Fetches an HTML code snippet to embed a video in a web page delivered through Cloudflare. On success, returns an HTML fragment for use on web pages to display a video. On failure, returns a JSON response body.", + "operationId": "stream-videos-retreieve-embed-code-html", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-XSj9HnWY" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-u0eFsPPd" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "example": "\u003cstream id=\"ea95132c15732412d22c1476fa83f27a\"\u003e\u003c/stream\u003e\u003cscript data-cfasync=\"false\" defer type=\"text/javascript\" src=\"https://embed.cloudflarestream.com/embed/we4g.fla9.latest.js\"\u003e\u003c/script\u003e" + } + } + }, + "description": "Retreieve embed Code HTML response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "Retreieve embed Code HTML response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Retreieve embed Code HTML", + "tags": ["Stream Videos"] + } + }, + "/accounts/{account_identifier}/stream/{identifier}/token": { + "post": { + "description": "Creates a signed URL token for a video. If a body is not provided in the request, a token is created with default values.", + "operationId": "stream-videos-create-signed-url-tokens-for-videos", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-XSj9HnWY" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/account_identifier-u0eFsPPd" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/signed_token_request" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/signed_token_response" } } }, + "description": "Create signed URL tokens for videos response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "Create signed URL tokens for videos response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create signed URL tokens for videos", + "tags": ["Stream Videos"] + } + }, + "/accounts/{account_identifier}/subscriptions": { + "get": { + "description": "Lists all of an account's subscriptions.", + "operationId": "account-subscriptions-list-subscriptions", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/account_subscription_response_collection" } + } + }, + "description": "List Subscriptions response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/account_subscription_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Subscriptions response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Subscriptions", + "tags": ["Account Subscriptions"], + "x-cfPermissionsRequired": { "enum": ["#billing:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "post": { + "description": "Creates an account subscription.", + "operationId": "account-subscriptions-create-subscription", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription-v2" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/account_subscription_response_single" } } + }, + "description": "Create Subscription response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/account_subscription_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Subscription response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Subscription", + "tags": ["Account Subscriptions"], + "x-cfPermissionsRequired": { "enum": ["#billing:read", "#billing:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/accounts/{account_identifier}/subscriptions/{subscription_identifier}": { + "delete": { + "description": "Deletes an account's subscription.", + "operationId": "account-subscriptions-delete-subscription", + "parameters": [ + { + "in": "path", + "name": "subscription_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/subscription-v2_components-schemas-identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "subscription_id": { + "$ref": "#/components/schemas/subscription-v2_components-schemas-identifier" + } + }, + "type": "object" + } + } + } + ] + } + } + }, + "description": "Delete Subscription response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "subscription_id": { + "$ref": "#/components/schemas/subscription-v2_components-schemas-identifier" + } + }, + "type": "object" + } + } + } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Subscription response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Subscription", + "tags": ["Account Subscriptions"], + "x-cfPermissionsRequired": { "enum": ["#billing:edit"] } + }, + "put": { + "description": "Updates an account subscription.", + "operationId": "account-subscriptions-update-subscription", + "parameters": [ + { + "in": "path", + "name": "subscription_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/subscription-v2_components-schemas-identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription-v2" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/account_subscription_response_single" } } + }, + "description": "Update Subscription response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/account_subscription_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Subscription response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Subscription", + "tags": ["Account Subscriptions"], + "x-cfPermissionsRequired": { "enum": ["#billing:read", "#billing:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/accounts/{account_identifier}/teamnet/routes": { + "get": { + "description": "Lists and filters private network routes in an account.", + "operationId": "tunnel-route-list-tunnel-routes", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/cf_account_id" } + }, + { "in": "query", "name": "comment", "schema": { "$ref": "#/components/schemas/comment-ZBQ7qz21" } }, + { + "in": "query", + "name": "is_deleted", + "schema": { + "description": "If `true`, only include deleted routes. If `false`, exclude deleted routes. If empty, all routes will be included." + } + }, + { + "in": "query", + "name": "network_subset", + "schema": { "description": "If set, only list routes that are contained within this IP range." } + }, + { + "in": "query", + "name": "network_superset", + "schema": { "description": "If set, only list routes that contain this IP range." } + }, + { + "in": "query", + "name": "existed_at", + "schema": { + "description": "If provided, include only routes that were created (and not deleted) before this time." + } + }, + { "in": "query", "name": "per_page", "schema": { "$ref": "#/components/schemas/schemas-per_page" } }, + { + "in": "query", + "name": "tunnel_id", + "schema": { "description": "UUID of the Cloudflare Tunnel serving the route." } + }, + { + "in": "query", + "name": "page", + "schema": { + "default": 1, + "description": "Page number of paginated results.", + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "virtual_network_id", + "schema": { + "description": "UUID of the Tunnel Virtual Network this route belongs to. If no virtual networks are configured, the route is assigned to the default virtual network of the account." + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/route_response_collection" } } + }, + "description": "List tunnel routes response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/route_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List tunnel routes response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List tunnel routes", + "tags": ["Tunnel route"] + } + }, + "/accounts/{account_identifier}/teamnet/routes/ip/{ip}": { + "get": { + "description": "Fetches routes that contain the given IP address.", + "operationId": "tunnel-route-get-tunnel-route-by-ip", + "parameters": [ + { + "in": "path", + "name": "ip", + "required": true, + "schema": { "$ref": "#/components/schemas/teamnet_components-schemas-ip" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/cf_account_id" } + }, + { + "in": "query", + "name": "virtual_network_id", + "schema": { + "description": "UUID of the Tunnel Virtual Network this route belongs to. If no virtual networks are configured, the route is assigned to the default virtual network of the account." + } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/route_response_single" } } }, + "description": "Get tunnel route by IP response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/route_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get tunnel route by IP response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get tunnel route by IP", + "tags": ["Tunnel route"] + } + }, + "/accounts/{account_identifier}/teamnet/routes/network/{ip_network_encoded}": { + "delete": { + "description": "Deletes a private network route from an account. The CIDR in `ip_network_encoded` must be written in URL-encoded format.", + "operationId": "tunnel-route-delete-a-tunnel-route", + "parameters": [ + { + "in": "path", + "name": "ip_network_encoded", + "required": true, + "schema": { "$ref": "#/components/schemas/ip_network_encoded" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/cf_account_id" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "virtual_network_id": { "$ref": "#/components/schemas/schemas-virtual_network_id" } }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/route_response_single" } } }, + "description": "Delete a tunnel route response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/route_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete a tunnel route response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete a tunnel route", + "tags": ["Tunnel route"] + }, + "patch": { + "description": "Updates an existing private network route in an account. The CIDR in `ip_network_encoded` must be written in URL-encoded format.", + "operationId": "tunnel-route-update-a-tunnel-route", + "parameters": [ + { + "in": "path", + "name": "ip_network_encoded", + "required": true, + "schema": { "$ref": "#/components/schemas/ip_network_encoded" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/cf_account_id" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "comment": { "$ref": "#/components/schemas/comment-ZBQ7qz21" }, + "network": { "description": "The new IPv4 or IPv6 range of this route, in CIDR notation." }, + "tunnel_id": { "description": "UUID of the tunnel this route should belong to." }, + "virtual_network_id": { "$ref": "#/components/schemas/schemas-virtual_network_id" } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/route_response_single" } } }, + "description": "Update a tunnel route response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/route_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update a tunnel route response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update a tunnel route", + "tags": ["Tunnel route"] + }, + "post": { + "description": "Routes a private network through a Cloudflare Tunnel. The CIDR in `ip_network_encoded` must be written in URL-encoded format.", + "operationId": "tunnel-route-create-a-tunnel-route", + "parameters": [ + { + "in": "path", + "name": "ip_network_encoded", + "required": true, + "schema": { "$ref": "#/components/schemas/ip_network_encoded" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/cf_account_id" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "comment": { "$ref": "#/components/schemas/comment-ZBQ7qz21" }, + "tunnel_id": { "$ref": "#/components/schemas/tunnel_id" }, + "virtual_network_id": { "$ref": "#/components/schemas/schemas-virtual_network_id" } + }, + "required": ["tunnel_id"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/route_response_single" } } }, + "description": "Create a tunnel route response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/route_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create a tunnel route response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create a tunnel route", + "tags": ["Tunnel route"] + } + }, + "/accounts/{account_identifier}/teamnet/virtual_networks": { + "get": { + "description": "Lists and filters virtual networks in an account.", + "operationId": "tunnel-virtual-network-list-virtual-networks", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/cf_account_id" } + }, + { "in": "query", "name": "name", "schema": { "$ref": "#/components/schemas/vnet_name" } }, + { + "in": "query", + "name": "is_default", + "schema": { + "description": "If `true`, only include the default virtual network. If `false`, exclude the default virtual network. If empty, all virtual networks will be included." + } + }, + { + "in": "query", + "name": "is_deleted", + "schema": { + "description": "If `true`, only include deleted virtual networks. If `false`, exclude deleted virtual networks. If empty, all virtual networks will be included." + } + }, + { "in": "query", "name": "vnet_name", "schema": { "$ref": "#/components/schemas/vnet_name" } }, + { + "in": "query", + "name": "vnet_id", + "schema": { + "description": "UUID of the virtual network.", + "example": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415", + "maxLength": 36, + "readOnly": true, + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/vnet_response_collection" } } + }, + "description": "List virtual networks response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/vnet_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List virtual networks response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List virtual networks", + "tags": ["Tunnel Virtual Network"] + }, + "post": { + "description": "Adds a new virtual network to an account.", + "operationId": "tunnel-virtual-network-create-a-virtual-network", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/cf_account_id" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "comment": { "$ref": "#/components/schemas/schemas-comment" }, + "is_default": { "$ref": "#/components/schemas/is_default_network" }, + "name": { "$ref": "#/components/schemas/vnet_name" } + }, + "required": ["name"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnet_response_single" } } }, + "description": "Create a virtual network response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/vnet_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create a virtual network response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create a virtual network", + "tags": ["Tunnel Virtual Network"] + } + }, + "/accounts/{account_identifier}/teamnet/virtual_networks/{vnet_id}": { + "delete": { + "description": "Deletes an existing virtual network.", + "operationId": "tunnel-virtual-network-delete-a-virtual-network", + "parameters": [ + { "in": "path", "name": "vnet_id", "required": true, "schema": { "$ref": "#/components/schemas/vnet_id" } }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/cf_account_id" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnet_response_single" } } }, + "description": "Delete a virtual network response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/vnet_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete a virtual network response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete a virtual network", + "tags": ["Tunnel Virtual Network"] + }, + "patch": { + "description": "Updates an existing virtual network.", + "operationId": "tunnel-virtual-network-update-a-virtual-network", + "parameters": [ + { "in": "path", "name": "vnet_id", "required": true, "schema": { "$ref": "#/components/schemas/vnet_id" } }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/cf_account_id" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "comment": { "$ref": "#/components/schemas/schemas-comment" }, + "is_default_network": { "$ref": "#/components/schemas/is_default_network" }, + "name": { "$ref": "#/components/schemas/vnet_name" } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vnet_response_single" } } }, + "description": "Update a virtual network response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/vnet_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update a virtual network response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update a virtual network", + "tags": ["Tunnel Virtual Network"] + } + }, + "/accounts/{account_identifier}/tunnels": { + "get": { + "deprecated": true, + "description": "Lists and filters Argo Tunnels in an account.", + "operationId": "argo-tunnel-list-argo-tunnels", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/cf_account_id" } + }, + { "in": "query", "name": "uuid", "schema": { "$ref": "#/components/schemas/tunnel_id" } }, + { "in": "query", "name": "existed_at", "schema": { "$ref": "#/components/schemas/existed_at" } }, + { "in": "query", "name": "tunnel_id", "schema": { "$ref": "#/components/schemas/tunnel_id" } }, + { + "in": "query", + "name": "is_deleted", + "schema": { + "description": "If `true`, only include deleted tunnels. If `false`, exclude deleted tunnels. If empty, all tunnels will be included.", + "example": true, + "type": "boolean" + } + }, + { + "in": "query", + "name": "tunnel_name", + "schema": { "description": "A user-friendly name for the tunnel.", "example": "blog", "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/tunnel_response_collection" } } + }, + "description": "List Argo Tunnels response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/tunnel_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Argo Tunnels response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Argo Tunnels", + "tags": ["Argo Tunnel"], + "x-cfDeprecation": { + "description": "This endpoint and its related APIs are deprecated in favor of the equivalent Cloudflare Tunnel APIs.", + "display": true, + "eol": "2024-02-04", + "id": "argo_tunnel_deprecation" + } + }, + "post": { + "deprecated": true, + "description": "Creates a new Argo Tunnel in an account.", + "operationId": "argo-tunnel-create-an-argo-tunnel", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/cf_account_id" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "name": { "$ref": "#/components/schemas/tunnel_name" }, + "tunnel_secret": { + "description": "Sets the password required to run the tunnel. Must be at least 32 bytes and encoded as a base64 string." + } + }, + "required": ["name", "tunnel_secret"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tunnel_response_single" } } }, + "description": "Create an Argo Tunnel response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/tunnel_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create an Argo Tunnel response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create an Argo Tunnel", + "tags": ["Argo Tunnel"], + "x-cfDeprecation": { + "description": "This endpoint and its related APIs are deprecated in favor of the equivalent Cloudflare Tunnel APIs.", + "display": true, + "eol": "2024-02-04", + "id": "argo_tunnel_deprecation" + } + } + }, + "/accounts/{account_identifier}/tunnels/{tunnel_id}": { + "delete": { + "deprecated": true, + "description": "Deletes an Argo Tunnel from an account.", + "operationId": "argo-tunnel-delete-an-argo-tunnel", + "parameters": [ + { + "in": "path", + "name": "tunnel_id", + "required": true, + "schema": { "$ref": "#/components/schemas/tunnel_id" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/cf_account_id" } + } + ], + "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tunnel_response_single" } } }, + "description": "Delete an Argo Tunnel response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/tunnel_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete an Argo Tunnel response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete an Argo Tunnel", + "tags": ["Argo Tunnel"], + "x-cfDeprecation": { + "description": "This endpoint and its related APIs are deprecated in favor of the equivalent Cloudflare Tunnel APIs.", + "display": true, + "eol": "2024-02-04", + "id": "argo_tunnel_deprecation" + } + }, + "get": { + "deprecated": true, + "description": "Fetches a single Argo Tunnel.", + "operationId": "argo-tunnel-get-an-argo-tunnel", + "parameters": [ + { + "in": "path", + "name": "tunnel_id", + "required": true, + "schema": { "$ref": "#/components/schemas/tunnel_id" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/cf_account_id" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tunnel_response_single" } } }, + "description": "Get an Argo Tunnel response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/tunnel_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get an Argo Tunnel response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get an Argo Tunnel", + "tags": ["Argo Tunnel"], + "x-cfDeprecation": { + "description": "This endpoint and its related APIs are deprecated in favor of the equivalent Cloudflare Tunnel APIs.", + "display": true, + "eol": "2024-02-04", + "id": "argo_tunnel_deprecation" + } + } + }, + "/accounts/{account_identifier}/tunnels/{tunnel_id}/connections": { + "delete": { + "deprecated": true, + "description": "Removes connections that are in a disconnected or pending reconnect state. We recommend running this command after shutting down a tunnel.", + "operationId": "argo-tunnel-clean-up-argo-tunnel-connections", + "parameters": [ + { + "in": "path", + "name": "tunnel_id", + "required": true, + "schema": { "$ref": "#/components/schemas/tunnel_id" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/cf_account_id" } + } + ], + "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/components-schemas-empty_response" } } + }, + "description": "Clean up Argo Tunnel connections response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-empty_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Clean up Argo Tunnel connections response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Clean up Argo Tunnel connections", + "tags": ["Argo Tunnel"], + "x-cfDeprecation": { + "description": "This endpoint and its related APIs are deprecated in favor of the equivalent Cloudflare Tunnel APIs.", + "display": true, + "eol": "2024-02-04", + "id": "argo_tunnel_deprecation" + } + } + }, + "/accounts/{account_identifier}/workers/account-settings": { + "get": { + "description": "Fetches Worker Account Settings for an account.", + "operationId": "worker-account-settings-fetch-worker-account-settings", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/account-settings-response" } } + }, + "description": "Fetch Worker Account Settings response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/account-settings-response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Fetch Worker Account Settings response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Fetch Worker Account Settings", + "tags": ["Worker Account Settings"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.read"] } + }, + "put": { + "description": "Creates Worker Account Settings for an account.", + "operationId": "worker-account-settings-create-worker-account-settings", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "example": "{'default_usage_model': 'unbound'}" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/account-settings-response" } } + }, + "description": "Create Worker Account Settings response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/account-settings-response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Worker Account Settings response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Worker Account Settings", + "tags": ["Worker Account Settings"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.update"] } + } + }, + "/accounts/{account_identifier}/workers/deployments/by-script/{script_identifier}": { + "get": { + "operationId": "worker-deployments-list-deployments", + "parameters": [ + { + "in": "path", + "name": "script_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/script_identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/deployments-list-response" } } + }, + "description": "List Deployments response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/deployments-list-response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Deployments response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Deployments", + "tags": ["Worker Deployments"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.deployment.list"] } + } + }, + "/accounts/{account_identifier}/workers/deployments/by-script/{script_identifier}/detail/{deployment_identifier}": { + "get": { + "operationId": "worker-deployments-get-deployment-detail", + "parameters": [ + { + "in": "path", + "name": "deployment_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/deployment_identifier" } + }, + { + "in": "path", + "name": "script_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/script_identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/deployments-single-response" } } + }, + "description": "Get Deployment Detail response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/deployments-single-response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Deployment Detail response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Deployment Detail", + "tags": ["Worker Deployments"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.deployment.read"] } + } + }, + "/accounts/{account_identifier}/workers/domains": { + "get": { + "description": "Lists all Worker Domains.", + "operationId": "worker-domain-list-domains", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-account_identifier" } + }, + { "in": "query", "name": "zone_name", "schema": { "$ref": "#/components/schemas/zone_name" } }, + { "in": "query", "name": "service", "schema": { "$ref": "#/components/schemas/schemas-service" } }, + { "in": "query", "name": "zone_identifier", "schema": { "$ref": "#/components/schemas/zone_identifier" } }, + { + "in": "query", + "name": "hostname", + "schema": { + "description": "Hostname of the Worker Domain.", + "example": "foo.example.com", + "type": "string" + } + }, + { + "in": "query", + "name": "environment", + "schema": { + "description": "Worker environment associated with the zone and hostname.", + "example": "production", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/domain-response-collection-7KXX2Ghb" } } + }, + "description": "List Domains response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/domain-response-collection-7KXX2Ghb" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Domains response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Domains", + "tags": ["Worker Domain"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.domain.list"] } + }, + "put": { + "description": "Attaches a worker to a zone and hostname.", + "operationId": "worker-domain-attach-to-domain", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-account_identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "environment": { "$ref": "#/components/schemas/environment" }, + "hostname": { "$ref": "#/components/schemas/components-schemas-hostname" }, + "service": { "$ref": "#/components/schemas/schemas-service" }, + "zone_id": { "$ref": "#/components/schemas/zone_identifier" } + }, + "required": ["zone_id", "hostname", "service", "environment"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/domain-response-single-0j5uvVNJ" } } + }, + "description": "Attach to Domain response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/domain-response-single-0j5uvVNJ" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Attach to Domain response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Attach to Domain", + "tags": ["Worker Domain"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.domain.update"] } + } + }, + "/accounts/{account_identifier}/workers/domains/{domain_identifier}": { + "delete": { + "description": "Detaches a worker from a zone and hostname.", + "operationId": "worker-domain-detach-from-domain", + "parameters": [ + { + "in": "path", + "name": "domain_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/domain_identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-account_identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { "content": { "application/json": {} }, "description": "Detach from Domain response" }, + "4xx": { "content": { "application/json": {} }, "description": "Detach from Domain response failure" } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Detach from Domain", + "tags": ["Worker Domain"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.domain.delete"] } + }, + "get": { + "description": "Gets a Worker Domain.", + "operationId": "worker-domain-get-a-domain", + "parameters": [ + { + "in": "path", + "name": "domain_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/domain_identifier" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-account_identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/domain-response-single-0j5uvVNJ" } } + }, + "description": "Get a Domain response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/domain-response-single-0j5uvVNJ" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get a Domain response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a Domain", + "tags": ["Worker Domain"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.domain.read"] } + } + }, + "/accounts/{account_identifier}/workers/durable_objects/namespaces": { + "get": { + "description": "Returns the namespaces owned by an account.", + "operationId": "durable-objects-namespace-list-namespaces", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/schemas-namespace" }, "type": "array" } + }, + "type": "object" + } + ] + } + } + }, + "description": "List Namespaces response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/schemas-namespace" }, "type": "array" } + }, + "type": "object" + } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Namespaces response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Namespaces", + "tags": ["Durable Objects Namespace"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.durable-object.class.list"] } + } + }, + "/accounts/{account_identifier}/workers/durable_objects/namespaces/{id}/objects": { + "get": { + "description": "Returns the Durable Objects in a given namespace.", + "operationId": "durable-objects-namespace-list-objects", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-id" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "query", + "name": "limit", + "schema": { + "default": 1000, + "description": "The number of objects to return. The cursor attribute may be used to iterate over the next batch of objects if there are more than the limit.", + "maximum": 10000, + "minimum": 10, + "type": "number" + } + }, + { + "in": "query", + "name": "cursor", + "schema": { + "description": "Opaque token indicating the position from which to continue when requesting the next set of records. A valid value for the cursor can be obtained from the cursors object in the result_info structure.", + "example": "AAAAANuhDN7SjacTnSVsDu3WW1Lvst6dxJGTjRY5BhxPXdf6L6uTcpd_NVtjhn11OUYRsVEykxoUwF-JQU4dn6QylZSKTOJuG0indrdn_MlHpMRtsxgXjs-RPdHYIVm3odE_uvEQ_dTQGFm8oikZMohns34DLBgrQpc", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/object" }, "type": "array" }, + "result_info": { + "properties": { + "count": { + "description": "Total results returned based on your list parameters.", + "example": 1, + "type": "number" + }, + "cursor": { "$ref": "#/components/schemas/schemas-cursor" } + } + } + }, + "type": "object" + } + ] + } + } + }, + "description": "List Objects response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/object" }, "type": "array" }, + "result_info": { + "properties": { + "count": { + "description": "Total results returned based on your list parameters.", + "example": 1, + "type": "number" + }, + "cursor": { "$ref": "#/components/schemas/schemas-cursor" } + } + } + }, + "type": "object" + } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Objects response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Objects", + "tags": ["Durable Objects Namespace"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.durable-object.class.read"] } + } + }, + "/accounts/{account_identifier}/workers/queues": { + "get": { + "description": "Returns the queues owned by an account.", + "operationId": "queue-list-queues", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "errors": { "nullable": true } } }, + { "properties": { "messages": { "nullable": true } } }, + { + "properties": { + "result_info": { + "properties": { + "count": { "example": 1 }, + "page": { "example": 1 }, + "per_page": { "example": 100 }, + "total_count": { "example": 1 }, + "total_pages": { "example": 1 } + }, + "type": "object" + } + } + }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/queue" }, "type": "array" } + }, + "required": [ + "queue_id", + "queue_name", + "created_on", + "modified_on", + "producers_total_count", + "producers", + "consumers_total_count", + "consumers" + ], + "type": "object" + } + ] + } + } + }, + "description": "List Queues response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "errors": { "nullable": true } } }, + { "properties": { "messages": { "nullable": true } } }, + { + "properties": { + "result_info": { + "properties": { + "count": { "example": 1 }, + "page": { "example": 1 }, + "per_page": { "example": 100 }, + "total_count": { "example": 1 }, + "total_pages": { "example": 1 } + }, + "type": "object" + } + } + }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/queue" }, "type": "array" } + }, + "required": [ + "queue_id", + "queue_name", + "created_on", + "modified_on", + "producers_total_count", + "producers", + "consumers_total_count", + "consumers" + ], + "type": "object" + } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Queues response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Queues", + "tags": ["Queue"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.queue.list"] } + }, + "post": { + "description": "Creates a new queue.", + "operationId": "queue-create-queue", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "example": { "queue_name": "example-queue" } } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "allOf": [{ "$ref": "#/components/schemas/queue_created" }], "type": "object" } + }, + "required": ["queue_id", "queue_name", "created_on", "modified_on"], + "type": "object" + } + ] + } + } + }, + "description": "Create Queue response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "allOf": [{ "$ref": "#/components/schemas/queue_created" }], "type": "object" } + }, + "required": ["queue_id", "queue_name", "created_on", "modified_on"], + "type": "object" + } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Queue response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Queue", + "tags": ["Queue"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.queue.create"] } + } + }, + "/accounts/{account_identifier}/workers/queues/{name}": { + "delete": { + "description": "Deletes a queue.", + "operationId": "queue-delete-queue", + "parameters": [ + { + "in": "path", + "name": "name", + "required": true, + "schema": { "$ref": "#/components/schemas/queues_components-schemas-name" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "nullable": true, "properties": { "result": { "nullable": true } } } + ] + } + } + }, + "description": "Delete Queue response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "nullable": true, "properties": { "result": { "nullable": true } } } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Queue response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Queue", + "tags": ["Queue"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.queue.delete"] } + }, + "get": { + "description": "Get information about a specific queue.", + "operationId": "queue-queue-details", + "parameters": [ + { + "in": "path", + "name": "name", + "required": true, + "schema": { "$ref": "#/components/schemas/queues_components-schemas-name" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "allOf": [{ "$ref": "#/components/schemas/queue" }], "type": "object" } + }, + "required": ["queue_id", "queue_name", "created_on", "modified_on"], + "type": "object" + } + ] + } + } + }, + "description": "Queue Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "allOf": [{ "$ref": "#/components/schemas/queue" }], "type": "object" } + }, + "required": ["queue_id", "queue_name", "created_on", "modified_on"], + "type": "object" + } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Queue Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Queue Details", + "tags": ["Queue"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.queue.read"] } + }, + "put": { + "description": "Updates a queue.", + "operationId": "queue-update-queue", + "parameters": [ + { + "in": "path", + "name": "name", + "required": true, + "schema": { "$ref": "#/components/schemas/queues_components-schemas-name" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "example": { "queue_name": "renamed-example-queue" } } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "allOf": [{ "$ref": "#/components/schemas/queue_updated" }], "type": "object" } + }, + "required": ["queue_id", "queue_name", "created_on", "modified_on"], + "type": "object" + } + ] + } + } + }, + "description": "Update Queue response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "allOf": [{ "$ref": "#/components/schemas/queue_updated" }], "type": "object" } + }, + "required": ["queue_id", "queue_name", "created_on", "modified_on"], + "type": "object" + } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Queue response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Queue", + "tags": ["Queue"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.queue.update"] } + } + }, + "/accounts/{account_identifier}/workers/queues/{name}/consumers": { + "get": { + "description": "Returns the consumers for a queue.", + "operationId": "queue-list-queue-consumers", + "parameters": [ + { + "in": "path", + "name": "name", + "required": true, + "schema": { "$ref": "#/components/schemas/queues_components-schemas-name" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "errors": { "nullable": true } } }, + { "properties": { "messages": { "nullable": true } } }, + { + "properties": { + "result_info": { + "properties": { + "count": { "example": 1 }, + "page": { "example": 1 }, + "per_page": { "example": 100 }, + "total_count": { "example": 1 }, + "total_pages": { "example": 1 } + }, + "type": "object" + } + } + }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/consumer" }, "type": "array" } + }, + "required": ["queue_name", "created_on", "settings"], + "type": "object" + } + ] + } + } + }, + "description": "List Queue Consumers response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "properties": { "errors": { "nullable": true } } }, + { "properties": { "messages": { "nullable": true } } }, + { + "properties": { + "result_info": { + "properties": { + "count": { "example": 1 }, + "page": { "example": 1 }, + "per_page": { "example": 100 }, + "total_count": { "example": 1 }, + "total_pages": { "example": 1 } + }, + "type": "object" + } + } + }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/consumer" }, "type": "array" } + }, + "required": ["queue_name", "created_on", "settings"], + "type": "object" + } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Queue Consumers response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Queue Consumers", + "tags": ["Queue"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.queue.list"] } + }, + "post": { + "description": "Creates a new consumer for a queue.", + "operationId": "queue-create-queue-consumer", + "parameters": [ + { + "in": "path", + "name": "name", + "required": true, + "schema": { "$ref": "#/components/schemas/queues_components-schemas-name" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "example": { + "dead_letter_queue": "example-dlq", + "environment": "production", + "script_name": "example-consumer", + "settings": { "batch_size": 10, "max_retries": 3, "max_wait_time_ms": 5000 } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "allOf": [{ "$ref": "#/components/schemas/consumer_created" }], "type": "object" } + }, + "required": ["queue_name", "script_name", "settings", "dead_letter_queue", "created_on"], + "type": "object" + } + ] + } + } + }, + "description": "Create Queue Consumer response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "allOf": [{ "$ref": "#/components/schemas/consumer_created" }], + "type": "object" + } + }, + "required": ["queue_name", "script_name", "settings", "dead_letter_queue", "created_on"], + "type": "object" + } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Queue Consumer response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Queue Consumer", + "tags": ["Queue"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.queue.create"] } + } + }, + "/accounts/{account_identifier}/workers/queues/{name}/consumers/{consumer_name}": { + "delete": { + "description": "Deletes the consumer for a queue.", + "operationId": "queue-delete-queue-consumer", + "parameters": [ + { + "in": "path", + "name": "consumer_name", + "required": true, + "schema": { "$ref": "#/components/schemas/consumer_name" } + }, + { + "in": "path", + "name": "name", + "required": true, + "schema": { "$ref": "#/components/schemas/queues_components-schemas-name" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "nullable": true, "properties": { "result": { "nullable": true } } } + ] + } + } + }, + "description": "Delete Queue Consumer response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "nullable": true, "properties": { "result": { "nullable": true } } } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Queue Consumer response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Queue Consumer", + "tags": ["Queue"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.queue.delete"] } + }, + "put": { + "description": "Updates the consumer for a queue, or creates one if it does not exist.", + "operationId": "queue-update-queue-consumer", + "parameters": [ + { + "in": "path", + "name": "consumer_name", + "required": true, + "schema": { "$ref": "#/components/schemas/consumer_name" } + }, + { + "in": "path", + "name": "name", + "required": true, + "schema": { "$ref": "#/components/schemas/queues_components-schemas-name" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "example": { + "dead_letter_queue": "updated-example-dlq", + "environment": "production", + "script_name": "example-consumer", + "settings": { "batch_size": 100 } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "allOf": [{ "$ref": "#/components/schemas/consumer_updated" }], "type": "object" } + }, + "required": ["queue_name", "script_name", "settings", "dead_letter_queue", "created_on"], + "type": "object" + } + ] + } + } + }, + "description": "Update Queue Consumer response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "allOf": [{ "$ref": "#/components/schemas/consumer_updated" }], + "type": "object" + } + }, + "required": ["queue_name", "script_name", "settings", "dead_letter_queue", "created_on"], + "type": "object" + } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Queue Consumer response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Queue Consumer", + "tags": ["Queue"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.queue.update"] } + } + }, + "/accounts/{account_identifier}/workers/scripts": { + "get": { + "description": "Fetch a list of uploaded workers.", + "operationId": "worker-script-list-workers", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/script-response-collection-rhW1Gmt4" } } + }, + "description": "List Workers response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/script-response-collection-rhW1Gmt4" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Workers response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Workers", + "tags": ["Worker Script"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.script.list"] } + } + }, + "/accounts/{account_identifier}/workers/scripts/{script_name}": { + "delete": { + "description": "Delete your worker. This call has no response body on a successful delete.\n\n**Query paramaters**:\n\n1. `force`: boolean; If set to true, delete will not be stopped by associated service binding, durable object, or other binding. Any of these associated bindings/durable objects will be deleted along with the script.", + "operationId": "worker-script-delete-worker", + "parameters": [ + { + "in": "path", + "name": "script_name", + "required": true, + "schema": { "$ref": "#/components/schemas/script_name" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { "content": { "application/json": {} }, "description": "Delete Worker response" }, + "4xx": { "content": { "application/json": {} }, "description": "Delete Worker response failure" } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Worker", + "tags": ["Worker Script"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.script.delete"] } + }, + "get": { + "description": "Fetch raw script content for your worker. Note this is the original script content, not JSON encoded.", + "operationId": "worker-script-download-worker", + "parameters": [ + { + "in": "path", + "name": "script_name", + "required": true, + "schema": { "$ref": "#/components/schemas/script_name" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "undefined": { + "schema": { + "example": "addEventListener('fetch', event =\u003e { event.respondWith(fetch(event.request)) })" + } + } + }, + "description": "Download Worker response" + }, + "4xx": { + "content": { + "undefined": { + "schema": { + "example": "addEventListener('fetch', event =\u003e { event.respondWith(fetch(event.request)) })" + } + } + }, + "description": "Download Worker response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Download Worker", + "tags": ["Worker Script"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.script.read"] } + }, + "put": { + "description": "Upload a worker module.", + "operationId": "worker-script-upload-worker-module", + "parameters": [ + { + "in": "path", + "name": "script_name", + "required": true, + "schema": { "$ref": "#/components/schemas/script_name" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "properties": { + "\"second-file.js\"": { + "description": "Worker script.", + "example": "@second-file.js;type=application/javascript+module", + "type": "string" + }, + "\"worker.js\"": { + "description": "Worker script.", + "example": "@worker.js;type=application/javascript+module", + "type": "string" + }, + "metadata": { + "description": "Metadata for script such as bindings. Main module needs to be specified with `main_module`.", + "example": "{\"main_module\": \"worker.js\", \"some_binding\": \"stuff\"}", + "type": "string" + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "example": { + "errors": [], + "messages": [], + "result": { + "created_on": "2022-05-05T05:15:11.602148Z", + "etag": "777f24a43bef5f69174aa69ceaf1dea67968d510a31d1vw3e49d34a0187c06d1", + "handlers": ["fetch"], + "id": "this-is_my_script-01", + "modified_on": "2022-05-20T19:02:56.446492Z", + "usage_model": "bundled" + }, + "success": true + } + } + } + }, + "description": "Upload Worker Module response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "example": { + "errors": [], + "messages": [], + "result": { + "created_on": "2022-05-05T05:15:11.602148Z", + "etag": "777f24a43bef5f69174aa69ceaf1dea67968d510a31d1vw3e49d34a0187c06d1", + "handlers": ["fetch"], + "id": "this-is_my_script-01", + "modified_on": "2022-05-20T19:02:56.446492Z", + "usage_model": "bundled" + }, + "success": true + } + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Upload Worker Module response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Upload Worker Module", + "tags": ["Worker Script"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.script.create"] } + } + }, + "/accounts/{account_identifier}/workers/scripts/{script_name}/schedules": { + "get": { + "description": "Fetches Cron Triggers for a Worker.", + "operationId": "worker-cron-trigger-get-cron-triggers", + "parameters": [ + { + "in": "path", + "name": "script_name", + "required": true, + "schema": { "$ref": "#/components/schemas/script_name" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/cron-trigger-response-collection" } } + }, + "description": "Get Cron Triggers response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/cron-trigger-response-collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Cron Triggers response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Cron Triggers", + "tags": ["Worker Cron Trigger"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.cron.trigger.read"] } + }, + "put": { + "description": "Updates Cron Triggers for a Worker.", + "operationId": "worker-cron-trigger-update-cron-triggers", + "parameters": [ + { + "in": "path", + "name": "script_name", + "required": true, + "schema": { "$ref": "#/components/schemas/script_name" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "example": "[{'cron': '*/30 * * * *'}]" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/cron-trigger-response-collection" } } + }, + "description": "Update Cron Triggers response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/cron-trigger-response-collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Cron Triggers response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Cron Triggers", + "tags": ["Worker Cron Trigger"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.cron.trigger.update"] } + } + }, + "/accounts/{account_identifier}/workers/scripts/{script_name}/tails": { + "get": { + "description": "Get list of tails currently deployed on a worker.", + "operationId": "worker-tail-logs-list-tails", + "parameters": [ + { + "in": "path", + "name": "script_name", + "required": true, + "schema": { "$ref": "#/components/schemas/script_name" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tail-response" } } }, + "description": "List Tails response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/tail-response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Tails response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Tails", + "tags": ["Worker Tail Logs"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.script.read"] } + }, + "post": { + "description": "Starts a tail that receives logs and exception from a Worker.", + "operationId": "worker-tail-logs-start-tail", + "parameters": [ + { + "in": "path", + "name": "script_name", + "required": true, + "schema": { "$ref": "#/components/schemas/script_name" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tail-response" } } }, + "description": "Start Tail response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/tail-response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Start Tail response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Start Tail", + "tags": ["Worker Tail Logs"], + "x-cfPermissionsRequired": { + "enum": ["com.cloudflare.edge.worker.script.read", "com.cloudflare.edge.worker.tail.create"] + } + } + }, + "/accounts/{account_identifier}/workers/scripts/{script_name}/tails/{id}": { + "delete": { + "description": "Deletes a tail from a Worker.", + "operationId": "worker-tail-logs-delete-tail", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-id-OWr6ZoMG" } + }, + { + "in": "path", + "name": "script_name", + "required": true, + "schema": { "$ref": "#/components/schemas/script_name" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common" } } }, + "description": "Delete Tail response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Tail response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Tail", + "tags": ["Worker Tail Logs"], + "x-cfPermissionsRequired": { + "enum": ["com.cloudflare.edge.worker.script.read", "com.cloudflare.edge.worker.tail.create"] + } + } + }, + "/accounts/{account_identifier}/workers/scripts/{script_name}/usage-model": { + "get": { + "description": "Fetches the Usage Model for a given Worker.", + "operationId": "worker-script-fetch-usage-model", + "parameters": [ + { + "in": "path", + "name": "script_name", + "required": true, + "schema": { "$ref": "#/components/schemas/script_name" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/usage-model-response" } } }, + "description": "Fetch Usage Model response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/usage-model-response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Fetch Usage Model response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Fetch Usage Model", + "tags": ["Worker Script"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.script.read"] } + }, + "put": { + "description": "Updates the Usage Model for a given Worker. Requires a Workers Paid subscription.", + "operationId": "worker-script-update-usage-model", + "parameters": [ + { + "in": "path", + "name": "script_name", + "required": true, + "schema": { "$ref": "#/components/schemas/script_name" } + }, + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "example": "{'usage_model': 'unbound'}" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/usage-model-response" } } }, + "description": "Update Usage Model response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/usage-model-response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Usage Model response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Usage Model", + "tags": ["Worker Script"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.script.create"] } + } + }, + "/accounts/{account_identifier}/workers/subdomain": { + "get": { + "description": "Returns a Workers subdomain for an account.", + "operationId": "worker-subdomain-get-subdomain", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subdomain-response" } } }, + "description": "Get Subdomain response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/subdomain-response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Subdomain response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Subdomain", + "tags": ["Worker Subdomain"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.cron.subdomain.read"] } + }, + "put": { + "description": "Creates a Workers subdomain for an account.", + "operationId": "worker-subdomain-create-subdomain", + "parameters": [ + { + "in": "path", + "name": "account_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "example": "{'subdomain': 'example-subdomain'}" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subdomain-response" } } }, + "description": "Create Subdomain response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/subdomain-response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Subdomain response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Subdomain", + "tags": ["Worker Subdomain"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.cron.subdomain.create"] } + } + }, + "/accounts/{account_id}/gateway/categories": { + "get": { + "description": "List all Categories.", + "operationId": "zero-trust-gateway-categories-list-categories", + "parameters": [ + { + "in": "path", + "name": "account_id", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/categories_components-schemas-response_collection" } + } + }, + "description": "List Categories response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/categories_components-schemas-response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Categories response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Categories", + "tags": ["Zero Trust Gateway Categories"] + } + }, + "/accounts/{account_id}/rulesets": { + "get": { + "description": "Fetches all rulesets at the account level.", + "operationId": "account-rulesets-list-account-rulesets", + "parameters": [ + { + "in": "path", + "name": "account_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rulesets_response" } } }, + "description": "List account rulesets response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/rulesets_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List account rulesets response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List account rulesets", + "tags": ["Account Rulesets"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "post": { + "description": "Creates a ruleset at the account level.", + "operationId": "account-rulesets-create-an-account-ruleset", + "parameters": [ + { + "in": "path", + "name": "account_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_ruleset" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } }, + "description": "Create an account ruleset response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/ruleset_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create an account ruleset response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create an account ruleset", + "tags": ["Account Rulesets"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint": { + "get": { + "description": "Fetches the latest version of the account entry point ruleset for a given phase.", + "operationId": "account-rulesets-get-an-account-entry-point-ruleset", + "parameters": [ + { + "in": "path", + "name": "ruleset_phase", + "required": true, + "schema": { "$ref": "#/components/schemas/phase" } + }, + { + "in": "path", + "name": "account_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } }, + "description": "Get an account entry point ruleset response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/ruleset_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get an account entry point ruleset response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get an account entry point ruleset", + "tags": ["Account Rulesets"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "put": { + "description": "Updates an account entry point ruleset, creating a new version.", + "operationId": "account-rulesets-update-an-account-entry-point-ruleset", + "parameters": [ + { + "in": "path", + "name": "ruleset_phase", + "required": true, + "schema": { "$ref": "#/components/schemas/phase" } + }, + { + "in": "path", + "name": "account_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_ruleset" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } }, + "description": "Update an account entry point ruleset response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/ruleset_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update an account entry point ruleset response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update an account entry point ruleset", + "tags": ["Account Rulesets"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions": { + "get": { + "description": "Fetches the versions of an account entry point ruleset.", + "operationId": "account-rulesets-list-an-account-entry-point-ruleset'-s-versions", + "parameters": [ + { + "in": "path", + "name": "ruleset_phase", + "required": true, + "schema": { "$ref": "#/components/schemas/phase" } + }, + { + "in": "path", + "name": "account_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rulesets_response" } } }, + "description": "List an account entry point ruleset's versions response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/rulesets_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List an account entry point ruleset's versions response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List an account entry point ruleset's versions", + "tags": ["Account Rulesets"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions/{ruleset_version}": { + "get": { + "description": "Fetches a specific version of an account entry point ruleset.", + "operationId": "account-rulesets-get-an-account-entry-point-ruleset-version", + "parameters": [ + { + "in": "path", + "name": "ruleset_version", + "required": true, + "schema": { "$ref": "#/components/schemas/version-VHkxmcSG" } + }, + { + "in": "path", + "name": "ruleset_phase", + "required": true, + "schema": { "$ref": "#/components/schemas/phase" } + }, + { + "in": "path", + "name": "account_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } }, + "description": "Get an account entry point ruleset version response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/ruleset_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get an account entry point ruleset version response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get an account entry point ruleset version", + "tags": ["Account Rulesets"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/accounts/{account_id}/rulesets/{ruleset_id}": { + "delete": { + "description": "Deletes all versions of an existing account ruleset.", + "operationId": "account-rulesets-delete-an-account-ruleset", + "parameters": [ + { + "in": "path", + "name": "ruleset_id", + "required": true, + "schema": { "$ref": "#/components/schemas/rulesets_components-schemas-id" } + }, + { + "in": "path", + "name": "account_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { "content": { "application/json": {} }, "description": "Delete an account ruleset response" }, + "4xx": { "content": { "application/json": {} }, "description": "Delete an account ruleset response failure" } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete an account ruleset", + "tags": ["Account Rulesets"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "get": { + "description": "Fetches the latest version of an account ruleset.", + "operationId": "account-rulesets-get-an-account-ruleset", + "parameters": [ + { + "in": "path", + "name": "ruleset_id", + "required": true, + "schema": { "$ref": "#/components/schemas/rulesets_components-schemas-id" } + }, + { + "in": "path", + "name": "account_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } }, + "description": "Get an account ruleset response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/ruleset_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get an account ruleset response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get an account ruleset", + "tags": ["Account Rulesets"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "put": { + "description": "Updates an account ruleset, creating a new version.", + "operationId": "account-rulesets-update-an-account-ruleset", + "parameters": [ + { + "in": "path", + "name": "ruleset_id", + "required": true, + "schema": { "$ref": "#/components/schemas/rulesets_components-schemas-id" } + }, + { + "in": "path", + "name": "account_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_ruleset" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } }, + "description": "Update an account ruleset response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/ruleset_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update an account ruleset response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update an account ruleset", + "tags": ["Account Rulesets"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/accounts/{account_id}/rulesets/{ruleset_id}/rules": { + "post": { + "description": "Adds a new rule to an account ruleset. The rule will be added to the end of the existing list of rules in the ruleset.", + "operationId": "account-rulesets-create-an-account-ruleset-rule", + "parameters": [ + { + "in": "path", + "name": "ruleset_id", + "required": true, + "schema": { "$ref": "#/components/schemas/rulesets_components-schemas-id" } + }, + { + "in": "path", + "name": "account_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_update_rule" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } }, + "description": "Create an account ruleset rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/ruleset_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create an account ruleset rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create an account ruleset rule", + "tags": ["Account Rulesets"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/accounts/{account_id}/rulesets/{ruleset_id}/rules/{rule_id}": { + "delete": { + "description": "Deletes an existing rule from an account ruleset.", + "operationId": "account-rulesets-delete-an-account-ruleset-rule", + "parameters": [ + { + "in": "path", + "name": "rule_id", + "required": true, + "schema": { "$ref": "#/components/schemas/rules_components-schemas-id" } + }, + { + "in": "path", + "name": "ruleset_id", + "required": true, + "schema": { "$ref": "#/components/schemas/rulesets_components-schemas-id" } + }, + { + "in": "path", + "name": "account_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } }, + "description": "Delete an account ruleset rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/ruleset_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete an account ruleset rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete an account ruleset rule", + "tags": ["Account Rulesets"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Updates an existing rule in an account ruleset.", + "operationId": "account-rulesets-update-an-account-ruleset-rule", + "parameters": [ + { + "in": "path", + "name": "rule_id", + "required": true, + "schema": { "$ref": "#/components/schemas/rules_components-schemas-id" } + }, + { + "in": "path", + "name": "ruleset_id", + "required": true, + "schema": { "$ref": "#/components/schemas/rulesets_components-schemas-id" } + }, + { + "in": "path", + "name": "account_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_update_rule" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } }, + "description": "Update an account ruleset rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/ruleset_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update an account ruleset rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update an account ruleset rule", + "tags": ["Account Rulesets"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/accounts/{account_id}/rulesets/{ruleset_id}/versions": { + "get": { + "description": "Fetches the versions of an account ruleset.", + "operationId": "account-rulesets-list-an-account-ruleset'-s-versions", + "parameters": [ + { + "in": "path", + "name": "ruleset_id", + "required": true, + "schema": { "$ref": "#/components/schemas/rulesets_components-schemas-id" } + }, + { + "in": "path", + "name": "account_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rulesets_response" } } }, + "description": "List an account ruleset's versions response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/rulesets_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List an account ruleset's versions response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List an account ruleset's versions", + "tags": ["Account Rulesets"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version}": { + "delete": { + "description": "Deletes an existing version of an account ruleset.", + "operationId": "account-rulesets-delete-an-account-ruleset-version", + "parameters": [ + { + "in": "path", + "name": "ruleset_version", + "required": true, + "schema": { "$ref": "#/components/schemas/version-VHkxmcSG" } + }, + { + "in": "path", + "name": "ruleset_id", + "required": true, + "schema": { "$ref": "#/components/schemas/rulesets_components-schemas-id" } + }, + { + "in": "path", + "name": "account_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { "content": { "application/json": {} }, "description": "Delete an account ruleset version response" }, + "4xx": { + "content": { "application/json": {} }, + "description": "Delete an account ruleset version response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete an account ruleset version", + "tags": ["Account Rulesets"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "get": { + "description": "Fetches a specific version of an account ruleset.", + "operationId": "account-rulesets-get-an-account-ruleset-version", + "parameters": [ + { + "in": "path", + "name": "ruleset_version", + "required": true, + "schema": { "$ref": "#/components/schemas/version-VHkxmcSG" } + }, + { + "in": "path", + "name": "ruleset_id", + "required": true, + "schema": { "$ref": "#/components/schemas/rulesets_components-schemas-id" } + }, + { + "in": "path", + "name": "account_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } }, + "description": "Get an account ruleset version response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/ruleset_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get an account ruleset version response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get an account ruleset version", + "tags": ["Account Rulesets"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version}/by_tag/{rule_tag}": { + "get": { + "description": "Fetches the rules of a managed account ruleset version for a given tag.", + "operationId": "account-rulesets-list-an-account-ruleset-version'-s-rules-by-tag", + "parameters": [ + { "in": "path", "name": "rule_tag", "required": true, "schema": { "$ref": "#/components/schemas/category" } }, + { + "in": "path", + "name": "ruleset_version", + "required": true, + "schema": { "$ref": "#/components/schemas/version-VHkxmcSG" } + }, + { + "in": "path", + "name": "ruleset_id", + "required": true, + "schema": { "$ref": "#/components/schemas/rulesets_components-schemas-id" } + }, + { + "in": "path", + "name": "account_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } }, + "description": "List an account ruleset version's rules by tag response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/ruleset_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List an account ruleset version's rules by tag response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List an account ruleset version's rules by tag", + "tags": ["Account Rulesets"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/accounts/{identifier}": { + "get": { + "description": "Get information about a specific account that you are a member of.", + "operationId": "accounts-account-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier-3n9sRq0H" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_single" } } }, + "description": "Account Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Account Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Account Details", + "tags": ["Accounts"], + "x-cfPermissionsRequired": { "enum": ["#organization:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "put": { + "description": "Update an existing account.", + "operationId": "accounts-update-account", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier-3n9sRq0H" } + } + ], + "requestBody": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/components-schemas-account" } } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_single" } } }, + "description": "Update Account response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Account response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Account", + "tags": ["Accounts"], + "x-cfPermissionsRequired": { "enum": ["#organization:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/accounts/{identifier}/access/apps": { + "get": { + "description": "Lists all Access applications in an account.", + "operationId": "access-applications-list-access-applications", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/apps_components-schemas-response_collection" } + } + }, + "description": "List Access applications response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/apps_components-schemas-response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Access applications response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Access applications", + "tags": ["Access applications"] + }, + "post": { + "description": "Adds a new application to Access.", + "operationId": "access-applications-add-an-application", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/apps" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/apps_components-schemas-single_response" }, + { "properties": { "result": { "$ref": "#/components/schemas/apps" } } } + ] + } + } + }, + "description": "Add an application response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/apps_components-schemas-single_response" }, + { + "properties": { + "result": { + "allOf": [ + { "$ref": "#/components/schemas/basic_app_response_props" }, + { "$ref": "#/components/schemas/bookmark_props" } + ] + } + } + } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Add a Bookmark application response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Add an Access Application", + "tags": ["Access applications"] + } + }, + "/accounts/{identifier}/access/apps/ca": { + "get": { + "description": "Lists short-lived certificate CAs and their public keys.", + "operationId": "access-short-lived-certificate-c-as-list-short-lived-certificate-c-as", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ca_components-schemas-response_collection" } + } + }, + "description": "List short-lived certificate CAs response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/ca_components-schemas-response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List short-lived certificate CAs response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List short-lived certificate CAs", + "tags": ["Access short-lived certificate CAs"] + } + }, + "/accounts/{identifier}/access/apps/{app_id}": { + "delete": { + "description": "Deletes an application from Access.", + "operationId": "access-applications-delete-an-access-application", + "parameters": [ + { + "in": "path", + "name": "app_id", + "required": true, + "schema": { "$ref": "#/components/schemas/app_id-akwLjhUv" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-id_response-th0exOPu" } + } + }, + "description": "Delete an Access application response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-id_response-th0exOPu" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete an Access application response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete an Access application", + "tags": ["Access applications"] + }, + "get": { + "description": "Fetches information about an Access application.", + "operationId": "access-applications-get-an-access-application", + "parameters": [ + { + "in": "path", + "name": "app_id", + "required": true, + "schema": { "$ref": "#/components/schemas/app_id-akwLjhUv" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/apps_components-schemas-single_response" } + } + }, + "description": "Get an Access application response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/apps_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get an Access application response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get an Access application", + "tags": ["Access applications"] + }, + "put": { + "description": "Updates an Access application.", + "operationId": "access-applications-update-a-bookmark-application", + "parameters": [ + { + "in": "path", + "name": "app_id", + "required": true, + "schema": { "$ref": "#/components/schemas/app_id-akwLjhUv" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/apps" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/apps_components-schemas-single_response" }, + { "properties": { "result": { "$ref": "#/components/schemas/apps" } } } + ] + } + } + }, + "description": "Update an Access application response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/apps_components-schemas-single_response" }, + { + "properties": { + "result": { + "allOf": [ + { "$ref": "#/components/schemas/basic_app_response_props" }, + { "$ref": "#/components/schemas/bookmark_props" } + ] + } + } + } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update an Access application response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update an Access application", + "tags": ["Access applications"] + } + }, + "/accounts/{identifier}/access/apps/{app_id}/revoke_tokens": { + "post": { + "description": "Revokes all service tokens used by an application.", + "operationId": "access-applications-revoke-service-tokens", + "parameters": [ + { + "in": "path", + "name": "app_id", + "required": true, + "schema": { "$ref": "#/components/schemas/app_id-akwLjhUv" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-empty_response" } } }, + "description": "Revoke service tokens response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-empty_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Revoke service tokens response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Revoke service tokens", + "tags": ["Access applications"] + } + }, + "/accounts/{identifier}/access/apps/{app_id}/user_policy_checks": { + "get": { + "description": "Tests if a specific user has permission to access an application.", + "operationId": "access-applications-test-access-policies", + "parameters": [ + { + "in": "path", + "name": "app_id", + "required": true, + "schema": { "$ref": "#/components/schemas/app_id-akwLjhUv" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/policy_check_response" } } }, + "description": "Test Access policies response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/policy_check_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Test Access policies response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Test Access policies", + "tags": ["Access applications"] + } + }, + "/accounts/{identifier}/access/apps/{uuid1}/policies/{uuid}": { + "delete": { + "description": "Delete an Access policy.", + "operationId": "access-policies-delete-an-access-policy", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-uuid" } + }, + { + "in": "path", + "name": "uuid1", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-uuid" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/policies_components-schemas-id_response" } + } + }, + "description": "Delete an Access policy response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/policies_components-schemas-id_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete an Access policy response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete an Access policy", + "tags": ["Access policies"] + }, + "get": { + "description": "Fetches a single Access policy.", + "operationId": "access-policies-get-an-access-policy", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-uuid" } + }, + { + "in": "path", + "name": "uuid1", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-uuid" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/policies_components-schemas-single_response" } + } + }, + "description": "Get an Access policy response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/policies_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get an Access policy response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get an Access policy", + "tags": ["Access policies"] + }, + "put": { + "description": "Update a configured Access policy.", + "operationId": "access-policies-update-an-access-policy", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-uuid" } + }, + { + "in": "path", + "name": "uuid1", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-uuid" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "approval_groups": { "$ref": "#/components/schemas/approval_groups" }, + "approval_required": { "$ref": "#/components/schemas/approval_required" }, + "decision": { "$ref": "#/components/schemas/decision" }, + "exclude": { "$ref": "#/components/schemas/schemas-exclude" }, + "include": { "$ref": "#/components/schemas/include" }, + "name": { "$ref": "#/components/schemas/policies_components-schemas-name" }, + "precedence": { "$ref": "#/components/schemas/precedence-GXhj5toi" }, + "purpose_justification_prompt": { "$ref": "#/components/schemas/purpose_justification_prompt" }, + "purpose_justification_required": { "$ref": "#/components/schemas/purpose_justification_required" }, + "require": { "$ref": "#/components/schemas/schemas-require" } + }, + "required": ["name", "decision", "include"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/policies_components-schemas-single_response" } + } + }, + "description": "Update an Access policy response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/policies_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update an Access policy response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update an Access policy", + "tags": ["Access policies"] + } + }, + "/accounts/{identifier}/access/apps/{uuid}/ca": { + "delete": { + "description": "Deletes a short-lived certificate CA.", + "operationId": "access-short-lived-certificate-c-as-delete-a-short-lived-certificate-ca", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-id_response-77ATe4Eu" } } + }, + "description": "Delete a short-lived certificate CA response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-id_response-77ATe4Eu" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete a short-lived certificate CA response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete a short-lived certificate CA", + "tags": ["Access short-lived certificate CAs"] + }, + "get": { + "description": "Fetches a short-lived certificate CA and its public key.", + "operationId": "access-short-lived-certificate-c-as-get-a-short-lived-certificate-ca", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ca_components-schemas-single_response" } } + }, + "description": "Get a short-lived certificate CA response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/ca_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get a short-lived certificate CA response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a short-lived certificate CA", + "tags": ["Access short-lived certificate CAs"] + }, + "post": { + "description": "Generates a new short-lived certificate CA and public key.", + "operationId": "access-short-lived-certificate-c-as-create-a-short-lived-certificate-ca", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ca_components-schemas-single_response" } } + }, + "description": "Create a short-lived certificate CA response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/ca_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create a short-lived certificate CA response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create a short-lived certificate CA", + "tags": ["Access short-lived certificate CAs"] + } + }, + "/accounts/{identifier}/access/apps/{uuid}/policies": { + "get": { + "description": "Lists Access policies configured for an application.", + "operationId": "access-policies-list-access-policies", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-uuid" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/policies_components-schemas-response_collection" } + } + }, + "description": "List Access policies response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/policies_components-schemas-response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Access policies response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Access policies", + "tags": ["Access policies"] + }, + "post": { + "description": "Create a new Access policy for an application.", + "operationId": "access-policies-create-an-access-policy", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-uuid" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "approval_groups": { "$ref": "#/components/schemas/approval_groups" }, + "approval_required": { "$ref": "#/components/schemas/approval_required" }, + "decision": { "$ref": "#/components/schemas/decision" }, + "exclude": { "$ref": "#/components/schemas/schemas-exclude" }, + "include": { "$ref": "#/components/schemas/include" }, + "name": { "$ref": "#/components/schemas/policies_components-schemas-name" }, + "precedence": { "$ref": "#/components/schemas/precedence-GXhj5toi" }, + "purpose_justification_prompt": { "$ref": "#/components/schemas/purpose_justification_prompt" }, + "purpose_justification_required": { "$ref": "#/components/schemas/purpose_justification_required" }, + "require": { "$ref": "#/components/schemas/schemas-require" } + }, + "required": ["name", "decision", "include"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/policies_components-schemas-single_response" } + } + }, + "description": "Create an Access policy response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/policies_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create an Access policy response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create an Access policy", + "tags": ["Access policies"] + } + }, + "/accounts/{identifier}/access/bookmarks": { + "get": { + "deprecated": true, + "description": "Lists Bookmark applications.", + "operationId": "access-bookmark-applications-(-deprecated)-list-bookmark-applications", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/bookmarks_components-schemas-response_collection" } + } + }, + "description": "List Bookmark applications response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/bookmarks_components-schemas-response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Bookmark applications response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Bookmark applications", + "tags": ["Access Bookmark applications (Deprecated)"], + "x-cfDeprecation": { + "description": "This endpoint is deprecated in favor of using a specialized Access Application App Type.", + "display": true, + "eol": "2023-03-19", + "id": "bookmarks_deprecation" + } + } + }, + "/accounts/{identifier}/access/bookmarks/{uuid}": { + "delete": { + "deprecated": true, + "description": "Deletes a Bookmark application.", + "operationId": "access-bookmark-applications-(-deprecated)-delete-a-bookmark-application", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-id_response-th0exOPu" } + } + }, + "description": "Delete a Bookmark application response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-id_response-th0exOPu" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete a Bookmark application response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete a Bookmark application", + "tags": ["Access Bookmark applications (Deprecated)"], + "x-cfDeprecation": { + "description": "This endpoint is deprecated in favor of using a specialized Access Application App Type.", + "display": true, + "eol": "2023-03-19", + "id": "bookmarks_deprecation" + } + }, + "get": { + "deprecated": true, + "description": "Fetches a single Bookmark application.", + "operationId": "access-bookmark-applications-(-deprecated)-get-a-bookmark-application", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/bookmarks_components-schemas-single_response" } + } + }, + "description": "Get a Bookmark application response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/bookmarks_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get a Bookmark application response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a Bookmark application", + "tags": ["Access Bookmark applications (Deprecated)"], + "x-cfDeprecation": { + "description": "This endpoint is deprecated in favor of using a specialized Access Application App Type.", + "display": true, + "eol": "2023-03-19", + "id": "bookmarks_deprecation" + } + }, + "post": { + "deprecated": true, + "description": "Create a new Bookmark application.", + "operationId": "access-bookmark-applications-(-deprecated)-create-a-bookmark-application", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/bookmarks_components-schemas-single_response" } + } + }, + "description": "Create a Bookmark application response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/bookmarks_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create a Bookmark application response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create a Bookmark application", + "tags": ["Access Bookmark applications (Deprecated)"], + "x-cfDeprecation": { + "description": "This endpoint is deprecated in favor of using a specialized Access Application App Type.", + "display": true, + "eol": "2023-03-19", + "id": "bookmarks_deprecation" + } + }, + "put": { + "deprecated": true, + "description": "Updates a configured Bookmark application.", + "operationId": "access-bookmark-applications-(-deprecated)-update-a-bookmark-application", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/bookmarks_components-schemas-single_response" } + } + }, + "description": "Update a Bookmark application response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/bookmarks_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update a Bookmark application response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update a Bookmark application", + "tags": ["Access Bookmark applications (Deprecated)"], + "x-cfDeprecation": { + "description": "This endpoint is deprecated in favor of using a specialized Access Application App Type.", + "display": true, + "eol": "2023-03-19", + "id": "bookmarks_deprecation" + } + } + }, + "/accounts/{identifier}/access/certificates": { + "get": { + "description": "Lists all mTLS root certificates.", + "operationId": "access-m-tls-authentication-list-m-tls-certificates", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/certificates_components-schemas-response_collection" } + } + }, + "description": "List mTLS certificates response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/certificates_components-schemas-response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List mTLS certificates response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List mTLS certificates", + "tags": ["Access mTLS authentication"] + }, + "post": { + "description": "Adds a new mTLS root certificate to Access.", + "operationId": "access-m-tls-authentication-add-an-m-tls-certificate", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "associated_hostnames": { "$ref": "#/components/schemas/associated_hostnames" }, + "certificate": { + "description": "The certificate content.", + "example": "-----BEGIN CERTIFICATE-----\nMIIGAjCCA+qgAwIBAgIJAI7kymlF7CWT...N4RI7KKB7nikiuUf8vhULKy5IX10\nDrUtmu/B\n-----END CERTIFICATE-----", + "type": "string" + }, + "name": { "$ref": "#/components/schemas/certificates_components-schemas-name" } + }, + "required": ["name", "certificate"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/certificates_components-schemas-single_response" } + } + }, + "description": "Add an mTLS certificate response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/certificates_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Add an mTLS certificate response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Add an mTLS certificate", + "tags": ["Access mTLS authentication"] + } + }, + "/accounts/{identifier}/access/certificates/{uuid}": { + "delete": { + "description": "Deletes an mTLS certificate.", + "operationId": "access-m-tls-authentication-delete-an-m-tls-certificate", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-id_response-th0exOPu" } + } + }, + "description": "Delete an mTLS certificate response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-id_response-th0exOPu" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete an mTLS certificate response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete an mTLS certificate", + "tags": ["Access mTLS authentication"] + }, + "get": { + "description": "Fetches a single mTLS certificate.", + "operationId": "access-m-tls-authentication-get-an-m-tls-certificate", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/certificates_components-schemas-single_response" } + } + }, + "description": "Get an mTLS certificate response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/certificates_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get an mTLS certificate response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get an mTLS certificate", + "tags": ["Access mTLS authentication"] + }, + "put": { + "description": "Updates a configured mTLS certificate.", + "operationId": "access-m-tls-authentication-update-an-m-tls-certificate", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "associated_hostnames": { "$ref": "#/components/schemas/associated_hostnames" }, + "name": { "$ref": "#/components/schemas/certificates_components-schemas-name" } + }, + "required": ["name", "associated_hostnames"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/certificates_components-schemas-single_response" } + } + }, + "description": "Update an mTLS certificate response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/certificates_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update an mTLS certificate response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update an mTLS certificate", + "tags": ["Access mTLS authentication"] + } + }, + "/accounts/{identifier}/access/groups": { + "get": { + "description": "Lists all Access groups.", + "operationId": "access-groups-list-access-groups", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-response_collection-4HEckTYK" } } + }, + "description": "List Access groups response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-response_collection-4HEckTYK" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Access groups response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Access groups", + "tags": ["Access groups"] + }, + "post": { + "description": "Creates a new Access group.", + "operationId": "access-groups-create-an-access-group", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "exclude": { "$ref": "#/components/schemas/exclude" }, + "include": { "$ref": "#/components/schemas/include" }, + "name": { "$ref": "#/components/schemas/components-schemas-name-4G3Rlgj8" }, + "require": { "$ref": "#/components/schemas/require" } + }, + "required": ["name", "include"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-single_response-gP2O4PI2" } + } + }, + "description": "Create an Access group response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-single_response-gP2O4PI2" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create an Access group response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create an Access group", + "tags": ["Access groups"] + } + }, + "/accounts/{identifier}/access/groups/{uuid}": { + "delete": { + "description": "Deletes an Access group.", + "operationId": "access-groups-delete-an-access-group", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-uuid-JmfIpL8C" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/id_response-DDywCCxj" } } }, + "description": "Delete an Access group response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/id_response-DDywCCxj" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete an Access group response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete an Access group", + "tags": ["Access groups"] + }, + "get": { + "description": "Fetches a single Access group.", + "operationId": "access-groups-get-an-access-group", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-uuid-JmfIpL8C" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-single_response-gP2O4PI2" } + } + }, + "description": "Get an Access group response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-single_response-gP2O4PI2" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get an Access group response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get an Access group", + "tags": ["Access groups"] + }, + "put": { + "description": "Updates a configured Access group.", + "operationId": "access-groups-update-an-access-group", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-uuid-JmfIpL8C" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "exclude": { "$ref": "#/components/schemas/exclude" }, + "include": { "$ref": "#/components/schemas/include" }, + "name": { "$ref": "#/components/schemas/components-schemas-name-4G3Rlgj8" }, + "require": { "$ref": "#/components/schemas/require" } + }, + "required": ["name", "include"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-single_response-gP2O4PI2" } + } + }, + "description": "Update an Access group response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-single_response-gP2O4PI2" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update an Access group response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update an Access group", + "tags": ["Access groups"] + } + }, + "/accounts/{identifier}/access/identity_providers": { + "get": { + "description": "Lists all configured identity providers.", + "operationId": "access-identity-providers-list-access-identity-providers", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/response_collection-oP3HzZox" } } + }, + "description": "List Access identity providers response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/response_collection-oP3HzZox" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Access identity providers response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Access identity providers", + "tags": ["Access identity providers"] + }, + "post": { + "description": "Adds a new identity provider to Access.", + "operationId": "access-identity-providers-add-an-access-identity-provider", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity-providers" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-single_response-CwUTnlnC" } } + }, + "description": "Add an Access identity provider response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-single_response-CwUTnlnC" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Add an Access identity provider response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Add an Access identity provider", + "tags": ["Access identity providers"] + } + }, + "/accounts/{identifier}/access/identity_providers/{uuid}": { + "delete": { + "description": "Deletes an identity provider from Access.", + "operationId": "access-identity-providers-delete-an-access-identity-provider", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single-id" } } }, + "description": "Delete an Access identity provider response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-single_response-CwUTnlnC" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete an Access identity provider response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete an Access identity provider", + "tags": ["Access identity providers"] + }, + "get": { + "description": "Fetches a configured identity provider.", + "operationId": "access-identity-providers-get-an-access-identity-provider", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-single_response-CwUTnlnC" } } + }, + "description": "Get an Access identity provider response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-single_response-CwUTnlnC" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get an Access identity provider response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get an Access identity provider", + "tags": ["Access identity providers"] + }, + "put": { + "description": "Updates a configured identity provider.", + "operationId": "access-identity-providers-update-an-access-identity-provider", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity-providers" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-single_response-CwUTnlnC" } } + }, + "description": "Update an Access identity provider response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-single_response-CwUTnlnC" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update an Access identity provider response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update an Access identity provider", + "tags": ["Access identity providers"] + } + }, + "/accounts/{identifier}/access/keys": { + "get": { + "description": "Gets the Access key rotation settings for an account.", + "operationId": "access-key-configuration-get-the-access-key-configuration", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/keys_components-schemas-single_response" } + } + }, + "description": "Get the Access key configuration response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/keys_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get the Access key configuration response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get the Access key configuration", + "tags": ["Access key configuration"] + }, + "put": { + "description": "Updates the Access key rotation settings for an account.", + "operationId": "access-key-configuration-update-the-access-key-configuration", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "key_rotation_interval_days": { "$ref": "#/components/schemas/key_rotation_interval_days" } + }, + "required": ["key_rotation_interval_days"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/keys_components-schemas-single_response" } + } + }, + "description": "Update the Access key configuration response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/keys_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update the Access key configuration response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update the Access key configuration", + "tags": ["Access key configuration"] + } + }, + "/accounts/{identifier}/access/keys/rotate": { + "post": { + "description": "Perfoms a key rotation for an account.", + "operationId": "access-key-configuration-rotate-access-keys", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/keys_components-schemas-single_response" } + } + }, + "description": "Rotate Access keys response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/keys_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Rotate Access keys response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Rotate Access keys", + "tags": ["Access key configuration"] + } + }, + "/accounts/{identifier}/access/logs/access_requests": { + "get": { + "description": "Gets a list of Access authentication audit logs for an account.", + "operationId": "access-authentication-logs-get-access-authentication-logs", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/access-requests_components-schemas-response_collection" } + } + }, + "description": "Get Access authentication logs response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/access-requests_components-schemas-response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Access authentication logs response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Access authentication logs", + "tags": ["Access authentication logs"] + } + }, + "/accounts/{identifier}/access/organizations": { + "get": { + "description": "Returns the configuration for your Zero Trust organization.", + "operationId": "zero-trust-organization-get-your-zero-trust-organization", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response-x2K6CTG8" } } + }, + "description": "Get your Zero Trust organization response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response-x2K6CTG8" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get your Zero Trust organization response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get your Zero Trust organization", + "tags": ["Zero Trust organization"] + }, + "post": { + "description": "Sets up a Zero Trust organization for your account.", + "operationId": "zero-trust-organization-create-your-zero-trust-organization", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "auth_domain": { "$ref": "#/components/schemas/auth_domain" }, + "auto_redirect_to_identity": { "$ref": "#/components/schemas/auto_redirect_to_identity" }, + "is_ui_read_only": { "$ref": "#/components/schemas/is_ui_read_only" }, + "login_design": { "$ref": "#/components/schemas/login_design" }, + "name": { "$ref": "#/components/schemas/name-xgxcxGi8" }, + "ui_read_only_toggle_reason": { "$ref": "#/components/schemas/ui_read_only_toggle_reason" }, + "user_seat_expiration_inactive_time": { + "$ref": "#/components/schemas/user_seat_expiration_inactive_time" + } + }, + "required": ["name", "auth_domain"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response-x2K6CTG8" } } + }, + "description": "Create your Zero Trust organization response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response-x2K6CTG8" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create your Zero Trust organization response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create your Zero Trust organization", + "tags": ["Zero Trust organization"] + }, + "put": { + "description": "Updates the configuration for your Zero Trust organization.", + "operationId": "zero-trust-organization-update-your-zero-trust-organization", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "auth_domain": { "$ref": "#/components/schemas/auth_domain" }, + "auto_redirect_to_identity": { "$ref": "#/components/schemas/auto_redirect_to_identity" }, + "is_ui_read_only": { "$ref": "#/components/schemas/is_ui_read_only" }, + "login_design": { "$ref": "#/components/schemas/login_design" }, + "name": { "$ref": "#/components/schemas/name-xgxcxGi8" }, + "ui_read_only_toggle_reason": { "$ref": "#/components/schemas/ui_read_only_toggle_reason" }, + "user_seat_expiration_inactive_time": { + "$ref": "#/components/schemas/user_seat_expiration_inactive_time" + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response-x2K6CTG8" } } + }, + "description": "Update your Zero Trust organization response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response-x2K6CTG8" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update your Zero Trust organization response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update your Zero Trust organization", + "tags": ["Zero Trust organization"] + } + }, + "/accounts/{identifier}/access/organizations/revoke_user": { + "post": { + "description": "Revokes a user's access across all applications.", + "operationId": "zero-trust-organization-revoke-all-access-tokens-for-a-user", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "email": { + "description": "The email of the user to revoke.", + "example": "test@example.com", + "type": "string" + } + }, + "required": ["email"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/empty_response-47a5DGxM" } } }, + "description": "Revoke all Access tokens for a user response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/empty_response-47a5DGxM" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Revoke all Access tokens for a user response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Revoke all Access tokens for a user", + "tags": ["Zero Trust organization"] + } + }, + "/accounts/{identifier}/access/seats": { + "patch": { + "description": "Removes a user from a Zero Trust seat when both `access_seat` and `gateway_seat` are set to false.", + "operationId": "zero-trust-seats-update-a-user-seat", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/seats_definition" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/seats_components-schemas-response_collection" } + } + }, + "description": "Update a user seat response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/seats_components-schemas-response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update a user seat response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update a user seat", + "tags": ["Zero Trust seats"] + } + }, + "/accounts/{identifier}/access/service_tokens": { + "get": { + "description": "Lists all service tokens.", + "operationId": "access-service-tokens-list-service-tokens", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-response_collection-Qou49Scv" } + } + }, + "description": "List service tokens response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-response_collection-Qou49Scv" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List service tokens response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List service tokens", + "tags": ["Access service tokens"] + }, + "post": { + "description": "Generates a new service token. **Note:** This is the only time you can get the Client Secret. If you lose the Client Secret, you will have to rotate the Client Secret or create a new service token.", + "operationId": "access-service-tokens-create-a-service-token", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "name": { "$ref": "#/components/schemas/service-tokens_components-schemas-name" } }, + "required": ["name"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_response" } } }, + "description": "Create a service token response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/create_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create a service token response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create a service token", + "tags": ["Access service tokens"] + } + }, + "/accounts/{identifier}/access/service_tokens/{uuid}": { + "delete": { + "description": "Deletes a service token.", + "operationId": "access-service-tokens-delete-a-service-token", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/service-tokens_components-schemas-single_response" } + } + }, + "description": "Delete a service token response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/service-tokens_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete a service token response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete a service token", + "tags": ["Access service tokens"] + }, + "put": { + "description": "Updates a configured service token.", + "operationId": "access-service-tokens-update-a-service-token", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "name": { "$ref": "#/components/schemas/service-tokens_components-schemas-name" } } + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/service-tokens_components-schemas-single_response" } + } + }, + "description": "Update a service token response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/service-tokens_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update a service token response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update a service token", + "tags": ["Access service tokens"] + } + }, + "/accounts/{identifier}/access/service_tokens/{uuid}/refresh": { + "post": { + "description": "Refreshes the expiration of a service token.", + "operationId": "access-service-tokens-refresh-a-service-token", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/service-tokens_components-schemas-single_response" } + } + }, + "description": "Refresh a service token response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/service-tokens_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Refresh a service token response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Refresh a service token", + "tags": ["Access service tokens"] + } + }, + "/accounts/{identifier}/access/service_tokens/{uuid}/rotate": { + "post": { + "description": "Generates a new Client Secret for a service token and revokes the old one.", + "operationId": "access-service-tokens-rotate-a-service-token", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_response" } } }, + "description": "Rotate a service token response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/create_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Rotate a service token response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Rotate a service token", + "tags": ["Access service tokens"] + } + }, + "/accounts/{identifier}/access/users": { + "get": { + "description": "Gets a list of users for an account.", + "operationId": "zero-trust-users-get-users", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/users_components-schemas-response_collection" } + } + }, + "description": "Get users response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/users_components-schemas-response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get users response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get users", + "tags": ["Zero Trust users"] + } + }, + "/accounts/{identifier}/access/users/{id}/failed_logins": { + "get": { + "description": "Get all failed login attempts for a single user.", + "operationId": "zero-trust-users-get-failed-logins", + "parameters": [ + { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/schemas-id" } }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/failed_login_response" } } }, + "description": "Get failed logins response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/failed_login_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get failed logins response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get failed logins", + "tags": ["Zero Trust users"] + } + }, + "/accounts/{identifier}/alerting/v3/destinations/eligible": { + "get": { + "description": "Get a list of all delivery mechanism types for which an account is eligible.", + "operationId": "notification-mechanism-eligibility-get-delivery-mechanism-eligibility", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/eligibility_components-schemas-response_collection" } + } + }, + "description": "Get delivery mechanism eligibility response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/eligibility_components-schemas-response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get delivery mechanism eligibility response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get delivery mechanism eligibility", + "tags": ["Notification Mechanism Eligibility"] + } + }, + "/accounts/{identifier}/alerting/v3/destinations/pagerduty": { + "get": { + "description": "Get a list of all configured PagerDuty services.", + "operationId": "notification-destinations-with-pager-duty-list-pager-duty-services", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/pagerduty_components-schemas-response_collection" } + } + }, + "description": "List PagerDuty services response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/pagerduty_components-schemas-response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List PagerDuty services response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List PagerDuty services", + "tags": ["Notification destinations with PagerDuty"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{identifier}/alerting/v3/destinations/webhooks": { + "get": { + "description": "Gets a list of all configured webhook destinations.", + "operationId": "notification-webhooks-list-webhooks", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/webhooks_components-schemas-response_collection" } + } + }, + "description": "List webhooks response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/webhooks_components-schemas-response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List webhooks response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List webhooks", + "tags": ["Notification webhooks"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + }, + "post": { + "description": "Creates a new webhook destination.", + "operationId": "notification-webhooks-create-a-webhook", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "name": { "$ref": "#/components/schemas/webhooks_components-schemas-name" }, + "secret": { "$ref": "#/components/schemas/secret-QjCIBSp3" }, + "url": { "$ref": "#/components/schemas/webhooks_components-schemas-url" } + }, + "required": ["name", "url"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/webhooks_components-schemas-id_response" } + } + }, + "description": "Create a webhook response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/webhooks_components-schemas-id_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create a webhook response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create a webhook", + "tags": ["Notification webhooks"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + } + }, + "/accounts/{identifier}/alerting/v3/destinations/webhooks/{uuid}": { + "delete": { + "description": "Delete a configured webhook destination.", + "operationId": "notification-webhooks-delete-a-webhook", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-s0SXln0q" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-collection" } } }, + "description": "Delete a webhook response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete a webhook response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete a webhook", + "tags": ["Notification webhooks"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + }, + "get": { + "description": "Get details for a single webhooks destination.", + "operationId": "notification-webhooks-get-a-webhook", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-s0SXln0q" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/webhooks_components-schemas-single_response" } + } + }, + "description": "Get a webhook response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/webhooks_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get a webhook response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a webhook", + "tags": ["Notification webhooks"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + }, + "put": { + "description": "Update a webhook destination.", + "operationId": "notification-webhooks-update-a-webhook", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-s0SXln0q" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "name": { "$ref": "#/components/schemas/webhooks_components-schemas-name" }, + "secret": { "$ref": "#/components/schemas/secret-QjCIBSp3" }, + "url": { "$ref": "#/components/schemas/webhooks_components-schemas-url" } + }, + "required": ["name", "url"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/webhooks_components-schemas-id_response" } + } + }, + "description": "Update a webhook response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/webhooks_components-schemas-id_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update a webhook response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update a webhook", + "tags": ["Notification webhooks"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + } + }, + "/accounts/{identifier}/alerting/v3/history": { + "get": { + "description": "Gets a list of history records for notifications sent to an account. The records are displayed for last `x` number of days based on the zone plan (free = 30, pro = 30, biz = 30, ent = 90).", + "operationId": "notification-history-list-history", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "query", + "name": "per_page", + "schema": { "$ref": "#/components/schemas/history_components-schemas-per_page" } + }, + { "in": "query", "name": "before", "schema": { "$ref": "#/components/schemas/before" } }, + { + "in": "query", + "name": "page", + "schema": { + "default": 1, + "description": "Page number of paginated results.", + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "since", + "schema": { + "description": "Limit the returned results to history records newer than the specified date. This must be a timestamp that conforms to RFC3339.", + "example": "2022-05-19T20:29:58.679897Z", + "format": "date-time", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/history_components-schemas-response_collection" } + } + }, + "description": "List History response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/history_components-schemas-response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List History response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List History", + "tags": ["Notification History"] + } + }, + "/accounts/{identifier}/alerting/v3/policies": { + "get": { + "description": "Get a list of all Notification policies.", + "operationId": "notification-policies-list-notification-policies", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/policies_components-schemas-response_collection-2" } + } + }, + "description": "List Notification policies response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/policies_components-schemas-response_collection-2" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Notification policies response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Notification policies", + "tags": ["Notification policies"] + }, + "post": { + "description": "Creates a new Notification policy.", + "operationId": "notification-policies-create-a-notification-policy", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "alert_type": { "$ref": "#/components/schemas/alert_type" }, + "description": { "$ref": "#/components/schemas/policies_components-schemas-description" }, + "enabled": { "$ref": "#/components/schemas/policies_components-schemas-enabled" }, + "filters": { "$ref": "#/components/schemas/components-schemas-filters" }, + "mechanisms": { "$ref": "#/components/schemas/mechanisms" }, + "name": { "$ref": "#/components/schemas/policies_components-schemas-name-2" } + }, + "required": ["name", "alert_type", "enabled", "mechanisms"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/policies_components-schemas-id_response-2" } + } + }, + "description": "Create a Notification policy response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/policies_components-schemas-id_response-2" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create a Notification policy response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create a Notification policy", + "tags": ["Notification policies"] + } + }, + "/accounts/{identifier}/alerting/v3/policies/{uuid}": { + "delete": { + "description": "Delete a Notification policy.", + "operationId": "notification-policies-delete-a-notification-policy", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-s0SXln0q" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-collection" } } }, + "description": "Delete a Notification policy response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete a Notification policy response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete a Notification policy", + "tags": ["Notification policies"] + }, + "get": { + "description": "Get details for a single policy.", + "operationId": "notification-policies-get-a-notification-policy", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-s0SXln0q" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/policies_components-schemas-single_response-2" } + } + }, + "description": "Get a Notification policy response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/policies_components-schemas-single_response-2" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get a Notification policy response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a Notification policy", + "tags": ["Notification policies"] + }, + "put": { + "description": "Update a Notification policy.", + "operationId": "notification-policies-update-a-notification-policy", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-s0SXln0q" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "alert_type": { "$ref": "#/components/schemas/alert_type" }, + "description": { "$ref": "#/components/schemas/policies_components-schemas-description" }, + "enabled": { "$ref": "#/components/schemas/policies_components-schemas-enabled" }, + "filters": { "$ref": "#/components/schemas/components-schemas-filters" }, + "mechanisms": { "$ref": "#/components/schemas/mechanisms" }, + "name": { "$ref": "#/components/schemas/policies_components-schemas-name-2" } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/policies_components-schemas-id_response-2" } + } + }, + "description": "Update a Notification policy response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/policies_components-schemas-id_response-2" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update a Notification policy response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update a Notification policy", + "tags": ["Notification policies"] + } + }, + "/accounts/{identifier}/custom_ns": { + "get": { + "description": "List an account's custom nameservers.", + "operationId": "account-level-custom-nameservers-list-account-custom-nameservers", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-oBX6a2Mp" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/acns_response_collection" } } + }, + "description": "List Account Custom Nameservers response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/acns_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Account Custom Nameservers response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Account Custom Nameservers", + "tags": ["Account-Level Custom Nameservers"], + "x-cfPermissionsRequired": { "enum": ["#organization:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + }, + "post": { + "operationId": "account-level-custom-nameservers-add-account-custom-nameserver", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-oBX6a2Mp" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomNSInput" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/acns_response_single" } } }, + "description": "Add Account Custom Nameserver response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/acns_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Add Account Custom Nameserver response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Add Account Custom Nameserver", + "tags": ["Account-Level Custom Nameservers"], + "x-cfPermissionsRequired": { "enum": ["#organization:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{identifier}/custom_ns/availability": { + "get": { + "operationId": "account-level-custom-nameservers-get-eligible-zones-for-account-custom-nameservers", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-oBX6a2Mp" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/availability_response" } } }, + "description": "Get Eligible Zones for Account Custom Nameservers response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/availability_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Eligible Zones for Account Custom Nameservers response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Eligible Zones for Account Custom Nameservers", + "tags": ["Account-Level Custom Nameservers"], + "x-cfPermissionsRequired": { "enum": ["#organization:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{identifier}/custom_ns/verify": { + "post": { + "deprecated": true, + "operationId": "account-level-custom-nameservers-verify-account-custom-nameserver-glue-records", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-oBX6a2Mp" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/acns_response_collection" } } + }, + "description": "Verify Account Custom Nameserver Glue Records response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/acns_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Verify Account Custom Nameserver Glue Records response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Verify Account Custom Nameserver Glue Records", + "tags": ["Account-Level Custom Nameservers"], + "x-cfPermissionsRequired": { "enum": ["#organization:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{identifier}/custom_ns/{ns_name}": { + "delete": { + "operationId": "account-level-custom-nameservers-delete-account-custom-nameserver", + "parameters": [ + { "in": "path", "name": "ns_name", "required": true, "schema": { "$ref": "#/components/schemas/ns_name" } }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-oBX6a2Mp" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/empty_response-V46LqGZw" } } }, + "description": "Delete Account Custom Nameserver response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/empty_response-V46LqGZw" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Account Custom Nameserver response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Account Custom Nameserver", + "tags": ["Account-Level Custom Nameservers"], + "x-cfPermissionsRequired": { "enum": ["#organization:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + } + }, + "/accounts/{identifier}/devices": { + "get": { + "description": "List Enrolled Devices.", + "operationId": "devices-list-devices", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/devices_response" } } }, + "description": "List Devices response." + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/devices_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Devices response failure." + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Devices", + "tags": ["Devices"] + } + }, + "/accounts/{identifier}/devices/dex_tests": { + "get": { + "description": "Fetch all DEX tests.", + "operationId": "device-dex-test-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dex-response_collection" } } }, + "description": "Device DEX test details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/dex-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Device DEX test response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Device DEX tests", + "tags": ["Device DEX Tests"] + }, + "post": { + "description": "Create a DEX test.", + "operationId": "device-dex-test-create-device-dex-test", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/device-dex-test-schemas-http" } } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dex-single_response" } } }, + "description": "Update Dex test response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/dex-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Dex test response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Device DEX test", + "tags": ["Device DEX Tests"] + } + }, + "/accounts/{identifier}/devices/dex_tests/{uuid}": { + "delete": { + "description": "Delete a Device DEX test. Returns the remaining device dex tests for the account.", + "operationId": "device-dex-test-delete-device-dex-test", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + }, + { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid-l20MFQPz" } } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dex-response_collection" } } }, + "description": "Delete Device DEX test response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/dex-response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete DEX test response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Device DEX test", + "tags": ["Device DEX Tests"] + }, + "get": { + "description": "Fetch a single DEX test.", + "operationId": "device-dex-test-get-device-dex-test", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + }, + { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid-l20MFQPz" } } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dex-single_response" } } }, + "description": "Device DEX test details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/dex-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Device DEX test response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Device DEX test", + "tags": ["Device DEX Tests"] + }, + "put": { + "description": "Update a DEX test.", + "operationId": "device-dex-test-update-device-dex-test", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + }, + { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid-l20MFQPz" } } + ], + "requestBody": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/device-dex-test-schemas-http" } } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dex-single_response" } } }, + "description": "Update Dex test response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/dex-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Dex test response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Device DEX test", + "tags": ["Device DEX Tests"] + } + }, + "/accounts/{identifier}/devices/networks": { + "get": { + "description": "List Managed Networks for an account.", + "operationId": "device-managed-networks-list-device-managed-networks", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-response_collection-6gfWBAmq" } + } + }, + "description": "List Device Managed Networks response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-response_collection-6gfWBAmq" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Device Managed Networks response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Device Managed Networks", + "tags": ["Device Managed Networks"] + }, + "post": { + "description": "Create a new Device Managed Network.", + "operationId": "device-managed-networks-create-device-managed-network", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "config": { "$ref": "#/components/schemas/schemas-config_request" }, + "name": { "$ref": "#/components/schemas/device-managed-networks_components-schemas-name" }, + "type": { "$ref": "#/components/schemas/components-schemas-type-KlrF1JPW" } + }, + "required": ["name", "type", "config"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-single_response-ar7Y7q7I" } + } + }, + "description": "Create Device Managed Network response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-single_response-ar7Y7q7I" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Device Managed Network response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Device Managed Network", + "tags": ["Device Managed Networks"] + } + }, + "/accounts/{identifier}/devices/networks/{uuid}": { + "delete": { + "description": "Delete a Device Managed Network. Returns the remaining Device Managed Networks for the account.", + "operationId": "device-managed-networks-delete-device-managed-network", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-l20MFQPz" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-response_collection-6gfWBAmq" } + } + }, + "description": "Delete Device Managed Network response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-response_collection-6gfWBAmq" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Device Managed Network response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Device Managed Network", + "tags": ["Device Managed Networks"] + }, + "get": { + "description": "Fetch a single Managed Network.", + "operationId": "device-managed-networks-device-managed-network-details", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-l20MFQPz" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-single_response-ar7Y7q7I" } + } + }, + "description": "Device Managed Network Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-single_response-ar7Y7q7I" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Device Managed Network Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Device Managed Network Details", + "tags": ["Device Managed Networks"] + }, + "put": { + "description": "Update a Device Managed Network.", + "operationId": "device-managed-networks-update-device-managed-network", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-l20MFQPz" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "config": { "$ref": "#/components/schemas/schemas-config_request" }, + "name": { "$ref": "#/components/schemas/device-managed-networks_components-schemas-name" }, + "type": { "$ref": "#/components/schemas/components-schemas-type-KlrF1JPW" } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-single_response-ar7Y7q7I" } + } + }, + "description": "Update Device Managed Network response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-single_response-ar7Y7q7I" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Device Managed Network response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Device Managed Network", + "tags": ["Device Managed Networks"] + } + }, + "/accounts/{identifier}/devices/policies": { + "get": { + "description": "Lists the device settings policies for an account.", + "operationId": "devices-list-device-settings-policies", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/device_settings_response_collection" } } + }, + "description": "List Device Settings Policies response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/device_settings_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Device Settings Policies response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Device Settings Policies", + "tags": ["Devices"] + } + }, + "/accounts/{identifier}/devices/policy": { + "get": { + "description": "Get the default device settings policy for an account.", + "operationId": "devices-get-default-device-settings-policy", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/default_device_settings_response" } } + }, + "description": "Get Default Device Settings Policy response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/default_device_settings_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Default Device Settings Policy response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Default Device Settings Policy", + "tags": ["Devices"] + }, + "patch": { + "description": "Update the default device settings policy for an account.", + "operationId": "devices-update-default-device-settings-policy", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "allow_mode_switch": { "$ref": "#/components/schemas/allow_mode_switch" }, + "allow_updates": { "$ref": "#/components/schemas/allow_updates" }, + "allowed_to_leave": { "$ref": "#/components/schemas/allowed_to_leave" }, + "auto_connect": { "$ref": "#/components/schemas/auto_connect" }, + "captive_portal": { "$ref": "#/components/schemas/captive_portal" }, + "disable_auto_fallback": { "$ref": "#/components/schemas/disable_auto_fallback" }, + "exclude_office_ips": { "$ref": "#/components/schemas/exclude_office_ips" }, + "service_mode_v2": { "$ref": "#/components/schemas/service_mode_v2" }, + "support_url": { "$ref": "#/components/schemas/support_url" }, + "switch_locked": { "$ref": "#/components/schemas/switch_locked" } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/default_device_settings_response" } } + }, + "description": "Update Default Device Settings Policy response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/default_device_settings_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Default Device Settings Policy response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Default Device Settings Policy", + "tags": ["Devices"] + }, + "post": { + "description": "Create a device settings policy to be applied to certain devices matching the criteria.", + "operationId": "devices-create-device-settings-policy", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "allow_mode_switch": { "$ref": "#/components/schemas/allow_mode_switch" }, + "allow_updates": { "$ref": "#/components/schemas/allow_updates" }, + "allowed_to_leave": { "$ref": "#/components/schemas/allowed_to_leave" }, + "auto_connect": { "$ref": "#/components/schemas/auto_connect" }, + "captive_portal": { "$ref": "#/components/schemas/captive_portal" }, + "description": { "$ref": "#/components/schemas/schemas-description-jdg4o19i" }, + "disable_auto_fallback": { "$ref": "#/components/schemas/disable_auto_fallback" }, + "enabled": { + "description": "Whether the policy will be applied to matching devices.", + "example": true, + "type": "boolean" + }, + "exclude_office_ips": { "$ref": "#/components/schemas/exclude_office_ips" }, + "match": { "$ref": "#/components/schemas/schemas-match-ImQchlrH" }, + "name": { + "description": "The name of the device settings policy.", + "example": "Allow Developers", + "maxLength": 100, + "type": "string" + }, + "precedence": { "$ref": "#/components/schemas/precedence-HZLvpi3q" }, + "service_mode_v2": { "$ref": "#/components/schemas/service_mode_v2" }, + "support_url": { "$ref": "#/components/schemas/support_url" }, + "switch_locked": { "$ref": "#/components/schemas/switch_locked" } + }, + "required": ["name", "precedence", "match"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/device_settings_response" } } + }, + "description": "Create Device Settings Policy response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/device_settings_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Device Settings Policy response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Device Settings Policy", + "tags": ["Devices"] + } + }, + "/accounts/{identifier}/devices/policy/exclude": { + "get": { + "description": "Get the list of routes excluded from the WARP client's tunnel.", + "operationId": "devices-get-split-tunnel-exclude-list", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/split_tunnel_response_collection" } } + }, + "description": "Get Split Tunnel Exclude List response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/split_tunnel_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Split Tunnel Exclude List response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Split Tunnel Exclude List", + "tags": ["Devices"] + }, + "put": { + "description": "Set the list of routes excluded from the WARP client's tunnel.", + "operationId": "devices-set-split-tunnel-exclude-list", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { "items": { "$ref": "#/components/schemas/split_tunnel" }, "type": "array" } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/split_tunnel_response_collection" } } + }, + "description": "Set Split Tunnel Exclude List response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/split_tunnel_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Set Split Tunnel Exclude List response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Set Split Tunnel Exclude List", + "tags": ["Devices"] + } + }, + "/accounts/{identifier}/devices/policy/fallback_domains": { + "get": { + "description": "Get the list of domains to bypass Gateway for DNS resolution and instead use the specified server.", + "operationId": "devices-get-local-domain-fallback-list", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/fallback_domain_response_collection" } } + }, + "description": "Get Local Domain Fallback List response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/fallback_domain_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Local Domain Fallback List response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Local Domain Fallback List", + "tags": ["Devices"] + }, + "put": { + "description": "Set the list of domains to bypass Gateway for DNS resolution and instead use the specified server.", + "operationId": "devices-set-local-domain-fallback-list", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { "items": { "$ref": "#/components/schemas/fallback_domain" }, "type": "array" } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/fallback_domain_response_collection" } } + }, + "description": "Set Local Domain Fallback List response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/fallback_domain_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Set Local Domain Fallback List response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Set Local Domain Fallback List", + "tags": ["Devices"] + } + }, + "/accounts/{identifier}/devices/policy/include": { + "get": { + "description": "Get the list of routes included in the WARP client's tunnel.", + "operationId": "devices-get-split-tunnel-include-list", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/split_tunnel_include_response_collection" } + } + }, + "description": "Get Split Tunnel Include List response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/split_tunnel_include_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Split Tunnel Include List response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Split Tunnel Include List", + "tags": ["Devices"] + }, + "put": { + "description": "Set the list of routes included in the WARP client's tunnel.", + "operationId": "devices-set-split-tunnel-include-list", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { "items": { "$ref": "#/components/schemas/split_tunnel_include" }, "type": "array" } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/split_tunnel_include_response_collection" } + } + }, + "description": "Set Split Tunnel Include List response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/split_tunnel_include_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Set Split Tunnel Include List response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Set Split Tunnel Include List", + "tags": ["Devices"] + } + }, + "/accounts/{identifier}/devices/policy/{uuid}": { + "delete": { + "description": "Delete a device settings policy. Returns the remaining policies for the account.", + "operationId": "devices-delete-device-settings-policy", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-uuid-lt6l49Ob" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/device_settings_response_collection" } } + }, + "description": "Delete Device Settings Policy response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/device_settings_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Device Settings Policy response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Device Settings Policy", + "tags": ["Devices"] + }, + "get": { + "description": "Get the device settings policy by ID.", + "operationId": "devices-get-device-settings-policy-by-id", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-uuid-lt6l49Ob" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/device_settings_response" } } + }, + "description": "Get Device Settings Policy by ID response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/device_settings_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Device Settings Policy by ID response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Device Settings Policy by ID", + "tags": ["Devices"] + }, + "patch": { + "description": "Update a device settings policy.", + "operationId": "devices-update-device-settings-policy", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-uuid-lt6l49Ob" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "allow_mode_switch": { "$ref": "#/components/schemas/allow_mode_switch" }, + "allow_updates": { "$ref": "#/components/schemas/allow_updates" }, + "allowed_to_leave": { "$ref": "#/components/schemas/allowed_to_leave" }, + "auto_connect": { "$ref": "#/components/schemas/auto_connect" }, + "captive_portal": { "$ref": "#/components/schemas/captive_portal" }, + "description": { "$ref": "#/components/schemas/schemas-description-jdg4o19i" }, + "disable_auto_fallback": { "$ref": "#/components/schemas/disable_auto_fallback" }, + "enabled": { + "description": "Whether the policy will be applied to matching devices.", + "example": true, + "type": "boolean" + }, + "exclude_office_ips": { "$ref": "#/components/schemas/exclude_office_ips" }, + "match": { "$ref": "#/components/schemas/schemas-match-ImQchlrH" }, + "name": { + "description": "The name of the device settings policy.", + "example": "Allow Developers", + "maxLength": 100, + "type": "string" + }, + "precedence": { "$ref": "#/components/schemas/precedence-HZLvpi3q" }, + "service_mode_v2": { "$ref": "#/components/schemas/service_mode_v2" }, + "support_url": { "$ref": "#/components/schemas/support_url" }, + "switch_locked": { "$ref": "#/components/schemas/switch_locked" } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/device_settings_response" } } + }, + "description": "Update Device Settings Policy response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/device_settings_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Device Settings Policy response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Device Settings Policy", + "tags": ["Devices"] + } + }, + "/accounts/{identifier}/devices/policy/{uuid}/exclude": { + "get": { + "description": "Get the list of routes excluded from the WARP client's tunnel for one specific device settings policy.", + "operationId": "devices-get-split-tunnel-exclude-list-for-a-device-settings-policy", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-uuid-lt6l49Ob" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/split_tunnel_response_collection" } } + }, + "description": "Get Split Tunnel Exclude List for a Device Settings Policy response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/split_tunnel_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Split Tunnel Exclude List for a Device Settings Policy response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Split Tunnel Exclude List for a Device Settings Policy", + "tags": ["Devices"] + }, + "put": { + "description": "Set the list of routes excluded from the WARP client's tunnel for one specific device settings policy.", + "operationId": "devices-set-split-tunnel-exclude-list-for-a-device-settings-policy", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-uuid-lt6l49Ob" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { "items": { "$ref": "#/components/schemas/split_tunnel" }, "type": "array" } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/split_tunnel_response_collection" } } + }, + "description": "Set Split Tunnel Exclude List for a Device Settings Policy response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/split_tunnel_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Set Split Tunnel Exclude List for a Device Settings Policy response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Set Split Tunnel Exclude List for a Device Settings Policy", + "tags": ["Devices"] + } + }, + "/accounts/{identifier}/devices/policy/{uuid}/fallback_domains": { + "get": { + "description": "Get the list of domains to bypass Gateway for DNS resolution and instead use the specified server.", + "operationId": "devices-get-local-domain-fallback-list-for-a-device-settings-policy", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-uuid-lt6l49Ob" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/fallback_domain_response_collection" } } + }, + "description": "Get Local Domain Fallback List for a Device Settings Policy response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/fallback_domain_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Local Domain Fallback List for a Device Settings Policy response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Local Domain Fallback List for a Device Settings Policy", + "tags": ["Devices"] + }, + "put": { + "description": "Set the list of domains to bypass Gateway for DNS resolution and instead use the specified server.", + "operationId": "devices-set-local-domain-fallback-list-for-a-device-settings-policy", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-uuid-lt6l49Ob" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { "items": { "$ref": "#/components/schemas/fallback_domain" }, "type": "array" } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/fallback_domain_response_collection" } } + }, + "description": "Set Local Domain Fallback List for a Device Settings Policy response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/fallback_domain_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Set Local Domain Fallback List for a Device Settings Policy response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Set Local Domain Fallback List for a Device Settings Policy", + "tags": ["Devices"] + } + }, + "/accounts/{identifier}/devices/policy/{uuid}/include": { + "get": { + "description": "Get the list of routes included in the WARP client's tunnel for one specific device settings policy.", + "operationId": "devices-get-split-tunnel-include-list-for-a-device-settings-policy", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-uuid-lt6l49Ob" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/split_tunnel_include_response_collection" } + } + }, + "description": "Get Split Tunnel Include List for a Device Settings Policy response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/split_tunnel_include_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Split Tunnel Include List for a Device Settings Policy response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Split Tunnel Include List for a Device Settings Policy", + "tags": ["Devices"] + }, + "put": { + "description": "Set the list of routes included in the WARP client's tunnel for one specific device settings policy.", + "operationId": "devices-set-split-tunnel-include-list-for-a-device-settings-policy", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-uuid-lt6l49Ob" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { "items": { "$ref": "#/components/schemas/split_tunnel_include" }, "type": "array" } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/split_tunnel_include_response_collection" } + } + }, + "description": "Set Split Tunnel Include List for a Device Settings Policy response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/split_tunnel_include_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Set Split Tunnel Include List for a Device Settings Policy response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Set Split Tunnel Include List for a Device Settings Policy", + "tags": ["Devices"] + } + }, + "/accounts/{identifier}/devices/posture": { + "get": { + "description": "List Device Posture Rules for an account.", + "operationId": "device-posture-rules-list-device-posture-rules", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/response_collection-Oi5s0tkV" } } + }, + "description": "List Device Posture Rules response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/response_collection-Oi5s0tkV" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Device Posture Rules response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Device Posture Rules", + "tags": ["Device Posture Rules"] + }, + "post": { + "description": "Create a new Device Posture Rule.", + "operationId": "device-posture-rules-create-device-posture-rule", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "description": { "$ref": "#/components/schemas/description-HWZDzyev" }, + "expiration": { "$ref": "#/components/schemas/expiration-9DsFtGHX" }, + "input": { "$ref": "#/components/schemas/input-NaZjecAw" }, + "match": { "$ref": "#/components/schemas/match-gWGZ7MOw" }, + "name": { "$ref": "#/components/schemas/name-wyyCMADI" }, + "schedule": { "$ref": "#/components/schemas/schedule-kOC57cA0" }, + "type": { "$ref": "#/components/schemas/type-tb4QXpPC" } + }, + "required": ["name", "type"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response-UJHycgfI" } } + }, + "description": "Create Device Posture Rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response-UJHycgfI" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Device Posture Rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Device Posture Rule", + "tags": ["Device Posture Rules"] + } + }, + "/accounts/{identifier}/devices/posture/integration": { + "get": { + "description": "List Device Posture Integrations for an account.", + "operationId": "device-posture-integrations-list-device-posture-integrations", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-response_collection-CSlm0TuB" } } + }, + "description": "List Device Posture Integrations response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-response_collection-CSlm0TuB" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Device Posture Integrations response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Device Posture Integrations", + "tags": ["Device Posture Integrations"] + }, + "post": { + "description": "Create a new Device Posture Integration.", + "operationId": "device-posture-integrations-create-device-posture-integration", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "config": { "$ref": "#/components/schemas/config_request-dR6XwB2B" }, + "interval": { "$ref": "#/components/schemas/interval-FAyugCvL" }, + "name": { "$ref": "#/components/schemas/components-schemas-name-4QGVxQIe" }, + "type": { "$ref": "#/components/schemas/schemas-type-BQBcyQpN" } + }, + "required": ["name", "type", "interval", "config"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-single_response-aU3syxnr" } } + }, + "description": "Create Device Posture Integration response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-single_response-aU3syxnr" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Device Posture Integration response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Device Posture Integration", + "tags": ["Device Posture Integrations"] + } + }, + "/accounts/{identifier}/devices/posture/integration/{uuid}": { + "delete": { + "description": "Delete a Device Posture Integration.", + "operationId": "device-posture-integrations-delete-device-posture-integration", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-l20MFQPz" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-id_response-ZaI3kQGy" } } + }, + "description": "Delete Device Posture Integration response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-id_response-ZaI3kQGy" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Device Posture Integration response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Device Posture Integration", + "tags": ["Device Posture Integrations"] + }, + "get": { + "description": "Fetch a single Device Posture Integration.", + "operationId": "device-posture-integrations-device-posture-integration-details", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-l20MFQPz" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-single_response-aU3syxnr" } } + }, + "description": "Device Posture Integration Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-single_response-aU3syxnr" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Device Posture Integration Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Device Posture Integration Details", + "tags": ["Device Posture Integrations"] + }, + "patch": { + "description": "Update a Device Posture Integration.", + "operationId": "device-posture-integrations-update-device-posture-integration", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-l20MFQPz" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "config": { "$ref": "#/components/schemas/config_request-dR6XwB2B" }, + "interval": { "$ref": "#/components/schemas/interval-FAyugCvL" }, + "name": { "$ref": "#/components/schemas/components-schemas-name-4QGVxQIe" }, + "type": { "$ref": "#/components/schemas/schemas-type-BQBcyQpN" } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-single_response-aU3syxnr" } } + }, + "description": "Update Device Posture Integration response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-single_response-aU3syxnr" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Device Posture Integration response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Device Posture Integration", + "tags": ["Device Posture Integrations"] + } + }, + "/accounts/{identifier}/devices/posture/{uuid}": { + "delete": { + "description": "Delete a Device Posture Rule.", + "operationId": "device-posture-rules-delete-device-posture-rule", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-l20MFQPz" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/id_response-eHg5OKOR" } } }, + "description": "Delete Device Posture Rule response." + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/id_response-eHg5OKOR" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Device Posture Rule response failure." + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Device Posture Rule", + "tags": ["Device Posture Rules"] + }, + "get": { + "description": "Fetch a single Device Posture Rule.", + "operationId": "device-posture-rules-device-posture-rules-details", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-l20MFQPz" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response-UJHycgfI" } } + }, + "description": "Device Posture Rules Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response-UJHycgfI" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Device Posture Rules Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Device Posture Rules Details", + "tags": ["Device Posture Rules"] + }, + "put": { + "description": "Update a Device Posture Rule.", + "operationId": "device-posture-rules-update-device-posture-rule", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-l20MFQPz" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "description": { "$ref": "#/components/schemas/description-HWZDzyev" }, + "expiration": { "$ref": "#/components/schemas/expiration-9DsFtGHX" }, + "input": { "$ref": "#/components/schemas/input-NaZjecAw" }, + "match": { "$ref": "#/components/schemas/match-gWGZ7MOw" }, + "name": { "$ref": "#/components/schemas/name-wyyCMADI" }, + "schedule": { "$ref": "#/components/schemas/schedule-kOC57cA0" }, + "type": { "$ref": "#/components/schemas/type-tb4QXpPC" } + }, + "required": ["name", "type"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response-UJHycgfI" } } + }, + "description": "Update Device Posture Rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response-UJHycgfI" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Device Posture Rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Device Posture Rule", + "tags": ["Device Posture Rules"] + } + }, + "/accounts/{identifier}/devices/revoke": { + "post": { + "description": "Revoke a list of devices.", + "operationId": "devices-revoke-devices", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/revoke_devices_request-zLb49AXe" } } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single" } } }, + "description": "Revoke Devices response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Revoke Devices response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Revoke Devices", + "tags": ["Devices"] + } + }, + "/accounts/{identifier}/devices/settings": { + "get": { + "description": "Describes the current device settings Zero Trust account.", + "operationId": "zero-trust-accounts-get-device-settings-for-zero-trust-account", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/gateway-account-device-settings-response" } + } + }, + "description": "Get device settings for Zero Trust account response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/gateway-account-device-settings-response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get device settings for Zero Trust account response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get device settings for Zero Trust account", + "tags": ["Zero Trust accounts"] + }, + "put": { + "description": "Updates the current device settings for Zero Trust account.", + "operationId": "zero-trust-accounts-update-device-settings-for-the-zero-trust-account", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/gateway-account-device-settings" } } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/gateway-account-device-settings-response" } + } + }, + "description": "Update device settings for the Zero Trust account response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/gateway-account-device-settings-response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update device settings for the Zero Trust account response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update device settings for the Zero Trust account", + "tags": ["Zero Trust accounts"] + } + }, + "/accounts/{identifier}/devices/unrevoke": { + "post": { + "description": "Unrevoke a list of devices.", + "operationId": "devices-unrevoke-devices", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/unrevoke_devices_request-bkyFobOE" } } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single" } } }, + "description": "Unrevoke Devices response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Unrevoke Devices response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Unrevoke Devices", + "tags": ["Devices"] + } + }, + "/accounts/{identifier}/devices/{uuid}": { + "get": { + "description": "Fetch a single Device.", + "operationId": "devices-device-details", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-uuid-lt6l49Ob" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/device_response" } } }, + "description": "Device Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/device_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Device Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Device Details", + "tags": ["Devices"] + } + }, + "/accounts/{identifier}/devices/{uuid}/override_codes": { + "get": { + "description": "Fetch one-time use admin override code for a device. This relies on the Admin Override setting being enabled in your device configuration.", + "operationId": "devices-list-admin-override-code-for-device", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-uuid-lt6l49Ob" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/override_codes_response" } } }, + "description": "List Admin Override code for device response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/override_codes_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Admin Override code for device response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Admin Override code for device", + "tags": ["Devices"] + } + }, + "/accounts/{identifier}/gateway": { + "get": { + "description": "Get Zero Trust account information.", + "operationId": "zero-trust-accounts-get-zero-trust-account-information", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gateway_account" } } }, + "description": "Get Zero Trust account information response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/gateway_account" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Zero Trust account information response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Zero Trust account information", + "tags": ["Zero Trust accounts"] + }, + "post": { + "description": "Create Zero Trust account with existing cloudflare account.", + "operationId": "zero-trust-accounts-create-zero-trust-account", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "account_id": { "$ref": "#/components/schemas/cf_account_id" } }, + "required": ["account_id"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gateway_account" } } }, + "description": "Create Zero Trust account response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/gateway_account" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Zero Trust account response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Zero Trust account", + "tags": ["Zero Trust accounts"] + } + }, + "/accounts/{identifier}/gateway/app_types": { + "get": { + "description": "List all Application and Application Type mappings.", + "operationId": "zero-trust-gateway-application-and-application-type-mappings-list-application-and-application-type-mappings", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/app-types_components-schemas-response_collection" } + } + }, + "description": "List Application and Application Type mappings response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/app-types_components-schemas-response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Application and Application Type mappings response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Application and Application Type mappings", + "tags": ["Zero Trust Gateway Application and Application Type mappings"] + } + }, + "/accounts/{identifier}/gateway/configuration": { + "get": { + "description": "Describes current Zero Trust account configuration.", + "operationId": "zero-trust-accounts-get-zero-trust-account-configuration", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gateway_account_config" } } }, + "description": "Get Zero Trust account configuration response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/gateway_account_config" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Zero Trust account configuration response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Zero Trust account configuration", + "tags": ["Zero Trust accounts"] + }, + "patch": { + "description": "Patches the current Zero Trust account configuration. This end point helps you to update single sub collection of settings like antivirus, tls_decrypt, activity_log, block_page, browser_isolation, fips, body_scanning or custom_certificate, without updating the whole configuration object. Returns error if a single collection of setting is not properly configured.", + "operationId": "zero-trust-accounts-patch-zero-trust-account-configuration", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gateway-account-settings" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gateway_account_config" } } }, + "description": "Update Zero Trust account configuration response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/gateway_account_config" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Zero Trust account configuration response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Patch Zero Trust account configuration", + "tags": ["Zero Trust accounts"] + }, + "put": { + "description": "Updates the current Zero Trust account configuration.", + "operationId": "zero-trust-accounts-update-zero-trust-account-configuration", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gateway-account-settings" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/gateway_account_config" } } }, + "description": "Update Zero Trust account configuration response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/gateway_account_config" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Zero Trust account configuration response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Zero Trust account configuration", + "tags": ["Zero Trust accounts"] + } + }, + "/accounts/{identifier}/gateway/lists": { + "get": { + "description": "List Zero Trust Lists for an account.", + "operationId": "zero-trust-lists-list-zero-trust-lists", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_collection" } } }, + "description": "List Zero Trust Lists response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Zero Trust Lists response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Zero Trust Lists", + "tags": ["Zero Trust Lists"] + }, + "post": { + "description": "Create a new Zero Trust List.", + "operationId": "zero-trust-lists-create-zero-trust-list", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "description": { "$ref": "#/components/schemas/description" }, + "items": { "$ref": "#/components/schemas/items" }, + "name": { "$ref": "#/components/schemas/name" }, + "type": { "$ref": "#/components/schemas/type" } + }, + "required": ["name", "type"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response_with_list_items" } } + }, + "description": "Create Zero Trust List response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response_with_list_items" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Zero Trust List response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Zero Trust List", + "tags": ["Zero Trust Lists"] + } + }, + "/accounts/{identifier}/gateway/lists/{uuid}": { + "delete": { + "description": "Delete a Zero Trust List.", + "operationId": "zero-trust-lists-delete-zero-trust-list", + "parameters": [ + { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/empty_response" } } }, + "description": "Delete Zero Trust List response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/empty_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Zero Trust List response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Zero Trust List", + "tags": ["Zero Trust Lists"] + }, + "get": { + "description": "Fetch a single Zero Trust List.", + "operationId": "zero-trust-lists-zero-trust-list-details", + "parameters": [ + { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/single_response" } } }, + "description": "Zero Trust List Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Zero Trust List Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Zero Trust List Details", + "tags": ["Zero Trust Lists"] + }, + "patch": { + "description": "Append or remove an item from a configured Zero Trust List.", + "operationId": "zero-trust-lists-patch-zero-trust-list", + "parameters": [ + { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "append": { "$ref": "#/components/schemas/items" }, + "remove": { + "description": "A list of the item values you want to remove.", + "items": { "$ref": "#/components/schemas/value" }, + "type": "array" + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/single_response" } } }, + "description": "Patch Zero Trust List response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Patch Zero Trust List response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Patch Zero Trust List", + "tags": ["Zero Trust Lists"] + }, + "put": { + "description": "Update a configured Zero Trust List.", + "operationId": "zero-trust-lists-update-zero-trust-list", + "parameters": [ + { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "description": { "$ref": "#/components/schemas/description" }, + "name": { "$ref": "#/components/schemas/name" } + }, + "required": ["name"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/single_response" } } }, + "description": "Update Zero Trust List response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Zero Trust List response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Zero Trust List", + "tags": ["Zero Trust Lists"] + } + }, + "/accounts/{identifier}/gateway/lists/{uuid}/items": { + "get": { + "description": "Fetch all items of a single Zero Trust List.", + "operationId": "zero-trust-lists-zero-trust-list-items", + "parameters": [ + { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/list_item_response_collection" } } + }, + "description": "Zero Trust List Items response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/list_item_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Zero Trust List Items response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Zero Trust List Items", + "tags": ["Zero Trust Lists"] + } + }, + "/accounts/{identifier}/gateway/locations": { + "get": { + "description": "List Zero Trust Gateway Locations for an account.", + "operationId": "zero-trust-gateway-locations-list-zero-trust-gateway-locations", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-response_collection" } } + }, + "description": "List Zero Trust Gateway Locations response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Zero Trust Gateway Locations response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Zero Trust Gateway Locations", + "tags": ["Zero Trust Gateway Locations"] + }, + "post": { + "description": "Create a new Zero Trust Gateway Location.", + "operationId": "zero-trust-gateway-locations-create-zero-trust-gateway-location", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "client_default": { "$ref": "#/components/schemas/client-default" }, + "ecs_support": { "$ref": "#/components/schemas/ecs-support" }, + "name": { "$ref": "#/components/schemas/schemas-name" }, + "networks": { "$ref": "#/components/schemas/network" } + }, + "required": ["name"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-single_response" } } }, + "description": "Create Zero Trust Gateway Location response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Zero Trust Gateway Location response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Zero Trust Gateway Location", + "tags": ["Zero Trust Gateway Locations"] + } + }, + "/accounts/{identifier}/gateway/locations/{uuid}": { + "delete": { + "description": "Delete a Zero Trust Gateway Location.", + "operationId": "zero-trust-gateway-locations-delete-zero-trust-gateway-location", + "parameters": [ + { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/schemas-uuid" } }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/empty_response" } } }, + "description": "Delete Zero Trust Gateway Location response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/empty_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Zero Trust Gateway Location response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Zero Trust Gateway Location", + "tags": ["Zero Trust Gateway Locations"] + }, + "get": { + "description": "Fetch a single Zero Trust Gateway Location.", + "operationId": "zero-trust-gateway-locations-zero-trust-gateway-location-details", + "parameters": [ + { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/schemas-uuid" } }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-single_response" } } }, + "description": "Zero Trust Gateway Location Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Zero Trust Gateway Location Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Zero Trust Gateway Location Details", + "tags": ["Zero Trust Gateway Locations"] + }, + "put": { + "description": "Update a configured Zero Trust Gateway Location.", + "operationId": "zero-trust-gateway-locations-update-zero-trust-gateway-location", + "parameters": [ + { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/schemas-uuid" } }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "client_default": { "$ref": "#/components/schemas/client-default" }, + "ecs_support": { "$ref": "#/components/schemas/ecs-support" }, + "name": { "$ref": "#/components/schemas/schemas-name" }, + "networks": { "$ref": "#/components/schemas/network" } + }, + "required": ["name"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-single_response" } } }, + "description": "Update Zero Trust Gateway Location response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Zero Trust Gateway Location response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Zero Trust Gateway Location", + "tags": ["Zero Trust Gateway Locations"] + } + }, + "/accounts/{identifier}/gateway/logging": { + "get": { + "description": "Describes the current logging settings for Zero Trust account.", + "operationId": "zero-trust-accounts-get-logging-settings-for-the-zero-trust-account", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/gateway-account-logging-settings-response" } + } + }, + "description": "Get logging settings for the Zero Trust account response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/gateway-account-logging-settings-response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get logging settings for the Zero Trust account response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get logging settings for the Zero Trust account", + "tags": ["Zero Trust accounts"] + }, + "put": { + "description": "Updates the current logging settings for the Zero Trust accounty.", + "operationId": "zero-trust-accounts-update-logging-settings-for-the-zero-trust-account", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/gateway-account-logging-settings" } } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/gateway-account-logging-settings-response" } + } + }, + "description": "Update logging settings for the Zero Trust account response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/gateway-account-logging-settings-response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update logging settings for the Zero Trust account response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update logging settings for the Zero Trust account", + "tags": ["Zero Trust accounts"] + } + }, + "/accounts/{identifier}/gateway/proxy_endpoints": { + "get": { + "description": "Fetch a single Zero Trust Gateway Proxy Endpoint.", + "operationId": "zero-trust-gateway-proxy-endpoints-list-proxy-endpoints", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/proxy-endpoints_components-schemas-response_collection" } + } + }, + "description": "List Proxy Endpoints response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/proxy-endpoints_components-schemas-response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Proxy Endpoints response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Proxy Endpoints", + "tags": ["Zero Trust Gateway Proxy Endpoints"] + }, + "post": { + "description": "Create a new Zero Trust Gateway Proxy Endpoint.", + "operationId": "zero-trust-gateway-proxy-endpoints-create-proxy-endpoint", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "ips": { "$ref": "#/components/schemas/ips" }, + "name": { "$ref": "#/components/schemas/proxy-endpoints_components-schemas-name" }, + "subdomain": { "$ref": "#/components/schemas/schemas-subdomain" } + }, + "required": ["name", "ips"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/proxy-endpoints_components-schemas-single_response" } + } + }, + "description": "Create Proxy Endpoint response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/proxy-endpoints_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Proxy Endpoint response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Proxy Endpoint", + "tags": ["Zero Trust Gateway Proxy Endpoints"] + } + }, + "/accounts/{identifier}/gateway/proxy_endpoints/{uuid}": { + "delete": { + "description": "Delete a Zero Trust Gateway Proxy Endpoint.", + "operationId": "zero-trust-gateway-proxy-endpoints-delete-proxy-endpoint", + "parameters": [ + { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/schemas-uuid" } }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/empty_response" } } }, + "description": "Delete Proxy Endpoint response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/empty_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Proxy Endpoint response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Proxy Endpoint", + "tags": ["Zero Trust Gateway Proxy Endpoints"] + }, + "get": { + "description": "List Zero Trust Gateway Proxy Endpoints for an account.", + "operationId": "zero-trust-gateway-proxy-endpoints-proxy-endpoint-details", + "parameters": [ + { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/schemas-uuid" } }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/proxy-endpoints_components-schemas-single_response" } + } + }, + "description": "Proxy Endpoint Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/proxy-endpoints_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Proxy Endpoint Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Proxy Endpoint Details", + "tags": ["Zero Trust Gateway Proxy Endpoints"] + }, + "patch": { + "description": "Update a new Zero Trust Gateway Proxy Endpoint.", + "operationId": "zero-trust-gateway-proxy-endpoints-update-proxy-endpoint", + "parameters": [ + { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/schemas-uuid" } }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "ips": { "$ref": "#/components/schemas/ips" }, + "name": { "$ref": "#/components/schemas/proxy-endpoints_components-schemas-name" }, + "subdomain": { "$ref": "#/components/schemas/schemas-subdomain" } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/proxy-endpoints_components-schemas-single_response" } + } + }, + "description": "Update Proxy Endpoint response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/proxy-endpoints_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Proxy Endpoint response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Proxy Endpoint", + "tags": ["Zero Trust Gateway Proxy Endpoints"] + } + }, + "/accounts/{identifier}/gateway/rules": { + "get": { + "description": "List Zero Trust Gateway Rules for an account.", + "operationId": "zero-trust-gateway-rules-list-zero-trust-gateway-rules", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-response_collection" } + } + }, + "description": "List Zero Trust Gateway Rules response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Zero Trust Gateway Rules response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Zero Trust Gateway Rules", + "tags": ["Zero Trust Gateway Rules"] + }, + "post": { + "description": "Create a new Zero Trust Gateway Rule.", + "operationId": "zero-trust-gateway-rules-create-zero-trust-gateway-rule", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "action": { "$ref": "#/components/schemas/action" }, + "description": { "$ref": "#/components/schemas/schemas-description" }, + "device_posture": { "$ref": "#/components/schemas/device_posture" }, + "enabled": { "$ref": "#/components/schemas/enabled" }, + "filters": { "$ref": "#/components/schemas/filters" }, + "identity": { "$ref": "#/components/schemas/identity" }, + "name": { "$ref": "#/components/schemas/components-schemas-name" }, + "precedence": { "$ref": "#/components/schemas/precedence" }, + "rule_settings": { "$ref": "#/components/schemas/rule-settings" }, + "schedule": { "$ref": "#/components/schemas/schedule" }, + "traffic": { "$ref": "#/components/schemas/traffic" } + }, + "required": ["name", "action"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/components-schemas-single_response" } } + }, + "description": "Create Zero Trust Gateway Rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Zero Trust Gateway Rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Zero Trust Gateway Rule", + "tags": ["Zero Trust Gateway Rules"] + } + }, + "/accounts/{identifier}/gateway/rules/{uuid}": { + "delete": { + "description": "Delete a Zero Trust Gateway Rule.", + "operationId": "zero-trust-gateway-rules-delete-zero-trust-gateway-rule", + "parameters": [ + { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/empty_response" } } }, + "description": "Delete Zero Trust Gateway Rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/empty_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Zero Trust Gateway Rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Zero Trust Gateway Rule", + "tags": ["Zero Trust Gateway Rules"] + }, + "get": { + "description": "Fetch a single Zero Trust Gateway Rule.", + "operationId": "zero-trust-gateway-rules-zero-trust-gateway-rule-details", + "parameters": [ + { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/components-schemas-single_response" } } + }, + "description": "Zero Trust Gateway Rule Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Zero Trust Gateway Rule Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Zero Trust Gateway Rule Details", + "tags": ["Zero Trust Gateway Rules"] + }, + "put": { + "description": "Update a configured Zero Trust Gateway Rule.", + "operationId": "zero-trust-gateway-rules-update-zero-trust-gateway-rule", + "parameters": [ + { "in": "path", "name": "uuid", "required": true, "schema": { "$ref": "#/components/schemas/uuid" } }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "action": { "$ref": "#/components/schemas/action" }, + "description": { "$ref": "#/components/schemas/schemas-description" }, + "device_posture": { "$ref": "#/components/schemas/device_posture" }, + "enabled": { "$ref": "#/components/schemas/enabled" }, + "filters": { "$ref": "#/components/schemas/filters" }, + "identity": { "$ref": "#/components/schemas/identity" }, + "name": { "$ref": "#/components/schemas/components-schemas-name" }, + "precedence": { "$ref": "#/components/schemas/precedence" }, + "rule_settings": { "$ref": "#/components/schemas/rule-settings" }, + "schedule": { "$ref": "#/components/schemas/schedule" }, + "traffic": { "$ref": "#/components/schemas/traffic" } + }, + "required": ["name", "action"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/components-schemas-single_response" } } + }, + "description": "Update Zero Trust Gateway Rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Zero Trust Gateway Rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Zero Trust Gateway Rule", + "tags": ["Zero Trust Gateway Rules"] + } + }, + "/certificates": { + "get": { + "description": "List all existing Origin CA certificates for a given zone. Use your Origin CA Key as your User Service Key when calling this endpoint ([see above](#requests)).", + "operationId": "origin-ca-list-certificates", + "parameters": [ + { + "in": "query", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "query", + "name": "identifier", + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/schemas-certificate_response_collection" } + } + }, + "description": "List Certificates response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-certificate_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Certificates response failure" + } + }, + "security": [{ "user_service_key": [] }, { "api_token": [] }], + "summary": "List Certificates", + "tags": ["Origin CA"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "post": { + "description": "Create an Origin CA certificate. Use your Origin CA Key as your User Service Key when calling this endpoint ([see above](#requests)).", + "operationId": "origin-ca-create-certificate", + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "csr": { "$ref": "#/components/schemas/csr" }, + "hostnames": { "$ref": "#/components/schemas/hostnames" }, + "request_type": { "$ref": "#/components/schemas/request_type" }, + "requested_validity": { "$ref": "#/components/schemas/requested_validity" } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-certificate_response_single" } } + }, + "description": "Create Certificate response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-certificate_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Certificate response failure" + } + }, + "security": [{ "user_service_key": [] }, { "api_token": [] }], + "summary": "Create Certificate", + "tags": ["Origin CA"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/certificates/{identifier}": { + "delete": { + "description": "Revoke an existing Origin CA certificate by its serial number. Use your Origin CA Key as your User Service Key when calling this endpoint ([see above](#requests)).", + "operationId": "origin-ca-revoke-certificate", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/certificates_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/certificate_response_single_id-NbTd4zHr" } + } + }, + "description": "Revoke Certificate response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/certificate_response_single_id-NbTd4zHr" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Revoke Certificate response failure" + } + }, + "security": [{ "user_service_key": [] }, { "api_token": [] }], + "summary": "Revoke Certificate", + "tags": ["Origin CA"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "get": { + "description": "Get an existing Origin CA certificate by its serial number. Use your Origin CA Key as your User Service Key when calling this endpoint ([see above](#requests)).", + "operationId": "origin-ca-get-certificate", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/certificates_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-certificate_response_single" } } + }, + "description": "Get Certificate response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-certificate_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Certificate response failure" + } + }, + "security": [{ "user_service_key": [] }, { "api_token": [] }], + "summary": "Get Certificate", + "tags": ["Origin CA"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/ips": { + "get": { + "description": "Get IPs used on the Cloudflare network, see https://www.cloudflare.com/ips.", + "operationId": "cloudflare-i-ps-cloudflare-ip-details", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/ips-BbJyXXsk" } } } + ] + } + } + }, + "description": "Cloudflare IP Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/ips-BbJyXXsk" } } } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Cloudflare IP Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Cloudflare IP Details", + "tags": ["Cloudflare IPs"] + } + }, + "/ips?networks=jdcloud": { + "get": { + "description": "Get IPs used by JD Cloud data centers in China, see https://developers.cloudflare.com/china-network/reference/infrastructure/.", + "operationId": "cloudflare-i-ps-cloudflare-ip-details-jdcloud", + "parameters": [ + { + "description": "Specified as `jdcloud` to list IPs used by JD Cloud data centers.", + "in": "query", + "name": "networks", + "required": true, + "schema": { "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/ips_jdcloud" } } } + ] + } + } + }, + "description": "JD Cloud IP Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/ips_jdcloud" } } } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "JD Cloud IP Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "JD Cloud IP Details", + "tags": ["Cloudflare IPs"] + } + }, + "/memberships": { + "get": { + "description": "List memberships of accounts the user can access.", + "operationId": "user'-s-account-memberships-list-memberships", + "parameters": [ + { "in": "query", "name": "account.name", "schema": { "$ref": "#/components/schemas/properties-name" } }, + { + "in": "query", + "name": "page", + "schema": { + "default": 1, + "description": "Page number of paginated results.", + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { + "default": 20, + "description": "Number of memberships per page.", + "maximum": 50, + "minimum": 5, + "type": "number" + } + }, + { + "in": "query", + "name": "order", + "schema": { + "description": "Field to order memberships by.", + "enum": ["id", "account.name", "status"], + "example": "status", + "type": "string" + } + }, + { + "in": "query", + "name": "direction", + "schema": { + "description": "Direction to order memberships.", + "enum": ["asc", "desc"], + "example": "desc", + "type": "string" + } + }, + { "in": "query", "name": "name", "schema": { "$ref": "#/components/schemas/properties-name" } }, + { + "in": "query", + "name": "status", + "schema": { + "description": "Status of this membership.", + "enum": ["accepted", "pending", "rejected"], + "example": "accepted", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/collection_membership_response" } } + }, + "description": "List Memberships response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/collection_membership_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Memberships response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Memberships", + "tags": ["User's Account Memberships"] + } + }, + "/memberships/{identifier}": { + "delete": { + "description": "Remove the associated member from an account.", + "operationId": "user'-s-account-memberships-delete-membership", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/membership_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "id": { "$ref": "#/components/schemas/membership_components-schemas-identifier" } + } + } + }, + "type": "object" + } + ] + } + } + }, + "description": "Delete Membership response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "id": { "$ref": "#/components/schemas/membership_components-schemas-identifier" } + } + } + }, + "type": "object" + } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Membership response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Membership", + "tags": ["User's Account Memberships"] + }, + "get": { + "description": "Get a specific membership.", + "operationId": "user'-s-account-memberships-membership-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/membership_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_membership_response" } } + }, + "description": "Membership Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_membership_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Membership Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Membership Details", + "tags": ["User's Account Memberships"] + }, + "put": { + "description": "Accept or reject this account invitation.", + "operationId": "user'-s-account-memberships-update-membership", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/membership_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "status": { + "description": "Whether to accept or reject this account invitation.", + "enum": ["accepted", "rejected"], + "example": "accepted" + } + }, + "required": ["status"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_membership_response" } } + }, + "description": "Update Membership response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_membership_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Membership response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Membership", + "tags": ["User's Account Memberships"] + } + }, + "/organizations/{identifier}": { + "get": { + "deprecated": true, + "description": "Get information about a specific organization that you are a member of.", + "operationId": "organizations-(-deprecated)-organization-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_organization_response" } } + }, + "description": "Organization Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_organization_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Organization Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Organization Details", + "tags": ["Organizations (Deprecated)"], + "x-cfDeprecation": { + "description": "This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.", + "display": true, + "eol": "2020-02-04", + "id": "org_deprecation" + }, + "x-cfPermissionsRequired": { "enum": ["#organization:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "patch": { + "deprecated": true, + "description": "Update an existing Organization.", + "operationId": "organizations-(-deprecated)-edit-organization", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "name": { "$ref": "#/components/schemas/schemas-name-Usb6SCq8" } }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_organization_response" } } + }, + "description": "Edit Organization response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_organization_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Edit Organization response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Edit Organization", + "tags": ["Organizations (Deprecated)"], + "x-cfDeprecation": { + "description": "This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.", + "display": true, + "eol": "2020-02-04", + "id": "org_deprecation" + }, + "x-cfPermissionsRequired": { "enum": ["#organization:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/organizations/{organization_identifier}/audit_logs": { + "get": { + "deprecated": true, + "description": "Gets a list of audit logs for an organization. The list can be filtered by who made the change, which zone was the change made on, and the timeframe of the change.", + "operationId": "audit-logs-get-organization-audit-logs", + "parameters": [ + { + "in": "path", + "name": "organization_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "query", + "name": "id", + "schema": { + "description": "Finds a specific log by its ID.", + "example": "f174be97-19b1-40d6-954d-70cd5fbd52db", + "type": "string" + } + }, + { + "in": "query", + "name": "export", + "schema": { + "description": "Indicates that this request is an export of logs in CSV format.", + "example": true, + "type": "boolean" + } + }, + { + "in": "query", + "name": "action.type", + "schema": { "description": "Filters by the action type.", "example": "add", "type": "string" } + }, + { + "in": "query", + "name": "actor.ip", + "schema": { + "description": "Filters by the IP address of the request that made the change by specific IP address or valid CIDR Range.", + "example": "17.168.228.63", + "type": "string" + } + }, + { + "in": "query", + "name": "actor.email", + "schema": { + "description": "Filters by the email address of the actor that made the change.", + "example": "alice@example.com", + "format": "email", + "type": "string" + } + }, + { + "in": "query", + "name": "since", + "schema": { + "description": "Limits the returned results to logs newer than the specified date. This can be a date string `2019-04-30` or an absolute timestamp that conforms to RFC3339.", + "example": "2019-04-30T01:12:20Z", + "format": "date-time", + "type": "string" + } + }, + { + "in": "query", + "name": "before", + "schema": { + "description": "Limits the returned results to logs older than the specified date. This can be a date string `2019-04-30` or an absolute timestamp that conforms to RFC3339.", + "example": "2019-04-30T01:12:20Z", + "format": "date-time", + "type": "string" + } + }, + { + "in": "query", + "name": "zone.name", + "schema": { + "description": "Filters by the name of the zone associated to the change.", + "example": "example.com", + "type": "string" + } + }, + { + "in": "query", + "name": "direction", + "schema": { + "default": "desc", + "description": "Changes the direction of the chronological sorting.", + "enum": ["desc", "asc"], + "example": "desc", + "type": "string" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { + "default": 100, + "description": "Sets the number of results to return per page.", + "example": 25, + "maximum": 1000, + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "page", + "schema": { + "default": 1, + "description": "Defines which page of results to return.", + "example": 50, + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "hide_user_logs", + "schema": { + "default": false, + "description": "Indicates whether or not to hide user level audit logs.", + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/audit_logs_response_collection" } } + }, + "description": "Get organization audit logs response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/audit_logs_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get organization audit logs response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get organization audit logs", + "tags": ["Audit Logs"], + "x-cfDeprecation": { + "description": "This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.", + "display": true, + "eol": "2020-02-04", + "id": "org_deprecation" + }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/organizations/{organization_identifier}/invites": { + "get": { + "deprecated": true, + "description": "List all invitations associated with an organization.", + "operationId": "organization-invites-list-invitations", + "parameters": [ + { + "in": "path", + "name": "organization_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/collection_invite_response" } } + }, + "description": "List Invitations response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/collection_invite_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Invitations response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Invitations", + "tags": ["Organization Invites"], + "x-cfDeprecation": { + "description": "This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.", + "display": true, + "eol": "2020-02-04", + "id": "org_deprecation" + }, + "x-cfPermissionsRequired": { "enum": ["#organization:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "post": { + "deprecated": true, + "description": "Invite a User to become a Member of an Organization.", + "operationId": "organization-invites-create-invitation", + "parameters": [ + { + "in": "path", + "name": "organization_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "auto_accept": { + "default": false, + "description": "When present and set to true, allows for the invited user to be automatically accepted to the organization. No invitation is sent.", + "example": true, + "type": "boolean" + }, + "invited_member_email": { "$ref": "#/components/schemas/invited_member_email" }, + "roles": { + "description": "Array of Roles associated with the invited user.", + "example": [ + { "id": "5a7805061c76ada191ed06f989cc3dac" }, + { "id": "9a7806061c88ada191ed06f989cc3dac" } + ], + "items": { + "properties": { + "description": { "$ref": "#/components/schemas/description-gV3mXO2g" }, + "id": { "$ref": "#/components/schemas/role_components-schemas-identifier" }, + "name": { "$ref": "#/components/schemas/components-schemas-name-l3W5RvJP" }, + "permissions": { "$ref": "#/components/schemas/schemas-permissions" } + }, + "required": ["id"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["invited_member_email", "roles"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/single_invite_response" } } }, + "description": "Create Invitation response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_invite_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Invitation response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Invitation", + "tags": ["Organization Invites"], + "x-cfDeprecation": { + "description": "This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.", + "display": true, + "eol": "2020-02-04", + "id": "org_deprecation" + }, + "x-cfPermissionsRequired": { "enum": ["#organization:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/organizations/{organization_identifier}/invites/{identifier}": { + "delete": { + "deprecated": true, + "description": "Cancel an existing invitation.", + "operationId": "organization-invites-cancel-invitation", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/invite_components-schemas-identifier" } + }, + { + "in": "path", + "name": "organization_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { "id": { "$ref": "#/components/schemas/invite_components-schemas-identifier" } } + } + } + }, + "description": "Cancel Invitation response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "properties": { "id": { "$ref": "#/components/schemas/invite_components-schemas-identifier" } } }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Cancel Invitation response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Cancel Invitation", + "tags": ["Organization Invites"], + "x-cfDeprecation": { + "description": "This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.", + "display": true, + "eol": "2020-02-04", + "id": "org_deprecation" + }, + "x-cfPermissionsRequired": { "enum": ["#organization:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "get": { + "deprecated": true, + "description": "Get the details of an invitation.", + "operationId": "organization-invites-invitation-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/invite_components-schemas-identifier" } + }, + { + "in": "path", + "name": "organization_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/single_invite_response" } } }, + "description": "Invitation Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_invite_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Invitation Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Invitation Details", + "tags": ["Organization Invites"], + "x-cfDeprecation": { + "description": "This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.", + "display": true, + "eol": "2020-02-04", + "id": "org_deprecation" + }, + "x-cfPermissionsRequired": { "enum": ["#organization:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "patch": { + "deprecated": true, + "description": "Change the Roles of a Pending Invite.", + "operationId": "organization-invites-edit-invitation-roles", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/invite_components-schemas-identifier" } + }, + { + "in": "path", + "name": "organization_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "roles": { + "description": "Array of Roles associated with the invited user.", + "items": { "$ref": "#/components/schemas/role_components-schemas-identifier" }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/single_invite_response" } } }, + "description": "Edit Invitation Roles response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_invite_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Edit Invitation Roles response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Edit Invitation Roles", + "tags": ["Organization Invites"], + "x-cfDeprecation": { + "description": "This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.", + "display": true, + "eol": "2020-02-04", + "id": "org_deprecation" + }, + "x-cfPermissionsRequired": { "enum": ["#organization:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/organizations/{organization_identifier}/members": { + "get": { + "deprecated": true, + "description": "List all members of a organization.", + "operationId": "organization-members-list-members", + "parameters": [ + { + "in": "path", + "name": "organization_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/organization_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/collection_member_response" } } + }, + "description": "List Members response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/collection_member_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Members response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Members", + "tags": ["Organization Members"], + "x-cfDeprecation": { + "description": "This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.", + "display": true, + "eol": "2020-02-04", + "id": "org_deprecation" + }, + "x-cfPermissionsRequired": { "enum": ["#organization:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/organizations/{organization_identifier}/members/{identifier}": { + "delete": { + "deprecated": true, + "description": "Remove a member from an organization.", + "operationId": "organization-members-remove-member", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "path", + "name": "organization_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/organization_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" } } + } + } + }, + "description": "Remove Member response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "properties": { "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" } } }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Remove Member response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Remove Member", + "tags": ["Organization Members"], + "x-cfDeprecation": { + "description": "This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.", + "display": true, + "eol": "2020-02-04", + "id": "org_deprecation" + }, + "x-cfPermissionsRequired": { "enum": ["#organization:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "get": { + "deprecated": true, + "description": "Get information about a specific member of an organization.", + "operationId": "organization-members-member-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "path", + "name": "organization_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/organization_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/single_member_response" } } }, + "description": "Member Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_member_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Member Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Member Details", + "tags": ["Organization Members"], + "x-cfDeprecation": { + "description": "This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.", + "display": true, + "eol": "2020-02-04", + "id": "org_deprecation" + }, + "x-cfPermissionsRequired": { "enum": ["#organization:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "patch": { + "deprecated": true, + "description": "Change the Roles of an Organization's Member.", + "operationId": "organization-members-edit-member-roles", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "path", + "name": "organization_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/organization_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "roles": { + "description": "Array of Roles associated with this Member.", + "items": { "$ref": "#/components/schemas/role_components-schemas-identifier" }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/single_member_response" } } }, + "description": "Edit Member Roles response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_member_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Edit Member Roles response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Edit Member Roles", + "tags": ["Organization Members"], + "x-cfDeprecation": { + "description": "This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.", + "display": true, + "eol": "2020-02-04", + "id": "org_deprecation" + }, + "x-cfPermissionsRequired": { "enum": ["#organization:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/organizations/{organization_identifier}/railguns": { + "get": { + "deprecated": true, + "description": "List, search, sort and filter your Railguns.", + "operationId": "organization-railgun-list-railguns", + "parameters": [ + { + "in": "path", + "name": "organization_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "query", + "name": "page", + "schema": { + "default": 1, + "description": "Page number of paginated results.", + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { + "default": 20, + "description": "Number of items per page.", + "maximum": 50, + "minimum": 5, + "type": "number" + } + }, + { + "in": "query", + "name": "direction", + "schema": { + "description": "Sort Railguns in ascending or descending order.", + "enum": ["asc", "desc"], + "example": "desc" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/railgun_response_collection" } } + }, + "description": "List Railguns response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/railgun_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Railguns response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Railguns", + "tags": ["Organization Railgun"], + "x-cfDeprecation": { + "description": "This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.", + "display": true, + "eol": "2020-02-04", + "id": "org_deprecation" + }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + }, + "post": { + "deprecated": true, + "operationId": "organization-railgun-create-railgun", + "parameters": [ + { + "in": "path", + "name": "organization_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "name": { "$ref": "#/components/schemas/railgun_components-schemas-name" } }, + "required": ["name"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/railgun_response_single" } } }, + "description": "Create Railgun response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/railgun_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Railgun response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Railgun", + "tags": ["Organization Railgun"], + "x-cfDeprecation": { + "description": "This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.", + "display": true, + "eol": "2020-02-04", + "id": "org_deprecation" + }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + } + }, + "/organizations/{organization_identifier}/railguns/{identifier}": { + "delete": { + "deprecated": true, + "description": "Disable and delete a Railgun. This will immediately disable the Railgun for any connected zones.", + "operationId": "organization-railgun-delete-railgun", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/railgun_components-schemas-identifier" } + }, + { + "in": "path", + "name": "organization_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/railgun_response_single_id" } } + }, + "description": "Delete Railgun response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/railgun_response_single_id" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Railgun response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Railgun", + "tags": ["Organization Railgun"], + "x-cfDeprecation": { + "description": "This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.", + "display": true, + "eol": "2020-02-04", + "id": "org_deprecation" + }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + }, + "get": { + "deprecated": true, + "operationId": "organization-railgun-railgun-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/railgun_components-schemas-identifier" } + }, + { + "in": "path", + "name": "organization_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/railgun_response_single" } } }, + "description": "Railgun details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/railgun_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Railgun details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Railgun details", + "tags": ["Organization Railgun"], + "x-cfDeprecation": { + "description": "This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.", + "display": true, + "eol": "2020-02-04", + "id": "org_deprecation" + }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + }, + "patch": { + "deprecated": true, + "description": "Enable or disable a Railgun for all zones connected to it.", + "operationId": "organization-railgun-enable-or-disable-a-railgun", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/railgun_components-schemas-identifier" } + }, + { + "in": "path", + "name": "organization_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "enabled": { "$ref": "#/components/schemas/railgun_components-schemas-enabled" } }, + "required": ["enabled"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/railgun_response_single" } } }, + "description": "Enable or disable a Railgun response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/railgun_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Enable or disable a Railgun response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Enable or disable a Railgun", + "tags": ["Organization Railgun"], + "x-cfDeprecation": { + "description": "This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.", + "display": true, + "eol": "2020-02-04", + "id": "org_deprecation" + }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + } + }, + "/organizations/{organization_identifier}/railguns/{identifier}/zones": { + "get": { + "deprecated": true, + "description": "Lists the zones that are currently using this Railgun.", + "operationId": "organization-railgun-get-railgun-zones", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/railgun_components-schemas-identifier" } + }, + { + "in": "path", + "name": "organization_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "items": { "$ref": "#/components/schemas/components-schemas-zone" }, + "type": "array" + } + } + } + ] + } + } + }, + "description": "Get Railgun zones response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "items": { "$ref": "#/components/schemas/components-schemas-zone" }, + "type": "array" + } + } + } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Railgun zones response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Railgun zones", + "tags": ["Organization Railgun"], + "x-cfDeprecation": { + "description": "This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.", + "display": true, + "eol": "2020-02-04", + "id": "org_deprecation" + }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + } + }, + "/organizations/{organization_identifier}/roles": { + "get": { + "deprecated": true, + "description": "Get all available roles for an organization.", + "operationId": "organization-roles-list-roles", + "parameters": [ + { + "in": "path", + "name": "organization_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/organization_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/collection_role_response" } } + }, + "description": "List Roles response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/collection_role_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Roles response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Roles", + "tags": ["Organization Roles"], + "x-cfDeprecation": { + "description": "This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.", + "display": true, + "eol": "2020-02-04", + "id": "org_deprecation" + }, + "x-cfPermissionsRequired": { "enum": ["#organization:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/organizations/{organization_identifier}/roles/{identifier}": { + "get": { + "deprecated": true, + "description": "Get information about a specific role for an organization.", + "operationId": "organization-roles-role-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/role_components-schemas-identifier" } + }, + { + "in": "path", + "name": "organization_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/organization_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/single_role_response" } } }, + "description": "Role Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_role_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Role Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Role Details", + "tags": ["Organization Roles"], + "x-cfDeprecation": { + "description": "This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs, which have a broader range of features and are backwards compatible with these API.", + "display": true, + "eol": "2020-02-04", + "id": "org_deprecation" + }, + "x-cfPermissionsRequired": { "enum": ["#organization:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/radar/annotations/outages": { + "get": { + "operationId": "radar_get_AnnotationsOutages", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Number of objects to skip before grabbing results.", + "in": "query", + "name": "offset", + "schema": { + "default": 0, + "description": "Number of objects to skip before grabbing results.", + "example": 0, + "type": "integer" + } + }, + { + "description": "Shorthand date ranges for the last X days - use when you don't need specific start and end dates.", + "in": "query", + "name": "dateRange", + "schema": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + } + }, + { + "description": "Start of the date range (inclusive).", + "in": "query", + "name": "dateStart", + "schema": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" } + }, + { + "description": "End of the date range (inclusive).", + "in": "query", + "name": "dateEnd", + "schema": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "annotations": { + "items": { + "properties": { + "asns": { "items": { "example": 189, "type": "integer" }, "type": "array" }, + "asnsDetails": { + "items": { + "properties": { + "asn": { "example": 189, "type": "integer" }, + "locations": { + "properties": { + "asn": { "example": "US", "type": "string" }, + "name": { "example": "United States", "type": "string" } + }, + "required": ["asn", "name"], + "type": "object" + }, + "name": { "example": "LUMEN-LEGACY-L3-PARTITION", "type": "string" } + }, + "required": ["asn", "name", "locations"], + "type": "object" + }, + "type": "array" + }, + "dataSource": { "example": "ALL", "type": "string" }, + "description": { "example": "example", "type": "string" }, + "endDate": { "example": "2022-09-08T10:00:28Z", "type": "string" }, + "eventType": { "example": "OUTAGE", "type": "string" }, + "linkedUrl": { "example": "http://example.com", "type": "string" }, + "locations": { "items": { "example": "US", "type": "string" }, "type": "array" }, + "locationsDetails": { + "items": { + "properties": { + "code": { "example": "US", "type": "string" }, + "name": { "example": "United States", "type": "string" } + }, + "required": ["code", "name"], + "type": "object" + }, + "type": "array" + }, + "outage": { + "properties": { + "outageCause": { "example": "CABLE_CUT", "type": "string" }, + "outageType": { "example": "NATIONWIDE", "type": "string" } + }, + "required": ["outageCause", "outageType"], + "type": "object" + }, + "scope": { "example": "Colima, Michoacán, México", "type": "string" }, + "startDate": { "example": "2022-09-06T10:00:28Z", "type": "string" } + }, + "required": [ + "dataSource", + "startDate", + "asns", + "asnsDetails", + "locations", + "locationsDetails", + "eventType", + "outage" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": ["annotations"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get outages annotations", + "tags": ["Radar Annotations"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/annotations/outages/locations": { + "get": { + "operationId": "radar_get_AnnotationsOutagesTop", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Shorthand date ranges for the last X days - use when you don't need specific start and end dates.", + "in": "query", + "name": "dateRange", + "schema": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + } + }, + { + "description": "Start of the date range (inclusive).", + "in": "query", + "name": "dateStart", + "schema": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" } + }, + { + "description": "End of the date range (inclusive).", + "in": "query", + "name": "dateEnd", + "schema": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "annotations": { + "items": { + "properties": { + "clientCountryAlpha2": { "example": "PT", "type": "string" }, + "clientCountryName": { "example": "Portugal", "type": "string" }, + "value": { "example": "5", "type": "string" } + }, + "required": ["clientCountryAlpha2", "clientCountryName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["annotations"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top outages annotations", + "tags": ["Radar Annotations"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/as112/summary/dnssec": { + "get": { + "description": "Percentage distribution of dns requests classified per DNSSEC.", + "operationId": "radar_get_AS112DNSSECSummary", + "parameters": [ + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "summary_0": { + "properties": { + "NOT_SUPPORTED": { "example": "16", "type": "string" }, + "SUPPORTED": { "example": "84", "type": "string" } + }, + "required": ["SUPPORTED", "NOT_SUPPORTED"], + "type": "object" + } + }, + "required": ["meta", "summary_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a summary of DNSSEC", + "tags": ["Radar AS112"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/as112/summary/edns": { + "get": { + "description": "Percentage distribution of dns requests classified per EDNS.", + "operationId": "radar_get_AS112EDNSSummary", + "parameters": [ + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "summary_0": { + "properties": { + "NOT_SUPPORTED": { "example": "6", "type": "string" }, + "SUPPORTED": { "example": "94", "type": "string" } + }, + "required": ["SUPPORTED", "NOT_SUPPORTED"], + "type": "object" + } + }, + "required": ["meta", "summary_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a summary of EDNS", + "tags": ["Radar AS112"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/as112/summary/ip_version": { + "get": { + "description": "Percentage distribution of dns requests classified per IP Version.", + "operationId": "radar_get_AS112IPVersionSummary", + "parameters": [ + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "summary_0": { + "properties": { + "IPv4": { "example": "80", "type": "string" }, + "IPv6": { "example": "20", "type": "string" } + }, + "required": ["IPv4", "IPv6"], + "type": "object" + } + }, + "required": ["meta", "summary_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a summary of IP Version", + "tags": ["Radar AS112"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/as112/summary/protocol": { + "get": { + "description": "Percentage distribution of dns requests classified per Protocol.", + "operationId": "radar_get_AS112ProtocolSummary", + "parameters": [ + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "summary_0": { + "properties": { + "tcp": { "example": "1", "type": "string" }, + "udp": { "example": "99", "type": "string" } + }, + "required": ["udp", "tcp"], + "type": "object" + } + }, + "required": ["meta", "summary_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a summary of Protocol", + "tags": ["Radar AS112"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/as112/summary/query_type": { + "get": { + "description": "Percentage distribution of dns requests classified per Query Type.", + "operationId": "radar_get_AS112QueryTypeSummary", + "parameters": [ + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "summary_0": { + "properties": { + "A": { "example": "19", "type": "string" }, + "AAAA": { "example": "1", "type": "string" }, + "PTR": { "example": "74", "type": "string" }, + "SOA": { "example": "5", "type": "string" }, + "SRV": { "example": "1", "type": "string" } + }, + "required": ["PTR", "A", "SOA", "AAAA", "SRV"], + "type": "object" + } + }, + "required": ["meta", "summary_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a summary of Query Type", + "tags": ["Radar AS112"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/as112/summary/response_codes": { + "get": { + "description": "Percentage distribution of dns requests classified per Response Codes.", + "operationId": "radar_get_AS112ResponseCodesSummary", + "parameters": [ + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "summary_0": { + "properties": { + "NOERROR": { "example": "6", "type": "string" }, + "NXDOMAIN": { "example": "94", "type": "string" } + }, + "required": ["NXDOMAIN", "NOERROR"], + "type": "object" + } + }, + "required": ["meta", "summary_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a summary of Response Codes", + "tags": ["Radar AS112"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/as112/timeseries": { + "get": { + "description": "Get AS112 queries change over time.", + "operationId": "radar_get_AS112Timeseries", + "parameters": [ + { + "description": "Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).", + "in": "query", + "name": "aggInterval", + "schema": { "enum": ["15m", "1h", "1d", "1w"], "type": "string" } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "aggInterval": { "example": "1h", "type": "string" }, + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "example": "ALL", "type": "string" }, + "description": { "example": "Cable cut in Tonga", "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "example": "OUTAGE", "type": "string" }, + "linkedUrl": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": [ + "dataSource", + "eventType", + "description", + "startTime", + "endTime", + "linkedUrl" + ], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "description": "Adjusted end of date range.", + "example": "2022-09-17T10:22:57.555Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "description": "Adjusted start of date range.", + "example": "2022-09-16T10:22:57.555Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + }, + "lastUpdated": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["confidenceInfo", "dateRange", "aggInterval", "lastUpdated"], + "type": "object" + }, + "serie_0": { + "properties": { + "timestamps": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + }, + "values": { "items": { "example": 0.56, "type": "string" }, "type": "array" } + }, + "required": ["timestamps", "values"], + "type": "object" + } + }, + "required": ["meta", "serie_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get AS112 time series", + "tags": ["Radar AS112"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/as112/timeseries/dnssec": { + "get": { + "description": "Percentage distribution of dns requests classified per DNSSEC over time.", + "operationId": "radar_get_AS112DNSSECTimeseriesGroup", + "parameters": [ + { + "description": "Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).", + "in": "query", + "name": "aggInterval", + "schema": { "enum": ["15m", "1h", "1d", "1w"], "type": "string" } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "serie_0": { + "properties": { + "NOT_SUPPORTED": { "items": { "example": "16", "type": "string" }, "type": "array" }, + "SUPPORTED": { "items": { "example": "84", "type": "string" }, "type": "array" } + }, + "required": ["SUPPORTED", "NOT_SUPPORTED"], + "type": "object" + } + }, + "required": ["meta", "serie_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a time series of DNSSEC", + "tags": ["Radar AS112"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/as112/timeseries/edns": { + "get": { + "description": "Percentage distribution of dns requests classified per EDNS over time.", + "operationId": "radar_get_AS112EDNSTimeseriesGroup", + "parameters": [ + { + "description": "Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).", + "in": "query", + "name": "aggInterval", + "schema": { "enum": ["15m", "1h", "1d", "1w"], "type": "string" } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "serie_0": { + "properties": { + "NOT_SUPPORTED": { "items": { "example": "6", "type": "string" }, "type": "array" }, + "SUPPORTED": { "items": { "example": "94", "type": "string" }, "type": "array" } + }, + "required": ["SUPPORTED", "NOT_SUPPORTED"], + "type": "object" + } + }, + "required": ["meta", "serie_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a time series of EDNS", + "tags": ["Radar AS112"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/as112/timeseries/ip_version": { + "get": { + "description": "Percentage distribution of dns requests classified per IP Version over time.", + "operationId": "radar_get_AS112IPVersionTimeseriesGroup", + "parameters": [ + { + "description": "Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).", + "in": "query", + "name": "aggInterval", + "schema": { "enum": ["15m", "1h", "1d", "1w"], "type": "string" } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "serie_0": { + "properties": { + "IPv4": { "items": { "example": "80", "type": "string" }, "type": "array" }, + "IPv6": { "items": { "example": "20", "type": "string" }, "type": "array" } + }, + "required": ["IPv4", "IPv6"], + "type": "object" + } + }, + "required": ["meta", "serie_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a time series of IP Version", + "tags": ["Radar AS112"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/as112/timeseries/protocol": { + "get": { + "description": "Percentage distribution of dns requests classified per Protocol over time.", + "operationId": "radar_get_AS112ProtocolTimeseriesGroup", + "parameters": [ + { + "description": "Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).", + "in": "query", + "name": "aggInterval", + "schema": { "enum": ["15m", "1h", "1d", "1w"], "type": "string" } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "serie_0": { + "properties": { + "tcp": { "items": { "example": "1", "type": "string" }, "type": "array" }, + "udp": { "items": { "example": "99", "type": "string" }, "type": "array" } + }, + "required": ["udp", "tcp"], + "type": "object" + } + }, + "required": ["meta", "serie_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a time series of Protocol", + "tags": ["Radar AS112"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/as112/timeseries/query_type": { + "get": { + "description": "Percentage distribution of dns requests classified per Query Type over time.", + "operationId": "radar_get_AS112QueryTypeTimeseriesGroup", + "parameters": [ + { + "description": "Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).", + "in": "query", + "name": "aggInterval", + "schema": { "enum": ["15m", "1h", "1d", "1w"], "type": "string" } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "serie_0": { + "properties": { + "A": { "items": { "example": "19", "type": "string" }, "type": "array" }, + "AAAA": { "items": { "example": "1", "type": "string" }, "type": "array" }, + "PTR": { "items": { "example": "74", "type": "string" }, "type": "array" }, + "SOA": { "items": { "example": "5", "type": "string" }, "type": "array" }, + "SRV": { "items": { "example": "1", "type": "string" }, "type": "array" } + }, + "required": ["PTR", "A", "SOA", "AAAA", "SRV"], + "type": "object" + } + }, + "required": ["meta", "serie_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a time series of Query Type", + "tags": ["Radar AS112"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/as112/timeseries/response_codes": { + "get": { + "description": "Percentage distribution of dns requests classified per Response Codes over time.", + "operationId": "radar_get_AS112ResponseCodesTimeseriesGroup", + "parameters": [ + { + "description": "Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).", + "in": "query", + "name": "aggInterval", + "schema": { "enum": ["15m", "1h", "1d", "1w"], "type": "string" } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "serie_0": { + "properties": { + "NOERROR": { "items": { "example": "6", "type": "string" }, "type": "array" }, + "NXDOMAIN": { "items": { "example": "94", "type": "string" }, "type": "array" } + }, + "required": ["NXDOMAIN", "NOERROR"], + "type": "object" + } + }, + "required": ["meta", "serie_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a time series of Response Codes", + "tags": ["Radar AS112"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/as112/top/locations": { + "get": { + "description": "Get the top locations by HTTP traffic. Values are a percentage out of the total traffic.", + "operationId": "radar_get_AS112TopLocations", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientCountryAlpha2": { "example": "US", "type": "string" }, + "clientCountryName": { "example": "United States", "type": "string" }, + "value": { "example": "65", "type": "string" } + }, + "required": ["clientCountryAlpha2", "clientCountryName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top autonomous systems by HTTP requests", + "tags": ["Radar AS112"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/as112/top/locations/dnssec/{dnssec}": { + "get": { + "description": "Get the locations, by AS112 queries, of DNSSEC validations.", + "operationId": "radar_get_AS112TopLocationsByDnssec", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "DNSSEC.", + "in": "path", + "name": "dnssec", + "required": true, + "schema": { "enum": ["SUPPORTED", "NOT_SUPPORTED"], "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientCountryAlpha2": { "example": "US", "type": "string" }, + "clientCountryName": { "example": "United States", "type": "string" }, + "value": { "example": "65", "type": "string" } + }, + "required": ["clientCountryAlpha2", "clientCountryName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top locations by DNSSEC validations", + "tags": ["Radar AS112"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/as112/top/locations/edns/{edns}": { + "get": { + "description": "Get the locations, by AS112 queries, of EDNS validations.", + "operationId": "radar_get_AS112TopLocationsByEdns", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "EDNS.", + "in": "path", + "name": "edns", + "required": true, + "schema": { "enum": ["SUPPORTED", "NOT_SUPPORTED"], "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientCountryAlpha2": { "example": "US", "type": "string" }, + "clientCountryName": { "example": "United States", "type": "string" }, + "value": { "example": "65", "type": "string" } + }, + "required": ["clientCountryAlpha2", "clientCountryName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top locations by EDNS validations", + "tags": ["Radar AS112"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/as112/top/locations/ip_version/{ip_version}": { + "get": { + "description": "Get the locations, by AS112 queries, of IP version.", + "operationId": "radar_get_AS112TopLocationsByIpVersion", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "IP Version.", + "in": "path", + "name": "ip_version", + "required": true, + "schema": { "enum": ["IPv4", "IPv6"], "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientCountryAlpha2": { "example": "US", "type": "string" }, + "clientCountryName": { "example": "United States", "type": "string" }, + "value": { "example": "65", "type": "string" } + }, + "required": ["clientCountryAlpha2", "clientCountryName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top locations by IP version", + "tags": ["Radar AS112"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/attacks/layer3/summary": { + "get": { + "description": "Percentage distribution of network protocols in layer 3/4 attacks.", + "operationId": "radar_get_AttacksLayer3Summary", + "parameters": [ + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "example": "ALL", "type": "string" }, + "description": { "example": "Cable cut in Tonga", "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "example": "OUTAGE", "type": "string" }, + "linkedUrl": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": [ + "dataSource", + "eventType", + "description", + "startTime", + "endTime", + "linkedUrl" + ], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "description": "Adjusted end of date range.", + "example": "2022-09-17T10:22:57.555Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "description": "Adjusted start of date range.", + "example": "2022-09-16T10:22:57.555Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "summary_0": { + "properties": { + "gre": { "example": "0.9", "type": "string" }, + "icmp": { "example": "0.1", "type": "string" }, + "tcp": { "example": "60", "type": "string" }, + "udp": { "example": "39", "type": "string" } + }, + "required": ["tcp", "udp", "gre", "icmp"], + "type": "object" + } + }, + "required": ["meta", "summary_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a summary of layer 3 attacks", + "tags": ["Radar Attacks"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/attacks/layer3/timeseries": { + "get": { + "description": "Get layer 3/4 attacks change over time. Values are normalized using min-max by default, with the minimum set to 0. When asking for multiple time series, you can also get the percentual relative change of the 1st/main series, with respect to the 2nd/control series - for example, to get the relative change of this week from the previous week, the 1st series would have a date range of 7d, the 2nd, a date range of 7dControl, and the normalization would be set to PERCENTAGE_CHANGE.", + "operationId": "radar_get_AttacksLayer3Timeseries", + "parameters": [ + { + "description": "Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).", + "in": "query", + "name": "aggInterval", + "schema": { "enum": ["15m", "1h", "1d", "1w"], "type": "string" } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of L3/4 attack types.", + "in": "query", + "name": "attack", + "schema": { "items": { "enum": ["UDP", "TCP", "ICMP", "GRE"], "type": "string" }, "type": "array" } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).", + "in": "query", + "name": "normalization", + "schema": { "enum": ["PERCENTAGE_CHANGE", "MIN0_MAX"], "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "aggInterval": { "example": "1h", "type": "string" }, + "confidenceInfo": { + "properties": { + "endTime": { + "description": "Adjusted end of date range.", + "example": "2022-09-17T10:22:57.555Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "description": "Adjusted start of date range.", + "example": "2022-09-16T10:22:57.555Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "description": "Adjusted end of date range.", + "example": "2022-09-17T10:22:57.555Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "description": "Adjusted start of date range.", + "example": "2022-09-16T10:22:57.555Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + }, + "lastUpdated": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["confidenceInfo", "dateRange", "aggInterval", "lastUpdated"], + "type": "object" + }, + "serie_0": { + "properties": { + "timestamps": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + }, + "values": { "items": { "example": 0.56, "type": "string" }, "type": "array" } + }, + "required": ["timestamps", "values"], + "type": "object" + } + }, + "required": ["meta", "serie_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get layer 3 attacks time series", + "tags": ["Radar Attacks"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/attacks/layer3/timeseries_groups": { + "get": { + "description": "Get percentage of what type of network protocols are used in layer 3/4 attacks, over time.", + "operationId": "radar_get_AttacksLayer3TimeseriesGroups", + "parameters": [ + { + "description": "Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).", + "in": "query", + "name": "aggInterval", + "schema": { "enum": ["15m", "1h", "1d", "1w"], "type": "string" } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "aggInterval": { "example": "1h", "type": "string" }, + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "example": "ALL", "type": "string" }, + "description": { "example": "Cable cut in Tonga", "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "example": "OUTAGE", "type": "string" }, + "linkedUrl": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": [ + "dataSource", + "eventType", + "description", + "startTime", + "endTime", + "linkedUrl" + ], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "description": "Adjusted end of date range.", + "example": "2022-09-17T10:22:57.555Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "description": "Adjusted start of date range.", + "example": "2022-09-16T10:22:57.555Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + }, + "lastUpdated": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["confidenceInfo", "dateRange", "aggInterval", "lastUpdated"], + "type": "object" + }, + "serie_0": { + "properties": { + "gre": { "items": { "example": "0.9", "type": "string" }, "type": "array" }, + "icmp": { "items": { "example": "0.1", "type": "string" }, "type": "array" }, + "tcp": { "items": { "example": "70", "type": "string" }, "type": "array" }, + "timestamps": { "items": { "type": "string" }, "type": "array" }, + "udp": { "items": { "example": "29", "type": "string" }, "type": "array" } + }, + "required": ["timestamps", "udp", "tcp", "gre", "icmp"], + "type": "object" + } + }, + "required": ["meta", "serie_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get layer 3 attacks by network protocol, over time", + "tags": ["Radar Attacks"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/attacks/layer7/summary": { + "get": { + "description": "Percentage distribution of mitigation techniques in layer 7 attacks.", + "operationId": "radar_get_AttacksLayer7Summary", + "parameters": [ + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "example": "ALL", "type": "string" }, + "description": { "example": "Cable cut in Tonga", "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "example": "OUTAGE", "type": "string" }, + "linkedUrl": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": [ + "dataSource", + "eventType", + "description", + "startTime", + "endTime", + "linkedUrl" + ], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "description": "Adjusted end of date range.", + "example": "2022-09-17T10:22:57.555Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "description": "Adjusted start of date range.", + "example": "2022-09-16T10:22:57.555Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "summary_0": { + "properties": { + "access_rules": { "example": "0.9", "type": "string" }, + "api_shield": { "example": "0.9", "type": "string" }, + "bot_management": { "example": "0.9", "type": "string" }, + "data_loss_prevention": { "example": "0.9", "type": "string" }, + "ddos": { "example": "34", "type": "string" }, + "ip_reputation": { "example": "0.1", "type": "string" }, + "waf": { "example": "65", "type": "string" } + }, + "required": [ + "waf", + "ddos", + "ip_reputation", + "access_rules", + "bot_management", + "api_shield", + "data_loss_prevention" + ], + "type": "object" + } + }, + "required": ["meta", "summary_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a summary of layer 7 attacks", + "tags": ["Radar Attacks"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/attacks/layer7/timeseries": { + "get": { + "description": "Get layer 7 attacks change over time. Values are normalized using min-max by default, with the minimum set to 0. When asking for multiple time series, you can also get the percentage relative change of the first/main series, with respect to the second/control series - for example, to get the relative change of this week from the previous week, the first series would have a date range of `7d`, the second, a date range of `7dControl`, and the normalization would be set to `PERCENTAGE_CHANGE`.", + "operationId": "radar_get_AttacksLayer7Timeseries", + "parameters": [ + { + "description": "Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).", + "in": "query", + "name": "aggInterval", + "schema": { "enum": ["15m", "1h", "1d", "1w"], "type": "string" } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of L7 attack types.", + "in": "query", + "name": "attack", + "schema": { + "items": { + "enum": [ + "DDOS", + "WAF", + "BOT_MANAGEMENT", + "ACCESS_RULES", + "IP_REPUTATION", + "API_SHIELD", + "DATA_LOSS_PREVENTION" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).", + "in": "query", + "name": "normalization", + "schema": { "enum": ["PERCENTAGE_CHANGE", "MIN0_MAX"], "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "aggInterval": { "example": "1h", "type": "string" }, + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "example": "ALL", "type": "string" }, + "description": { "example": "Cable cut in Tonga", "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "example": "OUTAGE", "type": "string" }, + "linkedUrl": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": [ + "dataSource", + "eventType", + "description", + "startTime", + "endTime", + "linkedUrl" + ], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "description": "Adjusted end of date range.", + "example": "2022-09-17T10:22:57.555Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "description": "Adjusted start of date range.", + "example": "2022-09-16T10:22:57.555Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + }, + "lastUpdated": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["confidenceInfo", "dateRange", "aggInterval", "lastUpdated"], + "type": "object" + }, + "serie_0": { + "properties": { + "timestamps": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + }, + "values": { "items": { "example": 0.56, "type": "string" }, "type": "array" } + }, + "required": ["timestamps", "values"], + "type": "object" + } + }, + "required": ["meta", "serie_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get attacks layer 7 time series", + "tags": ["Radar Attacks"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/attacks/layer7/timeseries_groups": { + "get": { + "description": "Get percentage of what type of mitigation techniques are used to block layer 7 attacks, over time.", + "operationId": "radar_get_AttacksLayer7TimeseriesGroups", + "parameters": [ + { + "description": "Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).", + "in": "query", + "name": "aggInterval", + "schema": { "enum": ["15m", "1h", "1d", "1w"], "type": "string" } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "aggInterval": { "example": "1h", "type": "string" }, + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "example": "ALL", "type": "string" }, + "description": { "example": "Cable cut in Tonga", "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "example": "OUTAGE", "type": "string" }, + "linkedUrl": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": [ + "dataSource", + "eventType", + "description", + "startTime", + "endTime", + "linkedUrl" + ], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "description": "Adjusted end of date range.", + "example": "2022-09-17T10:22:57.555Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "description": "Adjusted start of date range.", + "example": "2022-09-16T10:22:57.555Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + }, + "lastUpdated": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["confidenceInfo", "dateRange", "aggInterval", "lastUpdated"], + "type": "object" + }, + "serie_0": { + "properties": { + "access_rules": { "items": { "example": "5", "type": "string" }, "type": "array" }, + "api_shield": { "items": { "example": "5", "type": "string" }, "type": "array" }, + "bot_management": { "items": { "example": "5", "type": "string" }, "type": "array" }, + "data_loss_prevention": { "items": { "example": "5", "type": "string" }, "type": "array" }, + "ddos": { "items": { "example": "60", "type": "string" }, "type": "array" }, + "ip_reputation": { "items": { "example": "5", "type": "string" }, "type": "array" }, + "timestamps": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + }, + "waf": { "items": { "example": "30", "type": "string" }, "type": "array" } + }, + "required": [ + "timestamps", + "waf", + "ddos", + "ip_reputation", + "access_rules", + "bot_management", + "api_shield", + "data_loss_prevention" + ], + "type": "object" + } + }, + "required": ["meta", "serie_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get layer 7 attacks by mitigation technique, over time", + "tags": ["Radar Attacks"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/attacks/layer7/top/ases/origin": { + "get": { + "description": "Get the top origin ASes by layer 7 attacks. Values are a percentage out of the total layer 7 attacks. The origin location is determined by the client IP.", + "operationId": "radar_get_AttacksLayer7TopOriginASes", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of locations (alpha-2 country codes).", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of locations (alpha-2 country codes).", + "example": "US", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "top_0": { + "items": { + "properties": { + "originAsn": { "example": 16509, "type": "number" }, + "originAsnName": { "example": "AMAZON-02", "type": "string" }, + "rank": { "example": 1, "type": "integer" }, + "value": { "example": "0.73996", "type": "string" } + }, + "required": ["originAsn", "originAsnName", "value", "rank"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get layer 7 top origin ASes", + "tags": ["Radar Attacks"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/attacks/layer7/top/attacks": { + "get": { + "description": "Get the top attacks from origin to target location. Values are a percentage out of the total layer 7 attacks (with billing country). The attack magnitude can be defined by the number of mitigated requests or by the number of zones affected. You can optionally limit the number of attacks per origin/target location (useful if all the top attacks are from or to the same location).", + "operationId": "radar_get_AttacksLayer7TopAttacks", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Attack magnitude can be defined by total requests mitigated or by total zones attacked.", + "in": "query", + "name": "magnitude", + "schema": { "enum": ["AFFECTED_ZONES", "MITIGATED_REQUESTS"], "type": "string" } + }, + { + "description": "Array of attack origin/target location attack limits. Together with `limitPerLocation`, limits how many objects will be fetched per origin/target location.", + "in": "query", + "name": "limitDirection", + "schema": { "enum": ["ORIGIN", "TARGET"], "type": "string" } + }, + { + "description": "Limit the number of attacks per origin/target (refer to `limitDirection` parameter) location.", + "in": "query", + "name": "limitPerLocation", + "schema": { + "default": 10, + "description": "Limit the number of attacks per origin/target (refer to `limitDirection` parameter) location.", + "example": 10, + "type": "integer" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "top_0": { + "items": { + "properties": { + "originCountryAlpha2": { "example": "US", "type": "string" }, + "originCountryName": { "example": "United States", "type": "string" }, + "rank": { "example": 1, "type": "integer" }, + "targetCountryAlpha2": { "example": "PT", "type": "string" }, + "targetCountryName": { "example": "Portugal", "type": "string" }, + "value": { "example": "0.73996", "type": "string" } + }, + "required": [ + "originCountryName", + "originCountryAlpha2", + "targetCountryName", + "targetCountryAlpha2", + "value", + "rank" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": ["top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get layer 7 top attack pairs (origin and target locations)", + "tags": ["Radar Attacks"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/attacks/layer7/top/locations/origin": { + "get": { + "description": "Get the top origin locations of and by layer 7 attacks. Values are a percentage out of the total layer 7 attacks. The origin location is determined by the client IP.", + "operationId": "radar_get_AttacksLayer7TopOriginLocations", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "top_0": { + "items": { + "properties": { + "originCountryAlpha2": { "example": "US", "type": "string" }, + "originCountryName": { "example": "United States", "type": "string" }, + "rank": { "example": 1, "type": "integer" }, + "value": { "example": "0.73996", "type": "string" } + }, + "required": ["originCountryName", "originCountryAlpha2", "value", "rank"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get layer 7 top origin locations", + "tags": ["Radar Attacks"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/attacks/layer7/top/locations/target": { + "get": { + "description": "Get the top target locations of and by layer 7 attacks. Values are a percentage out of the total layer 7 attacks. The target location is determined by the attacked zone's billing country, when available.", + "operationId": "radar_get_AttacksLayer7TopTargetLocations", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "top_0": { + "items": { + "properties": { + "rank": { "example": 1, "type": "integer" }, + "targetCountryAlpha2": { "example": "US", "type": "string" }, + "targetCountryName": { "example": "United States", "type": "string" }, + "value": { "example": "0.73996", "type": "string" } + }, + "required": ["targetCountryName", "targetCountryAlpha2", "value", "rank"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get layer 7 top target locations", + "tags": ["Radar Attacks"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/bgp/leaks/events": { + "get": { + "description": "Get the BGP route leak events.", + "operationId": "radar_get_BGPRouteLeakEvents", + "parameters": [ + { + "description": "Current page number, starting from 1", + "in": "query", + "name": "page", + "schema": { "default": 1, "description": "Current page number, starting from 1", "type": "integer" } + }, + { + "description": "Number of entries per page", + "in": "query", + "name": "per_page", + "schema": { "default": 50, "description": "Number of entries per page", "type": "integer" } + }, + { + "description": "The leaking AS of a route leak event", + "in": "query", + "name": "leakAsn", + "schema": { "description": "The leaking AS of a route leak event", "type": "integer" } + }, + { + "description": "ASN that is causing or affected by a route leak event", + "in": "query", + "name": "involvedAsn", + "schema": { "description": "ASN that is causing or affected by a route leak event", "type": "integer" } + }, + { + "description": "Shorthand date ranges for the last X days - use when you don't need specific start and end dates.", + "in": "query", + "name": "dateRange", + "schema": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + } + }, + { + "description": "Start of the date range (inclusive).", + "in": "query", + "name": "dateStart", + "schema": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" } + }, + { + "description": "End of the date range (inclusive).", + "in": "query", + "name": "dateEnd", + "schema": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" } + }, + { + "description": "Sort events by field", + "in": "query", + "name": "sortBy", + "schema": { "enum": ["ID", "LEAKS", "PEERS", "PREFIXES", "ORIGINS", "TIME"], "type": "string" } + }, + { + "description": "Sort order", + "in": "query", + "name": "sortOrder", + "schema": { "enum": ["ASC", "DESC"], "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "asn_info": { + "items": { + "properties": { "asn": { "type": "integer" }, "org_name": { "type": "string" } }, + "required": ["asn", "org_name"], + "type": "object" + }, + "type": "array" + }, + "events": { + "items": { + "properties": { + "detected_ts": { "type": "string" }, + "finished": { "type": "boolean" }, + "id": { "type": "integer" }, + "leak_asn": { "type": "integer" }, + "leak_count": { "type": "integer" }, + "leak_seg": { "items": { "type": "integer" }, "type": "array" }, + "leak_type": { "type": "integer" }, + "max_ts": { "type": "string" }, + "min_ts": { "type": "string" }, + "origin_count": { "type": "integer" }, + "peer_count": { "type": "integer" }, + "prefix_count": { "type": "integer" } + }, + "required": [ + "detected_ts", + "finished", + "id", + "leak_asn", + "leak_count", + "leak_seg", + "leak_type", + "max_ts", + "min_ts", + "origin_count", + "peer_count", + "prefix_count" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": ["asn_info", "events"], + "type": "object" + }, + "result_info": { + "properties": { + "count": { "type": "integer" }, + "page": { "type": "integer" }, + "per_page": { "type": "integer" }, + "total_count": { "type": "integer" } + }, + "required": ["count", "total_count", "page", "per_page"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "result_info", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get BGP route leak events", + "tags": ["Radar BGP"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/bgp/timeseries": { + "get": { + "description": "Gets BGP updates change over time. Raw values are returned. When requesting updates of an autonomous system (AS), only BGP updates of type announcement are returned.", + "operationId": "radar_get_BgpTimeseries", + "parameters": [ + { + "description": "Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).", + "in": "query", + "name": "aggInterval", + "schema": { "enum": ["15m", "1h", "1d", "1w"], "type": "string" } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Network prefix, IPv4 or IPv6.", + "in": "query", + "name": "prefix", + "schema": { "description": "Network prefix, IPv4 or IPv6.", "example": "1.1.1.0/24", "type": "string" } + }, + { + "description": "Array of BGP update types.", + "in": "query", + "name": "updateType", + "schema": { "items": { "enum": ["ANNOUNCEMENT", "WITHDRAWAL"], "type": "string" }, "type": "array" } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "aggInterval": { "example": "1h", "type": "string" }, + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "example": "ALL", "type": "string" }, + "description": { "example": "Cable cut in Tonga", "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "example": "OUTAGE", "type": "string" }, + "linkedUrl": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": [ + "dataSource", + "eventType", + "description", + "startTime", + "endTime", + "linkedUrl" + ], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "description": "Adjusted end of date range.", + "example": "2022-09-17T10:22:57.555Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "description": "Adjusted start of date range.", + "example": "2022-09-16T10:22:57.555Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + }, + "lastUpdated": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["confidenceInfo", "dateRange", "aggInterval", "lastUpdated"], + "type": "object" + }, + "serie_0": { + "properties": { + "timestamps": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + }, + "values": { "items": { "example": 0.56, "type": "string" }, "type": "array" } + }, + "required": ["timestamps", "values"], + "type": "object" + } + }, + "required": ["meta", "serie_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get BGP time series", + "tags": ["Radar BGP"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/bgp/top/ases": { + "get": { + "description": "Get the top autonomous systems (AS) by BGP updates (announcements only). Values are a percentage out of the total updates.", + "operationId": "radar_get_BGPTopASes", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of BGP network prefixes.", + "in": "query", + "name": "prefix", + "schema": { + "items": { "description": "Array of BGP network prefixes.", "example": "1.1.1.0/24", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of BGP update types.", + "in": "query", + "name": "updateType", + "schema": { "items": { "enum": ["ANNOUNCEMENT", "WITHDRAWAL"], "type": "string" }, "type": "array" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "dateRange": { + "properties": { + "endTime": { + "description": "Adjusted end of date range.", + "example": "2022-09-17T10:22:57.555Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "description": "Adjusted start of date range.", + "example": "2022-09-16T10:22:57.555Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "ASName": { "example": "Apple-Engineering", "type": "string" }, + "asn": { "example": 714, "type": "integer" }, + "value": { + "description": "Percentage of updates by this AS out of the total updates by all autonomous systems.", + "example": "0.73996", + "type": "string" + } + }, + "required": ["asn", "ASName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top autonomous systems", + "tags": ["Radar BGP"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/bgp/top/prefixes": { + "get": { + "description": "Get the top network prefixes by BGP updates. Values are a percentage out of the total BGP updates.", + "operationId": "radar_get_BGPTopPrefixes", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of BGP update types.", + "in": "query", + "name": "updateType", + "schema": { "items": { "enum": ["ANNOUNCEMENT", "WITHDRAWAL"], "type": "string" }, "type": "array" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "dateRange": { + "properties": { + "endTime": { + "description": "Adjusted end of date range.", + "example": "2022-09-17T10:22:57.555Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "description": "Adjusted start of date range.", + "example": "2022-09-16T10:22:57.555Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "prefix": { "example": "2804:77cc:8000::/33", "type": "string" }, + "value": { "example": "0.73996", "type": "string" } + }, + "required": ["prefix", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top prefixes", + "tags": ["Radar BGP"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/datasets": { + "get": { + "description": "Get a list of datasets.", + "operationId": "radar_get_DatasetList", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Number of objects to skip before grabbing results.", + "in": "query", + "name": "offset", + "schema": { + "default": 0, + "description": "Number of objects to skip before grabbing results.", + "example": 0, + "type": "integer" + } + }, + { + "description": "Dataset type.", + "in": "query", + "name": "datasetType", + "schema": { "enum": ["RANKING_BUCKET", "REPORT"], "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "datasets": { + "items": { + "properties": { + "description": { + "example": "This dataset contains a list of the op 20000 domains globally", + "type": "string" + }, + "id": { "example": 3, "type": "integer" }, + "meta": { "type": "object" }, + "tags": { "items": { "example": "global", "type": "string" }, "type": "array" }, + "title": { "example": "Top bucket 20000 domains", "type": "string" }, + "type": { "example": "RANKING_BUCKET", "type": "string" } + }, + "required": ["id", "title", "description", "type", "tags", "meta"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["datasets"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Datasets", + "tags": ["Radar Datasets"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/datasets/download": { + "post": { + "description": "Get a url to download a single dataset.", + "operationId": "radar_post_DatasetDownload", + "parameters": [ + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "datasetId": { "example": 3, "type": "integer" } }, + "required": ["datasetId"], + "type": "object" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "dataset": { + "properties": { "url": { "example": "https://example.com/download", "type": "string" } }, + "required": ["url"], + "type": "object" + } + }, + "required": ["dataset"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Dataset download url", + "tags": ["Radar Datasets"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/datasets/{alias}": { + "get": { + "description": "Get the csv content of a given dataset by alias or id. When getting the content by alias the latest dataset is returned, optionally filtered by the latest available at a given date.", + "operationId": "radar_get_DatasetStream", + "parameters": [ + { + "description": "Dataset alias or id", + "in": "path", + "name": "alias", + "required": true, + "schema": { "description": "Dataset alias or id", "example": "ranking_top_1000", "type": "string" } + }, + { + "description": "Filter dataset alias by date", + "in": "query", + "name": "date", + "schema": { + "description": "Filter dataset alias by date", + "example": "2022-09-15", + "format": "date", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "type": "object" } } }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Dataset csv Stream", + "tags": ["Radar Datasets"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/dns/top/ases": { + "get": { + "description": "Get top autonomous systems by DNS queries made to Cloudflare's public DNS resolver.", + "operationId": "radar_get_DnsTopAses", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of domain names.", + "in": "query", + "name": "domain", + "required": true, + "schema": { + "items": { "description": "Array of domain names.", "example": "google.com", "type": "string" }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientASN": { "example": 174, "type": "integer" }, + "clientASName": { "example": "Cogent-174", "type": "string" }, + "value": { "example": "65", "type": "string" } + }, + "required": ["clientASN", "clientASName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top autonomous systems by DNS queries.", + "tags": ["Radar DNS"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/dns/top/locations": { + "get": { + "description": "Get top locations by DNS queries made to Cloudflare's public DNS resolver.", + "operationId": "radar_get_DnsTopLocations", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of domain names.", + "in": "query", + "name": "domain", + "required": true, + "schema": { + "items": { "description": "Array of domain names.", "example": "google.com", "type": "string" }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientCountryAlpha2": { "example": "PT", "type": "string" }, + "clientCountryName": { "example": "Portugal", "type": "string" }, + "value": { "example": "65", "type": "string" } + }, + "required": ["clientCountryAlpha2", "clientCountryName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top locations by DNS queries", + "tags": ["Radar DNS"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/email/summary/arc": { + "get": { + "description": "Percentage distribution of emails classified per Arc validation.", + "operationId": "radar_get_EmailSecurityArcSummary", + "parameters": [ + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for dkim.", + "in": "query", + "name": "dkim", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dmarc.", + "in": "query", + "name": "dmarc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for spf.", + "in": "query", + "name": "spf", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "summary_0": { + "properties": { + "FAIL": { "example": "2", "type": "string" }, + "NONE": { "example": "53", "type": "string" }, + "PASS": { "example": "45", "type": "string" } + }, + "required": ["NONE", "PASS", "FAIL"], + "type": "object" + } + }, + "required": ["meta", "summary_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a summary of ARC validations", + "tags": ["Radar Email"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/email/summary/dkim": { + "get": { + "description": "Percentage distribution of emails classified per DKIM validation.", + "operationId": "radar_get_EmailSecurityDkimSummary", + "parameters": [ + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for arc (Authenticated Received Chain).", + "in": "query", + "name": "arc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dmarc.", + "in": "query", + "name": "dmarc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for spf.", + "in": "query", + "name": "spf", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "summary_0": { + "properties": { + "FAIL": { "example": "2", "type": "string" }, + "NONE": { "example": "53", "type": "string" }, + "PASS": { "example": "45", "type": "string" } + }, + "required": ["NONE", "PASS", "FAIL"], + "type": "object" + } + }, + "required": ["meta", "summary_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a summary of DKIM validations", + "tags": ["Radar Email"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/email/summary/dmarc": { + "get": { + "description": "Percentage distribution of emails classified per DMARC validation.", + "operationId": "radar_get_EmailSecurityDmarcSummary", + "parameters": [ + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for arc (Authenticated Received Chain).", + "in": "query", + "name": "arc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dkim.", + "in": "query", + "name": "dkim", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for spf.", + "in": "query", + "name": "spf", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "summary_0": { + "properties": { + "FAIL": { "example": "2", "type": "string" }, + "NONE": { "example": "53", "type": "string" }, + "PASS": { "example": "45", "type": "string" } + }, + "required": ["NONE", "PASS", "FAIL"], + "type": "object" + } + }, + "required": ["meta", "summary_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a summary of DMARC validations", + "tags": ["Radar Email"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/email/summary/malicious": { + "get": { + "description": "Percentage distribution of emails classified as MALICIOUS.", + "operationId": "radar_get_EmailSecurityMaliciousSummary", + "parameters": [ + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for arc (Authenticated Received Chain).", + "in": "query", + "name": "arc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dkim.", + "in": "query", + "name": "dkim", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dmarc.", + "in": "query", + "name": "dmarc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for spf.", + "in": "query", + "name": "spf", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "summary_0": { + "properties": { + "MALICIOUS": { "example": "65", "type": "string" }, + "NOT_MALICIOUS": { "example": "35", "type": "string" } + }, + "required": ["MALICIOUS", "NOT_MALICIOUS"], + "type": "object" + } + }, + "required": ["meta", "summary_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a summary of MALICIOUS validations", + "tags": ["Radar Email"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/email/summary/spam": { + "get": { + "description": "Percentage distribution of emails classified as SPAM.", + "operationId": "radar_get_EmailSecuritySpamSummary", + "parameters": [ + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for arc (Authenticated Received Chain).", + "in": "query", + "name": "arc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dkim.", + "in": "query", + "name": "dkim", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dmarc.", + "in": "query", + "name": "dmarc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for spf.", + "in": "query", + "name": "spf", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "summary_0": { + "properties": { + "NOT_SPAM": { "example": "35", "type": "string" }, + "SPAM": { "example": "65", "type": "string" } + }, + "required": ["SPAM", "NOT_SPAM"], + "type": "object" + } + }, + "required": ["meta", "summary_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a summary of SPAM validations", + "tags": ["Radar Email"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/email/summary/spf": { + "get": { + "description": "Percentage distribution of emails classified per SPF validation.", + "operationId": "radar_get_EmailSecuritySpfSummary", + "parameters": [ + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for arc (Authenticated Received Chain).", + "in": "query", + "name": "arc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dkim.", + "in": "query", + "name": "dkim", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dmarc.", + "in": "query", + "name": "dmarc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "summary_0": { + "properties": { + "FAIL": { "example": "2", "type": "string" }, + "NONE": { "example": "53", "type": "string" }, + "PASS": { "example": "45", "type": "string" } + }, + "required": ["NONE", "PASS", "FAIL"], + "type": "object" + } + }, + "required": ["meta", "summary_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a summary of SPF validations", + "tags": ["Radar Email"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/email/summary/threat_category": { + "get": { + "description": "Percentage distribution of emails classified in Threat Categories.", + "operationId": "radar_get_EmailSecurityThreatCategorySummary", + "parameters": [ + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for arc (Authenticated Received Chain).", + "in": "query", + "name": "arc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dkim.", + "in": "query", + "name": "dkim", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dmarc.", + "in": "query", + "name": "dmarc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for spf.", + "in": "query", + "name": "spf", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "summary_0": { + "properties": { + "BrandImpersonation": { "example": "35", "type": "string" }, + "CredentialHarvester": { "example": "32", "type": "string" }, + "IdentityDeception": { "example": "47", "type": "string" }, + "Link": { "example": "43", "type": "string" } + }, + "required": ["IdentityDeception", "Link", "BrandImpersonation", "CredentialHarvester"], + "type": "object" + } + }, + "required": ["meta", "summary_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a summary of Threat Categories", + "tags": ["Radar Email"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/email/timeseries/arc": { + "get": { + "description": "Percentage distribution of emails classified per Arc validation over time.", + "operationId": "radar_get_EmailSecurityArcTimeseriesGroup", + "parameters": [ + { + "description": "Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).", + "in": "query", + "name": "aggInterval", + "schema": { "enum": ["15m", "1h", "1d", "1w"], "type": "string" } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for dkim.", + "in": "query", + "name": "dkim", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dmarc.", + "in": "query", + "name": "dmarc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for spf.", + "in": "query", + "name": "spf", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "serie_0": { + "properties": { + "FAIL": { "items": { "example": "2", "type": "string" }, "type": "array" }, + "NONE": { "items": { "example": "53", "type": "string" }, "type": "array" }, + "PASS": { "items": { "example": "45", "type": "string" }, "type": "array" } + }, + "required": ["NONE", "PASS", "FAIL"], + "type": "object" + } + }, + "required": ["meta", "serie_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a time series of ARC validations", + "tags": ["Radar Email"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/email/timeseries/dkim": { + "get": { + "description": "Percentage distribution of emails classified per DKIM validation over time.", + "operationId": "radar_get_EmailSecurityDkimTimeseriesGroup", + "parameters": [ + { + "description": "Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).", + "in": "query", + "name": "aggInterval", + "schema": { "enum": ["15m", "1h", "1d", "1w"], "type": "string" } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for arc (Authenticated Received Chain).", + "in": "query", + "name": "arc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dmarc.", + "in": "query", + "name": "dmarc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for spf.", + "in": "query", + "name": "spf", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "serie_0": { + "properties": { + "FAIL": { "items": { "example": "2", "type": "string" }, "type": "array" }, + "NONE": { "items": { "example": "53", "type": "string" }, "type": "array" }, + "PASS": { "items": { "example": "45", "type": "string" }, "type": "array" } + }, + "required": ["NONE", "PASS", "FAIL"], + "type": "object" + } + }, + "required": ["meta", "serie_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a time series of DKIM validations validations", + "tags": ["Radar Email"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/email/timeseries/dmarc": { + "get": { + "description": "Percentage distribution of emails classified per DMARC validation over time.", + "operationId": "radar_get_EmailSecurityDmarcTimeseriesGroup", + "parameters": [ + { + "description": "Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).", + "in": "query", + "name": "aggInterval", + "schema": { "enum": ["15m", "1h", "1d", "1w"], "type": "string" } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for arc (Authenticated Received Chain).", + "in": "query", + "name": "arc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dkim.", + "in": "query", + "name": "dkim", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for spf.", + "in": "query", + "name": "spf", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "serie_0": { + "properties": { + "FAIL": { "items": { "example": "2", "type": "string" }, "type": "array" }, + "NONE": { "items": { "example": "53", "type": "string" }, "type": "array" }, + "PASS": { "items": { "example": "45", "type": "string" }, "type": "array" } + }, + "required": ["NONE", "PASS", "FAIL"], + "type": "object" + } + }, + "required": ["meta", "serie_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a time series of DMARC validations", + "tags": ["Radar Email"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/email/timeseries/malicious": { + "get": { + "description": "Percentage distribution of emails classified as MALICIOUS over time.", + "operationId": "radar_get_EmailSecurityMaliciousTimeseriesGroup", + "parameters": [ + { + "description": "Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).", + "in": "query", + "name": "aggInterval", + "schema": { "enum": ["15m", "1h", "1d", "1w"], "type": "string" } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for arc (Authenticated Received Chain).", + "in": "query", + "name": "arc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dkim.", + "in": "query", + "name": "dkim", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dmarc.", + "in": "query", + "name": "dmarc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for spf.", + "in": "query", + "name": "spf", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "serie_0": { + "properties": { + "MALICIOUS": { "items": { "example": "65", "type": "string" }, "type": "array" }, + "NOT_MALICIOUS": { "items": { "example": "35", "type": "string" }, "type": "array" } + }, + "required": ["MALICIOUS", "NOT_MALICIOUS"], + "type": "object" + } + }, + "required": ["meta", "serie_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a time series of MALICIOUS validations", + "tags": ["Radar Email"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/email/timeseries/spam": { + "get": { + "description": "Percentage distribution of emails classified as SPAM over time.", + "operationId": "radar_get_EmailSecuritySpamTimeseriesGroup", + "parameters": [ + { + "description": "Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).", + "in": "query", + "name": "aggInterval", + "schema": { "enum": ["15m", "1h", "1d", "1w"], "type": "string" } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for arc (Authenticated Received Chain).", + "in": "query", + "name": "arc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dkim.", + "in": "query", + "name": "dkim", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dmarc.", + "in": "query", + "name": "dmarc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for spf.", + "in": "query", + "name": "spf", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "serie_0": { + "properties": { + "NOT_SPAM": { "items": { "example": "35", "type": "string" }, "type": "array" }, + "SPAM": { "items": { "example": "65", "type": "string" }, "type": "array" } + }, + "required": ["SPAM", "NOT_SPAM"], + "type": "object" + } + }, + "required": ["meta", "serie_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a time series of SPAM validations", + "tags": ["Radar Email"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/email/timeseries/spf": { + "get": { + "description": "Percentage distribution of emails classified per SPF validation over time.", + "operationId": "radar_get_EmailSecuritySpfTimeseriesGroup", + "parameters": [ + { + "description": "Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).", + "in": "query", + "name": "aggInterval", + "schema": { "enum": ["15m", "1h", "1d", "1w"], "type": "string" } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for arc (Authenticated Received Chain).", + "in": "query", + "name": "arc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dkim.", + "in": "query", + "name": "dkim", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dmarc.", + "in": "query", + "name": "dmarc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "serie_0": { + "properties": { + "FAIL": { "items": { "example": "2", "type": "string" }, "type": "array" }, + "NONE": { "items": { "example": "53", "type": "string" }, "type": "array" }, + "PASS": { "items": { "example": "45", "type": "string" }, "type": "array" } + }, + "required": ["NONE", "PASS", "FAIL"], + "type": "object" + } + }, + "required": ["meta", "serie_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a time series of SPF validations", + "tags": ["Radar Email"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/email/timeseries/threat_category": { + "get": { + "description": "Percentage distribution of emails classified in Threat Categories over time.", + "operationId": "radar_get_EmailSecurityThreatCategoryTimeseriesGroup", + "parameters": [ + { + "description": "Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).", + "in": "query", + "name": "aggInterval", + "schema": { "enum": ["15m", "1h", "1d", "1w"], "type": "string" } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for arc (Authenticated Received Chain).", + "in": "query", + "name": "arc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dkim.", + "in": "query", + "name": "dkim", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dmarc.", + "in": "query", + "name": "dmarc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for spf.", + "in": "query", + "name": "spf", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "serie_0": { + "properties": { + "BrandImpersonation": { "items": { "example": "35", "type": "string" }, "type": "array" }, + "CredentialHarvester": { "items": { "example": "32", "type": "string" }, "type": "array" }, + "IdentityDeception": { "items": { "example": "47", "type": "string" }, "type": "array" }, + "Link": { "items": { "example": "43", "type": "string" }, "type": "array" } + }, + "required": ["IdentityDeception", "Link", "BrandImpersonation", "CredentialHarvester"], + "type": "object" + } + }, + "required": ["meta", "serie_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a time series of Threat Categories", + "tags": ["Radar Email"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/email/top/ases": { + "get": { + "description": "Get the top autonomous systems (AS) by HTTP traffic. Values are a percentage out of the total traffic.", + "operationId": "radar_get_EmailSecurityTopASes", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for arc (Authenticated Received Chain).", + "in": "query", + "name": "arc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dkim.", + "in": "query", + "name": "dkim", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dmarc.", + "in": "query", + "name": "dmarc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for spf.", + "in": "query", + "name": "spf", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientASN": { "example": 3243, "type": "integer" }, + "clientASName": { "example": "MEO", "type": "string" }, + "value": { "example": "3", "type": "string" } + }, + "required": ["clientASN", "clientASName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top autonomous systems by HTTP requests", + "tags": ["Radar Email"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/email/top/ases/arc/{arc}": { + "get": { + "description": "Get the top autonomous systems (AS), by emails classified, of ARC validations.", + "operationId": "radar_get_EmailSecurityTopASesByArc", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for dkim.", + "in": "query", + "name": "dkim", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dmarc.", + "in": "query", + "name": "dmarc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for spf.", + "in": "query", + "name": "spf", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "ARC.", + "in": "path", + "name": "arc", + "required": true, + "schema": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientASN": { "example": 3243, "type": "integer" }, + "clientASName": { "example": "MEO", "type": "string" }, + "value": { "example": "3", "type": "string" } + }, + "required": ["clientASN", "clientASName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top autonomous systems by ARC validations", + "tags": ["Radar Email"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/email/top/ases/dkim/{dkim}": { + "get": { + "description": "Get the top autonomous systems (AS), by emails classified, of DKIM validations.", + "operationId": "radar_get_EmailSecurityTopASesByDkim", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for arc (Authenticated Received Chain).", + "in": "query", + "name": "arc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dmarc.", + "in": "query", + "name": "dmarc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for spf.", + "in": "query", + "name": "spf", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "DKIM.", + "in": "path", + "name": "dkim", + "required": true, + "schema": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientASN": { "example": 3243, "type": "integer" }, + "clientASName": { "example": "MEO", "type": "string" }, + "value": { "example": "3", "type": "string" } + }, + "required": ["clientASN", "clientASName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top autonomous systems by DKIM validations", + "tags": ["Radar Email"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/email/top/ases/dmarc/{dmarc}": { + "get": { + "description": "Get the top autonomous systems (AS), by emails classified, of DMARC validations.", + "operationId": "radar_get_EmailSecurityTopASesByDmarc", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for arc (Authenticated Received Chain).", + "in": "query", + "name": "arc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dkim.", + "in": "query", + "name": "dkim", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for spf.", + "in": "query", + "name": "spf", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "DMARC.", + "in": "path", + "name": "dmarc", + "required": true, + "schema": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientASN": { "example": 3243, "type": "integer" }, + "clientASName": { "example": "MEO", "type": "string" }, + "value": { "example": "3", "type": "string" } + }, + "required": ["clientASN", "clientASName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top autonomous systems by DMARC validations", + "tags": ["Radar Email"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/email/top/ases/malicious/{malicious}": { + "get": { + "description": "Get the top autonomous systems (AS), by emails classified, of Malicious validations.", + "operationId": "radar_get_EmailSecurityTopASesByMalicious", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for arc (Authenticated Received Chain).", + "in": "query", + "name": "arc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dkim.", + "in": "query", + "name": "dkim", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dmarc.", + "in": "query", + "name": "dmarc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for spf.", + "in": "query", + "name": "spf", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Malicious.", + "in": "path", + "name": "malicious", + "required": true, + "schema": { "enum": ["MALICIOUS", "NOT_MALICIOUS"], "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientASN": { "example": 3243, "type": "integer" }, + "clientASName": { "example": "MEO", "type": "string" }, + "value": { "example": "3", "type": "string" } + }, + "required": ["clientASN", "clientASName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top autonomous systems by Malicious validations", + "tags": ["Radar Email"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/email/top/ases/spam/{spam}": { + "get": { + "description": "Get the top autonomous systems (AS), by emails classified, of Spam validations.", + "operationId": "radar_get_EmailSecurityTopASesBySpam", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for arc (Authenticated Received Chain).", + "in": "query", + "name": "arc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dkim.", + "in": "query", + "name": "dkim", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dmarc.", + "in": "query", + "name": "dmarc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for spf.", + "in": "query", + "name": "spf", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Spam.", + "in": "path", + "name": "spam", + "required": true, + "schema": { "enum": ["SPAM", "NOT_SPAM"], "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientASN": { "example": 3243, "type": "integer" }, + "clientASName": { "example": "MEO", "type": "string" }, + "value": { "example": "3", "type": "string" } + }, + "required": ["clientASN", "clientASName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top autonomous systems by Spam validations", + "tags": ["Radar Email"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/email/top/ases/spf/{spf}": { + "get": { + "description": "Get the top autonomous systems (AS), by emails classified, of SPF validations.", + "operationId": "radar_get_EmailSecurityTopASesBySpf", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for arc (Authenticated Received Chain).", + "in": "query", + "name": "arc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dkim.", + "in": "query", + "name": "dkim", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dmarc.", + "in": "query", + "name": "dmarc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "SPF.", + "in": "path", + "name": "spf", + "required": true, + "schema": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientASN": { "example": 3243, "type": "integer" }, + "clientASName": { "example": "MEO", "type": "string" }, + "value": { "example": "3", "type": "string" } + }, + "required": ["clientASN", "clientASName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top autonomous systems by SPF validations", + "tags": ["Radar Email"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/email/top/locations": { + "get": { + "description": "Get the top locations by HTTP traffic. Values are a percentage out of the total traffic.", + "operationId": "radar_get_EmailSecurityTopLocations", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for arc (Authenticated Received Chain).", + "in": "query", + "name": "arc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dkim.", + "in": "query", + "name": "dkim", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dmarc.", + "in": "query", + "name": "dmarc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for spf.", + "in": "query", + "name": "spf", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientCountryAlpha2": { "example": "US", "type": "string" }, + "clientCountryName": { "example": "United States", "type": "string" }, + "value": { "example": "65", "type": "string" } + }, + "required": ["clientCountryAlpha2", "clientCountryName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top autonomous systems by HTTP requests", + "tags": ["Radar Email"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/email/top/locations/arc/{arc}": { + "get": { + "description": "Get the locations, by emails classified, of ARC validations.", + "operationId": "radar_get_EmailSecurityTopLocationsByArc", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for dkim.", + "in": "query", + "name": "dkim", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dmarc.", + "in": "query", + "name": "dmarc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for spf.", + "in": "query", + "name": "spf", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "ARC.", + "in": "path", + "name": "arc", + "required": true, + "schema": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientCountryAlpha2": { "example": "US", "type": "string" }, + "clientCountryName": { "example": "United States", "type": "string" }, + "value": { "example": "65", "type": "string" } + }, + "required": ["clientCountryAlpha2", "clientCountryName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top locations by ARC validations", + "tags": ["Radar Email"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/email/top/locations/dkim/{dkim}": { + "get": { + "description": "Get the locations, by emails classified, of DKIM validations.", + "operationId": "radar_get_EmailSecurityTopLocationsByDkim", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for arc (Authenticated Received Chain).", + "in": "query", + "name": "arc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dmarc.", + "in": "query", + "name": "dmarc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for spf.", + "in": "query", + "name": "spf", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "DKIM.", + "in": "path", + "name": "dkim", + "required": true, + "schema": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientCountryAlpha2": { "example": "US", "type": "string" }, + "clientCountryName": { "example": "United States", "type": "string" }, + "value": { "example": "65", "type": "string" } + }, + "required": ["clientCountryAlpha2", "clientCountryName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top locations by DKIM validations", + "tags": ["Radar Email"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/email/top/locations/dmarc/{dmarc}": { + "get": { + "description": "Get the locations, by emails classified, of DMARC validations.", + "operationId": "radar_get_EmailSecurityTopLocationsByDmarc", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for arc (Authenticated Received Chain).", + "in": "query", + "name": "arc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dkim.", + "in": "query", + "name": "dkim", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for spf.", + "in": "query", + "name": "spf", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "DMARC.", + "in": "path", + "name": "dmarc", + "required": true, + "schema": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientCountryAlpha2": { "example": "US", "type": "string" }, + "clientCountryName": { "example": "United States", "type": "string" }, + "value": { "example": "65", "type": "string" } + }, + "required": ["clientCountryAlpha2", "clientCountryName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top locations by DMARC validations", + "tags": ["Radar Email"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/email/top/locations/malicious/{malicious}": { + "get": { + "description": "Get the locations, by emails classified, of Malicious validations.", + "operationId": "radar_get_EmailSecurityTopLocationsByMalicious", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for arc (Authenticated Received Chain).", + "in": "query", + "name": "arc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dkim.", + "in": "query", + "name": "dkim", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dmarc.", + "in": "query", + "name": "dmarc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for spf.", + "in": "query", + "name": "spf", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Malicious.", + "in": "path", + "name": "malicious", + "required": true, + "schema": { "enum": ["MALICIOUS", "NOT_MALICIOUS"], "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientCountryAlpha2": { "example": "US", "type": "string" }, + "clientCountryName": { "example": "United States", "type": "string" }, + "value": { "example": "65", "type": "string" } + }, + "required": ["clientCountryAlpha2", "clientCountryName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top locations by Malicious validations", + "tags": ["Radar Email"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/email/top/locations/spam/{spam}": { + "get": { + "description": "Get the locations, by emails classified, of Spam validations.", + "operationId": "radar_get_EmailSecurityTopLocationsBySpam", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for arc (Authenticated Received Chain).", + "in": "query", + "name": "arc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dkim.", + "in": "query", + "name": "dkim", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dmarc.", + "in": "query", + "name": "dmarc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for spf.", + "in": "query", + "name": "spf", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Spam.", + "in": "path", + "name": "spam", + "required": true, + "schema": { "enum": ["SPAM", "NOT_SPAM"], "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientCountryAlpha2": { "example": "US", "type": "string" }, + "clientCountryName": { "example": "United States", "type": "string" }, + "value": { "example": "65", "type": "string" } + }, + "required": ["clientCountryAlpha2", "clientCountryName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top locations by Spam validations", + "tags": ["Radar Email"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/email/top/locations/spf/{spf}": { + "get": { + "description": "Get the locations, by emails classified, of SPF validations.", + "operationId": "radar_get_EmailSecurityTopLocationsBySpf", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for arc (Authenticated Received Chain).", + "in": "query", + "name": "arc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dkim.", + "in": "query", + "name": "dkim", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for dmarc.", + "in": "query", + "name": "dmarc", + "schema": { "items": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" }, "type": "array" } + }, + { + "description": "SPF.", + "in": "path", + "name": "spf", + "required": true, + "schema": { "enum": ["PASS", "NONE", "FAIL"], "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientCountryAlpha2": { "example": "US", "type": "string" }, + "clientCountryName": { "example": "United States", "type": "string" }, + "value": { "example": "65", "type": "string" } + }, + "required": ["clientCountryAlpha2", "clientCountryName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top locations by SPF validations", + "tags": ["Radar Email"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/entities/asns": { + "get": { + "description": "Gets a list of autonomous systems (AS).", + "operationId": "radar_get_ASNsList", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Number of objects to skip before grabbing results.", + "in": "query", + "name": "offset", + "schema": { + "default": 0, + "description": "Number of objects to skip before grabbing results.", + "example": 0, + "type": "integer" + } + }, + { + "description": "Comma separated list of ASNs.", + "in": "query", + "name": "asn", + "schema": { "description": "Comma separated list of ASNs.", "example": "174,7922", "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "asns": { + "items": { + "properties": { + "aka": { "type": "string" }, + "asn": { "example": 714, "type": "integer" }, + "country": { "example": "GB", "type": "string" }, + "countryName": { "example": "United Kingdom", "type": "string" }, + "name": { "example": "Apple Inc.", "type": "string" }, + "nameLong": { "type": "string" }, + "orgName": { "type": "string" }, + "website": { "example": "https://www.apple.com/support/systemstatus/", "type": "string" } + }, + "required": [ + "name", + "nameLong", + "aka", + "asn", + "website", + "country", + "countryName", + "orgName" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": ["asns"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get autonomous systems", + "tags": ["Radar Entities"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/entities/asns/ip": { + "get": { + "description": "Get the requested autonomous system information based on IP address. Population estimates come from APNIC (refer to https://labs.apnic.net/?p=526).", + "operationId": "radar_get_ASNIp", + "parameters": [ + { + "description": "IP address.", + "in": "query", + "name": "ip", + "required": true, + "schema": { "description": "IP address.", "example": "1.1.1.1", "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "asn": { + "properties": { + "aka": { "type": "string" }, + "asn": { "example": 714, "type": "integer" }, + "country": { "example": "GB", "type": "string" }, + "countryName": { "example": "United Kingdom", "type": "string" }, + "estimatedUsers": { + "properties": { + "estimatedUsers": { + "description": "Total estimated users", + "example": 86099, + "type": "integer" + }, + "locations": { + "items": { + "properties": { + "estimatedUsers": { + "description": "Estimated users per location", + "example": 16710, + "type": "integer" + }, + "locationAlpha2": { "example": "US", "type": "string" }, + "locationName": { "example": "United States", "type": "string" } + }, + "required": ["estimatedUsers", "locationName", "locationAlpha2"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["locations"], + "type": "object" + }, + "name": { "example": "Apple Inc.", "type": "string" }, + "nameLong": { "type": "string" }, + "orgName": { "type": "string" }, + "related": { + "items": { + "properties": { + "aka": { "type": "string" }, + "asn": { "type": "integer" }, + "estimatedUsers": { + "description": "Total estimated users", + "example": 65345, + "type": "integer" + }, + "name": { "type": "string" } + }, + "required": ["name", "aka", "asn"], + "type": "object" + }, + "type": "array" + }, + "website": { "example": "https://www.apple.com/support/systemstatus/", "type": "string" } + }, + "required": [ + "name", + "nameLong", + "aka", + "country", + "countryName", + "related", + "asn", + "website", + "orgName", + "estimatedUsers" + ], + "type": "object" + } + }, + "required": ["asn"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get autonomous system information by IP address", + "tags": ["Radar Entities"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/entities/asns/{asn}": { + "get": { + "description": "Get the requested autonomous system information. A confidence level below `5` indicates a low level of confidence in the traffic data - normally this happens because Cloudflare has a small amount of traffic from/to this AS). Population estimates come from APNIC (refer to https://labs.apnic.net/?p=526).", + "operationId": "radar_get_ASNId", + "parameters": [ + { + "description": "Autonomous System Number (ASN).", + "in": "path", + "name": "asn", + "required": true, + "schema": { "description": "Autonomous System Number (ASN).", "example": 3, "type": "integer" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "asn": { + "properties": { + "aka": { "type": "string" }, + "asn": { "example": 714, "type": "integer" }, + "confidenceLevel": { "example": 5, "type": "integer" }, + "country": { "example": "GB", "type": "string" }, + "countryName": { "example": "United Kingdom", "type": "string" }, + "estimatedUsers": { + "properties": { + "estimatedUsers": { + "description": "Total estimated users", + "example": 86099, + "type": "integer" + }, + "locations": { + "items": { + "properties": { + "estimatedUsers": { + "description": "Estimated users per location", + "example": 16710, + "type": "integer" + }, + "locationAlpha2": { "example": "US", "type": "string" }, + "locationName": { "example": "United States", "type": "string" } + }, + "required": ["estimatedUsers", "locationName", "locationAlpha2"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["locations"], + "type": "object" + }, + "name": { "example": "Apple Inc.", "type": "string" }, + "nameLong": { "type": "string" }, + "orgName": { "type": "string" }, + "related": { + "items": { + "properties": { + "aka": { "example": "", "type": "string" }, + "asn": { "example": 174, "type": "integer" }, + "estimatedUsers": { + "description": "Total estimated users", + "example": 65345, + "type": "integer" + }, + "name": { "example": "Cogent-174", "type": "string" } + }, + "required": ["name", "aka", "asn"], + "type": "object" + }, + "type": "array" + }, + "website": { "example": "https://www.apple.com/support/systemstatus/", "type": "string" } + }, + "required": [ + "name", + "nameLong", + "aka", + "country", + "countryName", + "confidenceLevel", + "related", + "asn", + "website", + "orgName", + "estimatedUsers" + ], + "type": "object" + } + }, + "required": ["asn"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get autonomous system information by AS number", + "tags": ["Radar Entities"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/entities/locations": { + "get": { + "description": "Get a list of locations.", + "operationId": "radar_get_LocationsList", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Number of objects to skip before grabbing results.", + "in": "query", + "name": "offset", + "schema": { + "default": 0, + "description": "Number of objects to skip before grabbing results.", + "example": 0, + "type": "integer" + } + }, + { + "description": "Comma separated list of locations.", + "in": "query", + "name": "location", + "schema": { "description": "Comma separated list of locations.", "example": "US,CA", "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "locations": { + "items": { + "properties": { + "alpha2": { "example": "AF", "type": "string" }, + "latitude": { "example": 33.939116, "type": "string" }, + "longitude": { "example": 67.709953, "type": "string" }, + "name": { "example": "Afghanistan", "type": "string" } + }, + "required": ["name", "latitude", "longitude", "alpha2"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["locations"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get locations", + "tags": ["Radar Entities"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/entities/locations/{location}": { + "get": { + "description": "Get the requested location information. A confidence level below `5` indicates a low level of confidence in the traffic data - normally this happens because Cloudflare has a small amount of traffic from/to this location).", + "operationId": "radar_get_LocationsOne", + "parameters": [ + { + "description": "Alpha-2 country code.", + "in": "path", + "name": "location", + "required": true, + "schema": { "description": "Alpha-2 country code.", "example": "US", "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "location": { + "properties": { + "alpha2": { "example": "AF", "type": "string" }, + "confidenceLevel": { "example": 5, "type": "integer" }, + "latitude": { "example": 33.939116, "type": "string" }, + "longitude": { "example": 67.709953, "type": "string" }, + "name": { "example": "Afghanistan", "type": "string" }, + "region": { "example": "Middle East", "type": "string" }, + "subregion": { "example": "Southern Asia", "type": "string" } + }, + "required": [ + "name", + "region", + "subregion", + "latitude", + "longitude", + "alpha2", + "confidenceLevel" + ], + "type": "object" + } + }, + "required": ["location"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get location", + "tags": ["Radar Entities"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/http/summary/bot_class": { + "get": { + "description": "Percentage distribution of traffic classified as automated or human.", + "operationId": "radar_get_SummaryBotClass", + "parameters": [ + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for device type.", + "in": "query", + "name": "deviceType", + "schema": { "items": { "enum": ["DESKTOP", "MOBILE", "OTHER"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http protocol.", + "in": "query", + "name": "httpProtocol", + "schema": { "items": { "enum": ["HTTP", "HTTPS"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http version.", + "in": "query", + "name": "httpVersion", + "schema": { "items": { "enum": ["HTTPv1", "HTTPv2", "HTTPv3"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for ip version.", + "in": "query", + "name": "ipVersion", + "schema": { "items": { "enum": ["IPv4", "IPv6"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for os name.", + "in": "query", + "name": "os", + "schema": { + "items": { "enum": ["WINDOWS", "MACOSX", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Filter for tls version.", + "in": "query", + "name": "tlsVersion", + "schema": { + "items": { "enum": ["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "summary_0": { + "properties": { + "bot": { "example": "35", "type": "string" }, + "human": { "example": "65", "type": "string" } + }, + "required": ["human", "bot"], + "type": "object" + } + }, + "required": ["meta", "summary_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a summary of bot classes", + "tags": ["Radar Http"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/http/summary/device_type": { + "get": { + "description": "Percentage distribution of traffic per device type.", + "operationId": "radar_get_SummaryDeviceType", + "parameters": [ + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).", + "in": "query", + "name": "botClass", + "schema": { "items": { "enum": ["LIKELY_AUTOMATED", "LIKELY_HUMAN"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http protocol.", + "in": "query", + "name": "httpProtocol", + "schema": { "items": { "enum": ["HTTP", "HTTPS"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http version.", + "in": "query", + "name": "httpVersion", + "schema": { "items": { "enum": ["HTTPv1", "HTTPv2", "HTTPv3"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for ip version.", + "in": "query", + "name": "ipVersion", + "schema": { "items": { "enum": ["IPv4", "IPv6"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for os name.", + "in": "query", + "name": "os", + "schema": { + "items": { "enum": ["WINDOWS", "MACOSX", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Filter for tls version.", + "in": "query", + "name": "tlsVersion", + "schema": { + "items": { "enum": ["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "summary_0": { + "properties": { + "desktop": { "example": "65", "type": "string" }, + "mobile": { "example": "30", "type": "string" }, + "other": { "example": "5", "type": "string" } + }, + "required": ["desktop", "mobile", "other"], + "type": "object" + } + }, + "required": ["meta", "summary_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a summary of device types", + "tags": ["Radar Http"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/http/summary/http_protocol": { + "get": { + "description": "Percentage distribution of traffic per HTTP protocol.", + "operationId": "radar_get_SummaryHttpProtocol", + "parameters": [ + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).", + "in": "query", + "name": "botClass", + "schema": { "items": { "enum": ["LIKELY_AUTOMATED", "LIKELY_HUMAN"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for device type.", + "in": "query", + "name": "deviceType", + "schema": { "items": { "enum": ["DESKTOP", "MOBILE", "OTHER"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http version.", + "in": "query", + "name": "httpVersion", + "schema": { "items": { "enum": ["HTTPv1", "HTTPv2", "HTTPv3"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for ip version.", + "in": "query", + "name": "ipVersion", + "schema": { "items": { "enum": ["IPv4", "IPv6"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for os name.", + "in": "query", + "name": "os", + "schema": { + "items": { "enum": ["WINDOWS", "MACOSX", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Filter for tls version.", + "in": "query", + "name": "tlsVersion", + "schema": { + "items": { "enum": ["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "summary_0": { + "properties": { + "http": { "example": "99", "type": "string" }, + "https": { "example": "1", "type": "string" } + }, + "required": ["http", "https"], + "type": "object" + } + }, + "required": ["meta", "summary_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a summary of HTTP protocols", + "tags": ["Radar Http"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/http/summary/http_version": { + "get": { + "description": "Percentage distribution of traffic per HTTP protocol version.", + "operationId": "radar_get_SummaryHttpVersion", + "parameters": [ + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).", + "in": "query", + "name": "botClass", + "schema": { "items": { "enum": ["LIKELY_AUTOMATED", "LIKELY_HUMAN"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for device type.", + "in": "query", + "name": "deviceType", + "schema": { "items": { "enum": ["DESKTOP", "MOBILE", "OTHER"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http protocol.", + "in": "query", + "name": "httpProtocol", + "schema": { "items": { "enum": ["HTTP", "HTTPS"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for ip version.", + "in": "query", + "name": "ipVersion", + "schema": { "items": { "enum": ["IPv4", "IPv6"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for os name.", + "in": "query", + "name": "os", + "schema": { + "items": { "enum": ["WINDOWS", "MACOSX", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Filter for tls version.", + "in": "query", + "name": "tlsVersion", + "schema": { + "items": { "enum": ["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "summary_0": { + "properties": { + "HTTP/1.x": { "example": "1", "type": "string" }, + "HTTP/2": { "example": "39", "type": "string" }, + "HTTP/3": { "example": "60", "type": "string" } + }, + "required": ["HTTP/1.x", "HTTP/2", "HTTP/3"], + "type": "object" + } + }, + "required": ["meta", "summary_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a summary of HTTP versions", + "tags": ["Radar Http"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/http/summary/ip_version": { + "get": { + "description": "Percentage distribution of traffic per IP protocol version.", + "operationId": "radar_get_SummaryIpVersion", + "parameters": [ + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).", + "in": "query", + "name": "botClass", + "schema": { "items": { "enum": ["LIKELY_AUTOMATED", "LIKELY_HUMAN"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for device type.", + "in": "query", + "name": "deviceType", + "schema": { "items": { "enum": ["DESKTOP", "MOBILE", "OTHER"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http protocol.", + "in": "query", + "name": "httpProtocol", + "schema": { "items": { "enum": ["HTTP", "HTTPS"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http version.", + "in": "query", + "name": "httpVersion", + "schema": { "items": { "enum": ["HTTPv1", "HTTPv2", "HTTPv3"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for os name.", + "in": "query", + "name": "os", + "schema": { + "items": { "enum": ["WINDOWS", "MACOSX", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Filter for tls version.", + "in": "query", + "name": "tlsVersion", + "schema": { + "items": { "enum": ["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "summary_0": { + "properties": { + "IPv4": { "example": "65", "type": "string" }, + "IPv6": { "example": "35", "type": "string" } + }, + "required": ["IPv4", "IPv6"], + "type": "object" + } + }, + "required": ["meta", "summary_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a summary of IP versions", + "tags": ["Radar Http"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/http/summary/os": { + "get": { + "description": "Percentage distribution of traffic per operating system.", + "operationId": "radar_get_SummaryOS", + "parameters": [ + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).", + "in": "query", + "name": "botClass", + "schema": { "items": { "enum": ["LIKELY_AUTOMATED", "LIKELY_HUMAN"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for device type.", + "in": "query", + "name": "deviceType", + "schema": { "items": { "enum": ["DESKTOP", "MOBILE", "OTHER"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http protocol.", + "in": "query", + "name": "httpProtocol", + "schema": { "items": { "enum": ["HTTP", "HTTPS"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http version.", + "in": "query", + "name": "httpVersion", + "schema": { "items": { "enum": ["HTTPv1", "HTTPv2", "HTTPv3"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for ip version.", + "in": "query", + "name": "ipVersion", + "schema": { "items": { "enum": ["IPv4", "IPv6"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for tls version.", + "in": "query", + "name": "tlsVersion", + "schema": { + "items": { "enum": ["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "summary_0": { + "properties": { + "ANDROID": { "example": "65", "type": "string" }, + "IOS": { "example": "35", "type": "string" } + }, + "required": ["ANDROID", "IOS"], + "type": "object" + } + }, + "required": ["meta", "summary_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a summary of operating systems", + "tags": ["Radar Http"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/http/summary/tls_version": { + "get": { + "description": "Percentage distribution of traffic per TLS protocol version.", + "operationId": "radar_get_SummaryTLSVersion", + "parameters": [ + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).", + "in": "query", + "name": "botClass", + "schema": { "items": { "enum": ["LIKELY_AUTOMATED", "LIKELY_HUMAN"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for device type.", + "in": "query", + "name": "deviceType", + "schema": { "items": { "enum": ["DESKTOP", "MOBILE", "OTHER"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http protocol.", + "in": "query", + "name": "httpProtocol", + "schema": { "items": { "enum": ["HTTP", "HTTPS"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http version.", + "in": "query", + "name": "httpVersion", + "schema": { "items": { "enum": ["HTTPv1", "HTTPv2", "HTTPv3"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for ip version.", + "in": "query", + "name": "ipVersion", + "schema": { "items": { "enum": ["IPv4", "IPv6"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for os name.", + "in": "query", + "name": "os", + "schema": { + "items": { "enum": ["WINDOWS", "MACOSX", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "summary_0": { + "properties": { + "TLS 1.0": { "example": "0.5", "type": "string" }, + "TLS 1.1": { "example": "0.5", "type": "string" }, + "TLS 1.2": { "example": "60", "type": "string" }, + "TLS 1.3": { "example": "10", "type": "string" }, + "TLS QUIC": { "example": "29", "type": "string" } + }, + "required": ["TLS 1.0", "TLS 1.1", "TLS 1.2", "TLS 1.3", "TLS QUIC"], + "type": "object" + } + }, + "required": ["meta", "summary_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a summary of TLS versions", + "tags": ["Radar Http"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/http/timeseries/bot_class": { + "get": { + "description": "Percentage distribution of traffic classified as automated or human over time.", + "operationId": "radar_get_TimeseriesBotClass", + "parameters": [ + { + "description": "Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).", + "in": "query", + "name": "aggInterval", + "schema": { "enum": ["15m", "1h", "1d", "1w"], "type": "string" } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for device type.", + "in": "query", + "name": "deviceType", + "schema": { "items": { "enum": ["DESKTOP", "MOBILE", "OTHER"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http protocol.", + "in": "query", + "name": "httpProtocol", + "schema": { "items": { "enum": ["HTTP", "HTTPS"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http version.", + "in": "query", + "name": "httpVersion", + "schema": { "items": { "enum": ["HTTPv1", "HTTPv2", "HTTPv3"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for ip version.", + "in": "query", + "name": "ipVersion", + "schema": { "items": { "enum": ["IPv4", "IPv6"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for os name.", + "in": "query", + "name": "os", + "schema": { + "items": { "enum": ["WINDOWS", "MACOSX", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Filter for tls version.", + "in": "query", + "name": "tlsVersion", + "schema": { + "items": { "enum": ["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "serie_0": { + "properties": { + "bot": { "items": { "type": "string" }, "type": "array" }, + "human": { "items": { "type": "string" }, "type": "array" }, + "timestamps": { "items": { "type": "string" }, "type": "array" } + }, + "required": ["timestamps", "human", "bot"], + "type": "object" + } + }, + "required": ["meta", "serie_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get time series of bot classes", + "tags": ["Radar Http"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/http/timeseries/browser": { + "get": { + "description": "Percentage distribution of traffic of the top user agents in the selected time range, over time.", + "operationId": "radar_get_TimeseriesBrowsers", + "parameters": [ + { + "description": "Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).", + "in": "query", + "name": "aggInterval", + "schema": { "enum": ["15m", "1h", "1d", "1w"], "type": "string" } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for device type.", + "in": "query", + "name": "deviceType", + "schema": { "items": { "enum": ["DESKTOP", "MOBILE", "OTHER"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http protocol.", + "in": "query", + "name": "httpProtocol", + "schema": { "items": { "enum": ["HTTP", "HTTPS"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http version.", + "in": "query", + "name": "httpVersion", + "schema": { "items": { "enum": ["HTTPv1", "HTTPv2", "HTTPv3"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for ip version.", + "in": "query", + "name": "ipVersion", + "schema": { "items": { "enum": ["IPv4", "IPv6"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for os name.", + "in": "query", + "name": "os", + "schema": { + "items": { "enum": ["WINDOWS", "MACOSX", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Filter for tls version.", + "in": "query", + "name": "tlsVersion", + "schema": { + "items": { "enum": ["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Limit the number of objects (eg browsers) to the top items over the time range.", + "in": "query", + "name": "limitPerGroup", + "schema": { + "description": "Limit the number of objects (eg browsers) to the top items over the time range.", + "example": 2, + "type": "integer" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "serie_0": { + "properties": { + "\u003cbrowser name\u003e": { "items": { "type": "string" }, "type": "array" }, + "timestamps": { "items": { "type": "string" }, "type": "array" } + }, + "required": ["timestamps", "\u003cbrowser name\u003e"], + "type": "object" + } + }, + "required": ["meta", "serie_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get time series of user agents", + "tags": ["Radar Http"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/http/timeseries/browser_family": { + "get": { + "description": "Percentage distribution of traffic of the top user agents aggregated in families in the selected time range, over time.", + "operationId": "radar_get_TimeseriesBrowserFamilies", + "parameters": [ + { + "description": "Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).", + "in": "query", + "name": "aggInterval", + "schema": { "enum": ["15m", "1h", "1d", "1w"], "type": "string" } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for device type.", + "in": "query", + "name": "deviceType", + "schema": { "items": { "enum": ["DESKTOP", "MOBILE", "OTHER"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http protocol.", + "in": "query", + "name": "httpProtocol", + "schema": { "items": { "enum": ["HTTP", "HTTPS"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http version.", + "in": "query", + "name": "httpVersion", + "schema": { "items": { "enum": ["HTTPv1", "HTTPv2", "HTTPv3"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for ip version.", + "in": "query", + "name": "ipVersion", + "schema": { "items": { "enum": ["IPv4", "IPv6"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for os name.", + "in": "query", + "name": "os", + "schema": { + "items": { "enum": ["WINDOWS", "MACOSX", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Filter for tls version.", + "in": "query", + "name": "tlsVersion", + "schema": { + "items": { "enum": ["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "serie_0": { + "properties": { + "\u003cbrowser name\u003e": { "items": { "type": "string" }, "type": "array" }, + "timestamps": { "items": { "type": "string" }, "type": "array" } + }, + "required": ["timestamps", "\u003cbrowser name\u003e"], + "type": "object" + } + }, + "required": ["meta", "serie_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get time series of user agents aggregated in families", + "tags": ["Radar Http"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/http/timeseries/device_type": { + "get": { + "description": "Percentage distribution of traffic per device type over time.", + "operationId": "radar_get_TimeseriesDeviceType", + "parameters": [ + { + "description": "Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).", + "in": "query", + "name": "aggInterval", + "schema": { "enum": ["15m", "1h", "1d", "1w"], "type": "string" } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).", + "in": "query", + "name": "botClass", + "schema": { "items": { "enum": ["LIKELY_AUTOMATED", "LIKELY_HUMAN"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http protocol.", + "in": "query", + "name": "httpProtocol", + "schema": { "items": { "enum": ["HTTP", "HTTPS"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http version.", + "in": "query", + "name": "httpVersion", + "schema": { "items": { "enum": ["HTTPv1", "HTTPv2", "HTTPv3"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for ip version.", + "in": "query", + "name": "ipVersion", + "schema": { "items": { "enum": ["IPv4", "IPv6"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for os name.", + "in": "query", + "name": "os", + "schema": { + "items": { "enum": ["WINDOWS", "MACOSX", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Filter for tls version.", + "in": "query", + "name": "tlsVersion", + "schema": { + "items": { "enum": ["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "serie_0": { + "properties": { + "desktop": { "items": { "type": "string" }, "type": "array" }, + "mobile": { "items": { "type": "string" }, "type": "array" }, + "other": { "items": { "type": "string" }, "type": "array" }, + "timestamps": { "items": { "type": "string" }, "type": "array" } + }, + "required": ["timestamps", "desktop", "mobile", "other"], + "type": "object" + } + }, + "required": ["meta", "serie_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get time series of device types", + "tags": ["Radar Http"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/http/timeseries/http_protocol": { + "get": { + "description": "Percentage distribution of traffic per HTTP protocol over time.", + "operationId": "radar_get_TimeseriesHttpProtocol", + "parameters": [ + { + "description": "Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).", + "in": "query", + "name": "aggInterval", + "schema": { "enum": ["15m", "1h", "1d", "1w"], "type": "string" } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).", + "in": "query", + "name": "botClass", + "schema": { "items": { "enum": ["LIKELY_AUTOMATED", "LIKELY_HUMAN"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for device type.", + "in": "query", + "name": "deviceType", + "schema": { "items": { "enum": ["DESKTOP", "MOBILE", "OTHER"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http version.", + "in": "query", + "name": "httpVersion", + "schema": { "items": { "enum": ["HTTPv1", "HTTPv2", "HTTPv3"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for ip version.", + "in": "query", + "name": "ipVersion", + "schema": { "items": { "enum": ["IPv4", "IPv6"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for os name.", + "in": "query", + "name": "os", + "schema": { + "items": { "enum": ["WINDOWS", "MACOSX", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Filter for tls version.", + "in": "query", + "name": "tlsVersion", + "schema": { + "items": { "enum": ["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "serie_0": { + "properties": { + "http": { "items": { "type": "string" }, "type": "array" }, + "https": { "items": { "type": "string" }, "type": "array" }, + "timestamps": { "items": { "type": "string" }, "type": "array" } + }, + "required": ["timestamps", "http", "https"], + "type": "object" + } + }, + "required": ["meta", "serie_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get time series of HTTP protocols", + "tags": ["Radar Http"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/http/timeseries/http_version": { + "get": { + "description": "Percentage distribution of traffic per HTTP protocol version over time.", + "operationId": "radar_get_TimeseriesHttpVersion", + "parameters": [ + { + "description": "Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).", + "in": "query", + "name": "aggInterval", + "schema": { "enum": ["15m", "1h", "1d", "1w"], "type": "string" } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).", + "in": "query", + "name": "botClass", + "schema": { "items": { "enum": ["LIKELY_AUTOMATED", "LIKELY_HUMAN"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for device type.", + "in": "query", + "name": "deviceType", + "schema": { "items": { "enum": ["DESKTOP", "MOBILE", "OTHER"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http protocol.", + "in": "query", + "name": "httpProtocol", + "schema": { "items": { "enum": ["HTTP", "HTTPS"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for ip version.", + "in": "query", + "name": "ipVersion", + "schema": { "items": { "enum": ["IPv4", "IPv6"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for os name.", + "in": "query", + "name": "os", + "schema": { + "items": { "enum": ["WINDOWS", "MACOSX", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Filter for tls version.", + "in": "query", + "name": "tlsVersion", + "schema": { + "items": { "enum": ["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "serie_0": { + "properties": { + "HTTP/1.x": { "items": { "type": "string" }, "type": "array" }, + "HTTP/2": { "items": { "type": "string" }, "type": "array" }, + "HTTP/3": { "items": { "type": "string" }, "type": "array" }, + "timestamps": { "items": { "type": "string" }, "type": "array" } + }, + "required": ["timestamps", "HTTP/1.x", "HTTP/2", "HTTP/3"], + "type": "object" + } + }, + "required": ["meta", "serie_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get time series of HTTP versions", + "tags": ["Radar Http"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/http/timeseries/ip_version": { + "get": { + "description": "Percentage distribution of traffic per IP protocol version over time.", + "operationId": "radar_get_TimeseriesIpVersion", + "parameters": [ + { + "description": "Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).", + "in": "query", + "name": "aggInterval", + "schema": { "enum": ["15m", "1h", "1d", "1w"], "type": "string" } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).", + "in": "query", + "name": "botClass", + "schema": { "items": { "enum": ["LIKELY_AUTOMATED", "LIKELY_HUMAN"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for device type.", + "in": "query", + "name": "deviceType", + "schema": { "items": { "enum": ["DESKTOP", "MOBILE", "OTHER"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http protocol.", + "in": "query", + "name": "httpProtocol", + "schema": { "items": { "enum": ["HTTP", "HTTPS"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http version.", + "in": "query", + "name": "httpVersion", + "schema": { "items": { "enum": ["HTTPv1", "HTTPv2", "HTTPv3"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for os name.", + "in": "query", + "name": "os", + "schema": { + "items": { "enum": ["WINDOWS", "MACOSX", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Filter for tls version.", + "in": "query", + "name": "tlsVersion", + "schema": { + "items": { "enum": ["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "serie_0": { + "properties": { + "IPv4": { "items": { "type": "string" }, "type": "array" }, + "IPv6": { "items": { "type": "string" }, "type": "array" }, + "timestamps": { "items": { "type": "string" }, "type": "array" } + }, + "required": ["timestamps", "IPv4", "IPv6"], + "type": "object" + } + }, + "required": ["meta", "serie_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get time series of IP versions", + "tags": ["Radar Http"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/http/timeseries/os": { + "get": { + "description": "Percentage distribution of traffic of the top operating systems in the selected time range, over time.", + "operationId": "radar_get_TimeseriesOS", + "parameters": [ + { + "description": "Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).", + "in": "query", + "name": "aggInterval", + "schema": { "enum": ["15m", "1h", "1d", "1w"], "type": "string" } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).", + "in": "query", + "name": "botClass", + "schema": { "items": { "enum": ["LIKELY_AUTOMATED", "LIKELY_HUMAN"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for device type.", + "in": "query", + "name": "deviceType", + "schema": { "items": { "enum": ["DESKTOP", "MOBILE", "OTHER"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http protocol.", + "in": "query", + "name": "httpProtocol", + "schema": { "items": { "enum": ["HTTP", "HTTPS"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http version.", + "in": "query", + "name": "httpVersion", + "schema": { "items": { "enum": ["HTTPv1", "HTTPv2", "HTTPv3"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for ip version.", + "in": "query", + "name": "ipVersion", + "schema": { "items": { "enum": ["IPv4", "IPv6"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for tls version.", + "in": "query", + "name": "tlsVersion", + "schema": { + "items": { "enum": ["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Limit the number of objects (eg browsers) to the top items over the time range.", + "in": "query", + "name": "limitPerGroup", + "schema": { + "description": "Limit the number of objects (eg browsers) to the top items over the time range.", + "example": 2, + "type": "integer" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "serie_0": { + "properties": { + "\u003cOS name\u003e": { "items": { "type": "string" }, "type": "array" }, + "timestamps": { "items": { "type": "string" }, "type": "array" } + }, + "required": ["timestamps", "\u003cOS name\u003e"], + "type": "object" + } + }, + "required": ["meta", "serie_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get time series of operating systems", + "tags": ["Radar Http"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/http/timeseries/tls_version": { + "get": { + "description": "Percentage distribution of traffic per TLS protocol version over time.", + "operationId": "radar_get_TimeseriesTLSVersion", + "parameters": [ + { + "description": "Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).", + "in": "query", + "name": "aggInterval", + "schema": { "enum": ["15m", "1h", "1d", "1w"], "type": "string" } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).", + "in": "query", + "name": "botClass", + "schema": { "items": { "enum": ["LIKELY_AUTOMATED", "LIKELY_HUMAN"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for device type.", + "in": "query", + "name": "deviceType", + "schema": { "items": { "enum": ["DESKTOP", "MOBILE", "OTHER"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http protocol.", + "in": "query", + "name": "httpProtocol", + "schema": { "items": { "enum": ["HTTP", "HTTPS"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http version.", + "in": "query", + "name": "httpVersion", + "schema": { "items": { "enum": ["HTTPv1", "HTTPv2", "HTTPv3"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for ip version.", + "in": "query", + "name": "ipVersion", + "schema": { "items": { "enum": ["IPv4", "IPv6"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for os name.", + "in": "query", + "name": "os", + "schema": { + "items": { "enum": ["WINDOWS", "MACOSX", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { "type": "object" }, + "serie_0": { + "properties": { + "TLS 1.0": { "items": { "type": "string" }, "type": "array" }, + "TLS 1.1": { "items": { "type": "string" }, "type": "array" }, + "TLS 1.2": { "items": { "type": "string" }, "type": "array" }, + "TLS 1.3": { "items": { "type": "string" }, "type": "array" }, + "TLS QUIC": { "items": { "type": "string" }, "type": "array" }, + "timestamps": { "items": { "type": "string" }, "type": "array" } + }, + "required": ["timestamps", "TLS 1.0", "TLS 1.1", "TLS 1.2", "TLS 1.3", "TLS QUIC"], + "type": "object" + } + }, + "required": ["meta", "serie_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get time series of TLS versions", + "tags": ["Radar Http"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/http/top/ases": { + "get": { + "description": "Get the top autonomous systems (AS) by HTTP traffic. Values are a percentage out of the total traffic.", + "operationId": "radar_get_HttpTopASes", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).", + "in": "query", + "name": "botClass", + "schema": { "items": { "enum": ["LIKELY_AUTOMATED", "LIKELY_HUMAN"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for device type.", + "in": "query", + "name": "deviceType", + "schema": { "items": { "enum": ["DESKTOP", "MOBILE", "OTHER"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http protocol.", + "in": "query", + "name": "httpProtocol", + "schema": { "items": { "enum": ["HTTP", "HTTPS"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http version.", + "in": "query", + "name": "httpVersion", + "schema": { "items": { "enum": ["HTTPv1", "HTTPv2", "HTTPv3"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for ip version.", + "in": "query", + "name": "ipVersion", + "schema": { "items": { "enum": ["IPv4", "IPv6"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for os name.", + "in": "query", + "name": "os", + "schema": { + "items": { "enum": ["WINDOWS", "MACOSX", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Filter for tls version.", + "in": "query", + "name": "tlsVersion", + "schema": { + "items": { "enum": ["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientASN": { "example": 3243, "type": "integer" }, + "clientASName": { "example": "MEO", "type": "string" }, + "value": { "example": "3", "type": "string" } + }, + "required": ["clientASN", "clientASName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top autonomous systems by HTTP requests", + "tags": ["Radar Http"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/http/top/ases/bot_class/{bot_class}": { + "get": { + "description": "Get the top autonomous systems (AS), by HTTP traffic, of the requested bot class. These two categories use Cloudflare's bot score - refer to [Bot Scores](https://developers.cloudflare.com/bots/concepts/bot-score) for more information. Values are a percentage out of the total traffic.", + "operationId": "radar_get_HttpTopASesByBotClass", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for device type.", + "in": "query", + "name": "deviceType", + "schema": { "items": { "enum": ["DESKTOP", "MOBILE", "OTHER"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http protocol.", + "in": "query", + "name": "httpProtocol", + "schema": { "items": { "enum": ["HTTP", "HTTPS"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http version.", + "in": "query", + "name": "httpVersion", + "schema": { "items": { "enum": ["HTTPv1", "HTTPv2", "HTTPv3"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for ip version.", + "in": "query", + "name": "ipVersion", + "schema": { "items": { "enum": ["IPv4", "IPv6"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for os name.", + "in": "query", + "name": "os", + "schema": { + "items": { "enum": ["WINDOWS", "MACOSX", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Filter for tls version.", + "in": "query", + "name": "tlsVersion", + "schema": { + "items": { "enum": ["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Bot class.", + "in": "path", + "name": "bot_class", + "required": true, + "schema": { "enum": ["LIKELY_AUTOMATED", "LIKELY_HUMAN"], "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientASN": { "example": 3243, "type": "integer" }, + "clientASName": { "example": "MEO", "type": "string" }, + "value": { "example": "3", "type": "string" } + }, + "required": ["clientASN", "clientASName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top autonomous systems by bot class", + "tags": ["Radar Http"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/http/top/ases/device_type/{device_type}": { + "get": { + "description": "Get the top autonomous systems (AS), by HTTP traffic, of the requested device type. Values are a percentage out of the total traffic.", + "operationId": "radar_get_HttpTopASesByDeviceType", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).", + "in": "query", + "name": "botClass", + "schema": { "items": { "enum": ["LIKELY_AUTOMATED", "LIKELY_HUMAN"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http protocol.", + "in": "query", + "name": "httpProtocol", + "schema": { "items": { "enum": ["HTTP", "HTTPS"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http version.", + "in": "query", + "name": "httpVersion", + "schema": { "items": { "enum": ["HTTPv1", "HTTPv2", "HTTPv3"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for ip version.", + "in": "query", + "name": "ipVersion", + "schema": { "items": { "enum": ["IPv4", "IPv6"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for os name.", + "in": "query", + "name": "os", + "schema": { + "items": { "enum": ["WINDOWS", "MACOSX", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Filter for tls version.", + "in": "query", + "name": "tlsVersion", + "schema": { + "items": { "enum": ["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Device type.", + "in": "path", + "name": "device_type", + "required": true, + "schema": { "enum": ["DESKTOP", "MOBILE", "OTHER"], "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientASN": { "example": 3243, "type": "integer" }, + "clientASName": { "example": "MEO", "type": "string" }, + "value": { "example": "3", "type": "string" } + }, + "required": ["clientASN", "clientASName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top autonomous systems by device type", + "tags": ["Radar Http"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/http/top/ases/http_protocol/{http_protocol}": { + "get": { + "description": "Get the top autonomous systems (AS), by HTTP traffic, of the requested HTTP protocol. Values are a percentage out of the total traffic.", + "operationId": "radar_get_HttpTopASesByHTTPProtocol", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).", + "in": "query", + "name": "botClass", + "schema": { "items": { "enum": ["LIKELY_AUTOMATED", "LIKELY_HUMAN"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for device type.", + "in": "query", + "name": "deviceType", + "schema": { "items": { "enum": ["DESKTOP", "MOBILE", "OTHER"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http protocol.", + "in": "query", + "name": "httpProtocol", + "schema": { "items": { "enum": ["HTTP", "HTTPS"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for ip version.", + "in": "query", + "name": "ipVersion", + "schema": { "items": { "enum": ["IPv4", "IPv6"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for os name.", + "in": "query", + "name": "os", + "schema": { + "items": { "enum": ["WINDOWS", "MACOSX", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Filter for tls version.", + "in": "query", + "name": "tlsVersion", + "schema": { + "items": { "enum": ["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"], "type": "string" }, + "type": "array" + } + }, + { + "description": "HTTP Protocol.", + "in": "path", + "name": "http_protocol", + "required": true, + "schema": { "enum": ["HTTP", "HTTPS"], "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientASN": { "example": 3243, "type": "integer" }, + "clientASName": { "example": "MEO", "type": "string" }, + "value": { "example": "3", "type": "string" } + }, + "required": ["clientASN", "clientASName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top autonomous systems by HTTP protocol", + "tags": ["Radar Http"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/http/top/ases/http_version/{http_version}": { + "get": { + "description": "Get the top autonomous systems (AS), by HTTP traffic, of the requested HTTP protocol version. Values are a percentage out of the total traffic.", + "operationId": "radar_get_HttpTopASesByHTTPVersion", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).", + "in": "query", + "name": "botClass", + "schema": { "items": { "enum": ["LIKELY_AUTOMATED", "LIKELY_HUMAN"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for device type.", + "in": "query", + "name": "deviceType", + "schema": { "items": { "enum": ["DESKTOP", "MOBILE", "OTHER"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http protocol.", + "in": "query", + "name": "httpProtocol", + "schema": { "items": { "enum": ["HTTP", "HTTPS"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for ip version.", + "in": "query", + "name": "ipVersion", + "schema": { "items": { "enum": ["IPv4", "IPv6"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for os name.", + "in": "query", + "name": "os", + "schema": { + "items": { "enum": ["WINDOWS", "MACOSX", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Filter for tls version.", + "in": "query", + "name": "tlsVersion", + "schema": { + "items": { "enum": ["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"], "type": "string" }, + "type": "array" + } + }, + { + "description": "HTTP version.", + "in": "path", + "name": "http_version", + "required": true, + "schema": { "enum": ["HTTPv1", "HTTPv2", "HTTPv3"], "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientASN": { "example": 3243, "type": "integer" }, + "clientASName": { "example": "MEO", "type": "string" }, + "value": { "example": "3", "type": "string" } + }, + "required": ["clientASN", "clientASName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top autonomous systems by HTTP version", + "tags": ["Radar Http"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/http/top/ases/ip_version/{ip_version}": { + "get": { + "description": "Get the top autonomous systems, by HTTP traffic, of the requested IP protocol version. Values are a percentage out of the total traffic.", + "operationId": "radar_get_HttpTopASesByIpVersion", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).", + "in": "query", + "name": "botClass", + "schema": { "items": { "enum": ["LIKELY_AUTOMATED", "LIKELY_HUMAN"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for device type.", + "in": "query", + "name": "deviceType", + "schema": { "items": { "enum": ["DESKTOP", "MOBILE", "OTHER"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http protocol.", + "in": "query", + "name": "httpProtocol", + "schema": { "items": { "enum": ["HTTP", "HTTPS"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http version.", + "in": "query", + "name": "httpVersion", + "schema": { "items": { "enum": ["HTTPv1", "HTTPv2", "HTTPv3"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for os name.", + "in": "query", + "name": "os", + "schema": { + "items": { "enum": ["WINDOWS", "MACOSX", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Filter for tls version.", + "in": "query", + "name": "tlsVersion", + "schema": { + "items": { "enum": ["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"], "type": "string" }, + "type": "array" + } + }, + { + "description": "IP version.", + "in": "path", + "name": "ip_version", + "required": true, + "schema": { "enum": ["IPv4", "IPv6"], "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientASN": { "example": 3243, "type": "integer" }, + "clientASName": { "example": "MEO", "type": "string" }, + "value": { "example": "3", "type": "string" } + }, + "required": ["clientASN", "clientASName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top autonomous systems by IP version", + "tags": ["Radar Http"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/http/top/ases/os/{os}": { + "get": { + "description": "Get the top autonomous systems, by HTTP traffic, of the requested operating systems. Values are a percentage out of the total traffic.", + "operationId": "radar_get_HttpTopASesByOS", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).", + "in": "query", + "name": "botClass", + "schema": { "items": { "enum": ["LIKELY_AUTOMATED", "LIKELY_HUMAN"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for device type.", + "in": "query", + "name": "deviceType", + "schema": { "items": { "enum": ["DESKTOP", "MOBILE", "OTHER"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http protocol.", + "in": "query", + "name": "httpProtocol", + "schema": { "items": { "enum": ["HTTP", "HTTPS"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http version.", + "in": "query", + "name": "httpVersion", + "schema": { "items": { "enum": ["HTTPv1", "HTTPv2", "HTTPv3"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for ip version.", + "in": "query", + "name": "ipVersion", + "schema": { "items": { "enum": ["IPv4", "IPv6"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for tls version.", + "in": "query", + "name": "tlsVersion", + "schema": { + "items": { "enum": ["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"], "type": "string" }, + "type": "array" + } + }, + { + "description": "IP version.", + "in": "path", + "name": "os", + "required": true, + "schema": { "enum": ["WINDOWS", "MACOSX", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"], "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientASN": { "example": 3243, "type": "integer" }, + "clientASName": { "example": "MEO", "type": "string" }, + "value": { "example": "3", "type": "string" } + }, + "required": ["clientASN", "clientASName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top autonomous systems by operating system", + "tags": ["Radar Http"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/http/top/ases/tls_version/{tls_version}": { + "get": { + "description": "Get the top autonomous systems (AS), by HTTP traffic, of the requested TLS protocol version. Values are a percentage out of the total traffic.", + "operationId": "radar_get_HttpTopASesByTLSVersion", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).", + "in": "query", + "name": "botClass", + "schema": { "items": { "enum": ["LIKELY_AUTOMATED", "LIKELY_HUMAN"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for device type.", + "in": "query", + "name": "deviceType", + "schema": { "items": { "enum": ["DESKTOP", "MOBILE", "OTHER"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http protocol.", + "in": "query", + "name": "httpProtocol", + "schema": { "items": { "enum": ["HTTP", "HTTPS"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http version.", + "in": "query", + "name": "httpVersion", + "schema": { "items": { "enum": ["HTTPv1", "HTTPv2", "HTTPv3"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for ip version.", + "in": "query", + "name": "ipVersion", + "schema": { "items": { "enum": ["IPv4", "IPv6"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for os name.", + "in": "query", + "name": "os", + "schema": { + "items": { "enum": ["WINDOWS", "MACOSX", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"], "type": "string" }, + "type": "array" + } + }, + { + "description": "TLS version.", + "in": "path", + "name": "tls_version", + "required": true, + "schema": { "enum": ["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"], "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientASN": { "example": 3243, "type": "integer" }, + "clientASName": { "example": "MEO", "type": "string" }, + "value": { "example": "3", "type": "string" } + }, + "required": ["clientASN", "clientASName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top autonomous systems by TLS version", + "tags": ["Radar Http"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/http/top/browser_families": { + "get": { + "description": "Get the top user agents aggregated in families by HTTP traffic. Values are a percentage out of the total traffic.", + "operationId": "radar_get_HttpTopBrowserFamilies", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).", + "in": "query", + "name": "botClass", + "schema": { "items": { "enum": ["LIKELY_AUTOMATED", "LIKELY_HUMAN"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for device type.", + "in": "query", + "name": "deviceType", + "schema": { "items": { "enum": ["DESKTOP", "MOBILE", "OTHER"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http protocol.", + "in": "query", + "name": "httpProtocol", + "schema": { "items": { "enum": ["HTTP", "HTTPS"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http version.", + "in": "query", + "name": "httpVersion", + "schema": { "items": { "enum": ["HTTPv1", "HTTPv2", "HTTPv3"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for ip version.", + "in": "query", + "name": "ipVersion", + "schema": { "items": { "enum": ["IPv4", "IPv6"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for os name.", + "in": "query", + "name": "os", + "schema": { + "items": { "enum": ["WINDOWS", "MACOSX", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Filter for tls version.", + "in": "query", + "name": "tlsVersion", + "schema": { + "items": { "enum": ["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "\u003cbrowser name\u003e": { "type": "string" }, + "value": { "type": "string" } + }, + "required": ["\u003cbrowser name\u003e", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top user agents aggregated in families by HTTP requests", + "tags": ["Radar Http"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/http/top/browsers": { + "get": { + "description": "Get the top user agents by HTTP traffic. Values are a percentage out of the total traffic.", + "operationId": "radar_get_HttpTopBrowsers", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).", + "in": "query", + "name": "botClass", + "schema": { "items": { "enum": ["LIKELY_AUTOMATED", "LIKELY_HUMAN"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for device type.", + "in": "query", + "name": "deviceType", + "schema": { "items": { "enum": ["DESKTOP", "MOBILE", "OTHER"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http protocol.", + "in": "query", + "name": "httpProtocol", + "schema": { "items": { "enum": ["HTTP", "HTTPS"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http version.", + "in": "query", + "name": "httpVersion", + "schema": { "items": { "enum": ["HTTPv1", "HTTPv2", "HTTPv3"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for ip version.", + "in": "query", + "name": "ipVersion", + "schema": { "items": { "enum": ["IPv4", "IPv6"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for os name.", + "in": "query", + "name": "os", + "schema": { + "items": { "enum": ["WINDOWS", "MACOSX", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Filter for tls version.", + "in": "query", + "name": "tlsVersion", + "schema": { + "items": { "enum": ["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "\u003cbrowser name\u003e": { "type": "string" }, + "value": { "type": "string" } + }, + "required": ["\u003cbrowser name\u003e", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top user agents by HTTP requests", + "tags": ["Radar Http"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/http/top/locations": { + "get": { + "description": "Get the top locations by HTTP traffic. Values are a percentage out of the total traffic.", + "operationId": "radar_get_HttpTopLocations", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).", + "in": "query", + "name": "botClass", + "schema": { "items": { "enum": ["LIKELY_AUTOMATED", "LIKELY_HUMAN"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for device type.", + "in": "query", + "name": "deviceType", + "schema": { "items": { "enum": ["DESKTOP", "MOBILE", "OTHER"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http protocol.", + "in": "query", + "name": "httpProtocol", + "schema": { "items": { "enum": ["HTTP", "HTTPS"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http version.", + "in": "query", + "name": "httpVersion", + "schema": { "items": { "enum": ["HTTPv1", "HTTPv2", "HTTPv3"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for ip version.", + "in": "query", + "name": "ipVersion", + "schema": { "items": { "enum": ["IPv4", "IPv6"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for os name.", + "in": "query", + "name": "os", + "schema": { + "items": { "enum": ["WINDOWS", "MACOSX", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Filter for tls version.", + "in": "query", + "name": "tlsVersion", + "schema": { + "items": { "enum": ["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientCountryAlpha2": { "example": "US", "type": "string" }, + "clientCountryName": { "example": "United States", "type": "string" }, + "value": { "example": "65", "type": "string" } + }, + "required": ["clientCountryAlpha2", "clientCountryName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top autonomous systems by HTTP requests", + "tags": ["Radar Http"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/http/top/locations/bot_class/{bot_class}": { + "get": { + "description": "Get the top locations, by HTTP traffic, of the requested bot class. These two categories use Cloudflare's bot score - refer to [Bot scores])https://developers.cloudflare.com/bots/concepts/bot-score). Values are a percentage out of the total traffic.", + "operationId": "radar_get_HttpTopLocationsByBotClass", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for device type.", + "in": "query", + "name": "deviceType", + "schema": { "items": { "enum": ["DESKTOP", "MOBILE", "OTHER"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http protocol.", + "in": "query", + "name": "httpProtocol", + "schema": { "items": { "enum": ["HTTP", "HTTPS"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http version.", + "in": "query", + "name": "httpVersion", + "schema": { "items": { "enum": ["HTTPv1", "HTTPv2", "HTTPv3"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for ip version.", + "in": "query", + "name": "ipVersion", + "schema": { "items": { "enum": ["IPv4", "IPv6"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for os name.", + "in": "query", + "name": "os", + "schema": { + "items": { "enum": ["WINDOWS", "MACOSX", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Filter for tls version.", + "in": "query", + "name": "tlsVersion", + "schema": { + "items": { "enum": ["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Bot class.", + "in": "path", + "name": "bot_class", + "required": true, + "schema": { "enum": ["LIKELY_AUTOMATED", "LIKELY_HUMAN"], "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientCountryAlpha2": { "example": "US", "type": "string" }, + "clientCountryName": { "example": "United States", "type": "string" }, + "value": { "example": "65", "type": "string" } + }, + "required": ["clientCountryAlpha2", "clientCountryName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top locations by bot class", + "tags": ["Radar Http"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/http/top/locations/device_type/{device_type}": { + "get": { + "description": "Get the top locations, by HTTP traffic, of the requested device type. Values are a percentage out of the total traffic.", + "operationId": "radar_get_HttpTopLocationsByDeviceType", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).", + "in": "query", + "name": "botClass", + "schema": { "items": { "enum": ["LIKELY_AUTOMATED", "LIKELY_HUMAN"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http protocol.", + "in": "query", + "name": "httpProtocol", + "schema": { "items": { "enum": ["HTTP", "HTTPS"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http version.", + "in": "query", + "name": "httpVersion", + "schema": { "items": { "enum": ["HTTPv1", "HTTPv2", "HTTPv3"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for ip version.", + "in": "query", + "name": "ipVersion", + "schema": { "items": { "enum": ["IPv4", "IPv6"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for os name.", + "in": "query", + "name": "os", + "schema": { + "items": { "enum": ["WINDOWS", "MACOSX", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Filter for tls version.", + "in": "query", + "name": "tlsVersion", + "schema": { + "items": { "enum": ["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Device type.", + "in": "path", + "name": "device_type", + "required": true, + "schema": { "enum": ["DESKTOP", "MOBILE", "OTHER"], "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientCountryAlpha2": { "example": "US", "type": "string" }, + "clientCountryName": { "example": "United States", "type": "string" }, + "value": { "example": "65", "type": "string" } + }, + "required": ["clientCountryAlpha2", "clientCountryName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top locations by device type", + "tags": ["Radar Http"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/http/top/locations/http_protocol/{http_protocol}": { + "get": { + "description": "Get the top locations, by HTTP traffic, of the requested HTTP protocol. Values are a percentage out of the total traffic.", + "operationId": "radar_get_HttpTopLocationsByHTTPProtocol", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).", + "in": "query", + "name": "botClass", + "schema": { "items": { "enum": ["LIKELY_AUTOMATED", "LIKELY_HUMAN"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for device type.", + "in": "query", + "name": "deviceType", + "schema": { "items": { "enum": ["DESKTOP", "MOBILE", "OTHER"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http protocol.", + "in": "query", + "name": "httpProtocol", + "schema": { "items": { "enum": ["HTTP", "HTTPS"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for ip version.", + "in": "query", + "name": "ipVersion", + "schema": { "items": { "enum": ["IPv4", "IPv6"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for os name.", + "in": "query", + "name": "os", + "schema": { + "items": { "enum": ["WINDOWS", "MACOSX", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Filter for tls version.", + "in": "query", + "name": "tlsVersion", + "schema": { + "items": { "enum": ["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"], "type": "string" }, + "type": "array" + } + }, + { + "description": "HTTP Protocol.", + "in": "path", + "name": "http_protocol", + "required": true, + "schema": { "enum": ["HTTP", "HTTPS"], "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientCountryAlpha2": { "example": "US", "type": "string" }, + "clientCountryName": { "example": "United States", "type": "string" }, + "value": { "example": "65", "type": "string" } + }, + "required": ["clientCountryAlpha2", "clientCountryName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top locations by HTTP protocol", + "tags": ["Radar Http"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/http/top/locations/http_version/{http_version}": { + "get": { + "description": "Get the top locations, by HTTP traffic, of the requested HTTP protocol. Values are a percentage out of the total traffic.", + "operationId": "radar_get_HttpTopLocationsByHTTPVersion", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).", + "in": "query", + "name": "botClass", + "schema": { "items": { "enum": ["LIKELY_AUTOMATED", "LIKELY_HUMAN"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for device type.", + "in": "query", + "name": "deviceType", + "schema": { "items": { "enum": ["DESKTOP", "MOBILE", "OTHER"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http protocol.", + "in": "query", + "name": "httpProtocol", + "schema": { "items": { "enum": ["HTTP", "HTTPS"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for ip version.", + "in": "query", + "name": "ipVersion", + "schema": { "items": { "enum": ["IPv4", "IPv6"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for os name.", + "in": "query", + "name": "os", + "schema": { + "items": { "enum": ["WINDOWS", "MACOSX", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Filter for tls version.", + "in": "query", + "name": "tlsVersion", + "schema": { + "items": { "enum": ["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"], "type": "string" }, + "type": "array" + } + }, + { + "description": "HTTP version.", + "in": "path", + "name": "http_version", + "required": true, + "schema": { "enum": ["HTTPv1", "HTTPv2", "HTTPv3"], "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientCountryAlpha2": { "example": "US", "type": "string" }, + "clientCountryName": { "example": "United States", "type": "string" }, + "value": { "example": "65", "type": "string" } + }, + "required": ["clientCountryAlpha2", "clientCountryName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top locations by HTTP version", + "tags": ["Radar Http"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/http/top/locations/ip_version/{ip_version}": { + "get": { + "description": "Get the top locations, by HTTP traffic, of the requested IP protocol version. Values are a percentage out of the total traffic.", + "operationId": "radar_get_HttpTopLocationsByIpVersion", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).", + "in": "query", + "name": "botClass", + "schema": { "items": { "enum": ["LIKELY_AUTOMATED", "LIKELY_HUMAN"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for device type.", + "in": "query", + "name": "deviceType", + "schema": { "items": { "enum": ["DESKTOP", "MOBILE", "OTHER"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http protocol.", + "in": "query", + "name": "httpProtocol", + "schema": { "items": { "enum": ["HTTP", "HTTPS"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http version.", + "in": "query", + "name": "httpVersion", + "schema": { "items": { "enum": ["HTTPv1", "HTTPv2", "HTTPv3"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for os name.", + "in": "query", + "name": "os", + "schema": { + "items": { "enum": ["WINDOWS", "MACOSX", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Filter for tls version.", + "in": "query", + "name": "tlsVersion", + "schema": { + "items": { "enum": ["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"], "type": "string" }, + "type": "array" + } + }, + { + "description": "IP version.", + "in": "path", + "name": "ip_version", + "required": true, + "schema": { "enum": ["IPv4", "IPv6"], "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientCountryAlpha2": { "example": "US", "type": "string" }, + "clientCountryName": { "example": "United States", "type": "string" }, + "value": { "example": "65", "type": "string" } + }, + "required": ["clientCountryAlpha2", "clientCountryName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top locations by IP version", + "tags": ["Radar Http"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/http/top/locations/os/{os}": { + "get": { + "description": "Get the top locations, by HTTP traffic, of the requested operating systems. Values are a percentage out of the total traffic.", + "operationId": "radar_get_HttpTopLocationsByOS", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).", + "in": "query", + "name": "botClass", + "schema": { "items": { "enum": ["LIKELY_AUTOMATED", "LIKELY_HUMAN"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for device type.", + "in": "query", + "name": "deviceType", + "schema": { "items": { "enum": ["DESKTOP", "MOBILE", "OTHER"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http protocol.", + "in": "query", + "name": "httpProtocol", + "schema": { "items": { "enum": ["HTTP", "HTTPS"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http version.", + "in": "query", + "name": "httpVersion", + "schema": { "items": { "enum": ["HTTPv1", "HTTPv2", "HTTPv3"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for ip version.", + "in": "query", + "name": "ipVersion", + "schema": { "items": { "enum": ["IPv4", "IPv6"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for tls version.", + "in": "query", + "name": "tlsVersion", + "schema": { + "items": { "enum": ["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"], "type": "string" }, + "type": "array" + } + }, + { + "description": "IP version.", + "in": "path", + "name": "os", + "required": true, + "schema": { "enum": ["WINDOWS", "MACOSX", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"], "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientCountryAlpha2": { "example": "US", "type": "string" }, + "clientCountryName": { "example": "United States", "type": "string" }, + "value": { "example": "65", "type": "string" } + }, + "required": ["clientCountryAlpha2", "clientCountryName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top locations by operating system", + "tags": ["Radar Http"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/http/top/locations/tls_version/{tls_version}": { + "get": { + "description": "Get the top locations, by HTTP traffic, of the requested TLS protocol version. Values are a percentage out of the total traffic.", + "operationId": "radar_get_HttpTopLocationsByTLSVersion", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Filter for bot class. Refer to [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).", + "in": "query", + "name": "botClass", + "schema": { "items": { "enum": ["LIKELY_AUTOMATED", "LIKELY_HUMAN"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for device type.", + "in": "query", + "name": "deviceType", + "schema": { "items": { "enum": ["DESKTOP", "MOBILE", "OTHER"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http protocol.", + "in": "query", + "name": "httpProtocol", + "schema": { "items": { "enum": ["HTTP", "HTTPS"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for http version.", + "in": "query", + "name": "httpVersion", + "schema": { "items": { "enum": ["HTTPv1", "HTTPv2", "HTTPv3"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for ip version.", + "in": "query", + "name": "ipVersion", + "schema": { "items": { "enum": ["IPv4", "IPv6"], "type": "string" }, "type": "array" } + }, + { + "description": "Filter for os name.", + "in": "query", + "name": "os", + "schema": { + "items": { "enum": ["WINDOWS", "MACOSX", "ANDROID", "CHROMEOS", "LINUX", "SMART_TV"], "type": "string" }, + "type": "array" + } + }, + { + "description": "TLS version.", + "in": "path", + "name": "tls_version", + "required": true, + "schema": { "enum": ["TLSv1_0", "TLSv1_1", "TLSv1_2", "TLSv1_3", "TLSvQUIC"], "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "clientCountryAlpha2": { "example": "US", "type": "string" }, + "clientCountryName": { "example": "United States", "type": "string" }, + "value": { "example": "65", "type": "string" } + }, + "required": ["clientCountryAlpha2", "clientCountryName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + }, + "404": { + "content": { + "application/json": { + "schema": { + "properties": { "error": { "example": "Not Found", "type": "string" } }, + "required": ["error"], + "type": "object" + } + } + }, + "description": "Not found" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top locations by TLS version", + "tags": ["Radar Http"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/netflows/timeseries": { + "get": { + "description": "Get network traffic change over time. Values are normalized using min-max by default, with the minimum set to 0. When asking for multiple time series, you can also get the percentage relative change of the first/main series, with respect to the second/control series - for example, to get the relative change of this week from the previous week, the first series would have a date range of `7d`, the second, a date range of `7dControl`, and the normalization would be set to `PERCENTAGE_CHANGE`.", + "operationId": "radar_get_Timeseries", + "parameters": [ + { + "description": "Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).", + "in": "query", + "name": "aggInterval", + "schema": { "enum": ["15m", "1h", "1d", "1w"], "type": "string" } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of network traffic product types.", + "in": "query", + "name": "product", + "schema": { "items": { "enum": ["HTTP", "ALL"], "type": "string" }, "type": "array" } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Normalization method applied. Refer to [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).", + "in": "query", + "name": "normalization", + "schema": { "enum": ["PERCENTAGE_CHANGE", "MIN0_MAX"], "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "aggInterval": { "example": "1h", "type": "string" }, + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "example": "ALL", "type": "string" }, + "description": { "example": "Cable cut in Tonga", "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "example": "OUTAGE", "type": "string" }, + "linkedUrl": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": [ + "dataSource", + "eventType", + "description", + "startTime", + "endTime", + "linkedUrl" + ], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "description": "Adjusted end of date range.", + "example": "2022-09-17T10:22:57.555Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "description": "Adjusted start of date range.", + "example": "2022-09-16T10:22:57.555Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + }, + "lastUpdated": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["confidenceInfo", "dateRange", "aggInterval", "lastUpdated"], + "type": "object" + }, + "serie_0": { + "properties": { + "timestamps": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + }, + "values": { "items": { "example": 0.56, "type": "string" }, "type": "array" } + }, + "required": ["timestamps", "values"], + "type": "object" + } + }, + "required": ["meta", "serie_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get NetFlow time series", + "tags": ["Radar Netflows"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/netflows/top/ases": { + "get": { + "description": "Get the top autonomous systems (AS) by network traffic. Values are a percentage out of the total network traffic.", + "operationId": "radar_get_NetflowsTopASes", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "top_0": { + "items": { + "properties": { + "clientASN": { "example": 16509, "type": "number" }, + "clientASName": { "example": "AMAZON-02", "type": "string" }, + "value": { "example": "0.73996", "type": "string" } + }, + "required": ["clientASN", "clientASName", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top autonomous systems", + "tags": ["Radar Netflows"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/netflows/top/locations": { + "get": { + "description": "Get the top locations by network traffic. Values are a percentage out of the total network traffic.", + "operationId": "radar_get_NetflowsTopLocations", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "top_0": { + "items": { + "properties": { + "clientCountryAlpha2": { "example": "US", "type": "string" }, + "clientCountryName": { "example": "United States", "type": "string" }, + "value": { "example": "0.73996", "type": "string" } + }, + "required": ["clientCountryName", "clientCountryAlpha2", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top locations", + "tags": ["Radar Netflows"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/ranking/domain/{domain}": { + "get": { + "description": "Gets Domains Rank details.", + "operationId": "radar_get_RankingDetails", + "parameters": [ + { + "in": "path", + "name": "domain", + "required": true, + "schema": { + "example": "google.com", + "format": "hostname", + "pattern": "^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\\-]*[A-Za-z0-9])$", + "type": "string" + } + }, + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of dates to filter the ranking.", + "in": "query", + "name": "date", + "schema": { + "items": { + "description": "Array of dates to filter the ranking.", + "example": "2022-09-19", + "format": "date", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "details_0": { + "properties": { + "bucket": { "example": "2000", "type": "string" }, + "categories": { "items": { "example": "Technology", "type": "string" }, "type": "array" }, + "rank": { "example": 3, "type": "integer" }, + "top_locations": { + "items": { + "properties": { + "locationCode": { "example": "US", "type": "string" }, + "locationName": { "example": "United States", "type": "string" }, + "rank": { "example": 1, "type": "integer" } + }, + "required": ["rank", "locationName", "locationCode"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["bucket", "categories", "top_locations"], + "type": "object" + } + }, + "required": ["details_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Domains Rank details", + "tags": ["Radar Ranking"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/ranking/timeseries": { + "get": { + "description": "Gets Domains Rank updates change over time. Raw values are returned.", + "operationId": "radar_get_RankingTimeseries", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of locations (alpha-2 country codes).", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of locations (alpha-2 country codes).", + "example": "US", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of domains names.", + "in": "query", + "name": "domains", + "schema": { + "items": { + "description": "Array of comma separated list of domains names.", + "example": "google.com,facebook.com", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "dateRange": { + "properties": { + "endTime": { + "description": "Adjusted end of date range.", + "example": "2022-09-17T10:22:57.555Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "description": "Adjusted start of date range.", + "example": "2022-09-16T10:22:57.555Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["dateRange"], + "type": "object" + }, + "serie_0": { + "properties": { + "\u003cdomain name\u003e": { + "items": { "example": 2, "type": "integer" }, + "type": "array" + }, + "timestamps": { "items": { "example": "2022-09-02", "type": "string" }, "type": "array" } + }, + "required": ["timestamps", "\u003cdomain name\u003e"], + "type": "object" + } + }, + "required": ["meta", "serie_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Domains Rank time series", + "tags": ["Radar Ranking"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/ranking/top": { + "get": { + "description": "Gets Top Domains Rank globally or by country.", + "operationId": "radar_get_RankingTop", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of locations (alpha-2 country codes).", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of locations (alpha-2 country codes).", + "example": "US", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of dates to filter the ranking.", + "in": "query", + "name": "date", + "schema": { + "items": { + "description": "Array of dates to filter the ranking.", + "example": "2022-09-19", + "format": "date", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "top_0": { + "properties": { "date": { "example": "2022-09-19", "type": "string" } }, + "required": ["date"], + "type": "object" + } + }, + "required": ["top_0"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "categories": { "items": { "example": "Technology", "type": "string" }, "type": "array" }, + "domain": { "example": "google.com", "type": "string" }, + "rank": { "example": 1, "type": "integer" } + }, + "required": ["rank", "domain", "categories"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Domains Rank top", + "tags": ["Radar Ranking"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/search/global": { + "get": { + "description": "Lets you search for locations, autonomous systems (AS) and reports.", + "operationId": "radar_get_SearchGlobal", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Limit the number of objects per search category.", + "in": "query", + "name": "limitPerGroup", + "schema": { "description": "Limit the number of objects per search category.", "type": "number" } + }, + { + "description": "Search for locations, AS and reports.", + "in": "query", + "name": "query", + "required": true, + "schema": { "description": "Search for locations, AS and reports.", "example": "United", "type": "string" } + }, + { + "description": "Search types to be included in results.", + "in": "query", + "name": "include", + "schema": { + "items": { "enum": ["SPECIAL_EVENTS", "NOTEBOOKS", "LOCATIONS", "ASNS"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Search types to be excluded from results.", + "in": "query", + "name": "exclude", + "schema": { + "items": { "enum": ["SPECIAL_EVENTS", "NOTEBOOKS", "LOCATIONS", "ASNS"], "type": "string" }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "search": { + "items": { + "properties": { + "code": { "example": "13335", "type": "string" }, + "name": { "example": "Cloudflare", "type": "string" }, + "type": { "example": "asn", "type": "string" } + }, + "required": ["code", "name", "type"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["search"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Search for locations, autonomous systems (AS) and reports.", + "tags": ["Radar Search"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/specialevents": { + "get": { + "description": "Get a list of Special Events.", + "operationId": "radar_get_SpecialEventsList", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Number of objects to skip before grabbing results.", + "in": "query", + "name": "offset", + "schema": { + "default": 0, + "description": "Number of objects to skip before grabbing results.", + "example": 0, + "type": "integer" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "specialEvents": { + "items": { + "properties": { + "alias": { "example": "euro2020", "type": "string" }, + "categories": { + "items": { + "properties": { + "categoryAlias": { "example": "streaming", "type": "string" }, + "location": { "example": "GLOBAL", "type": "string" } + }, + "required": ["categoryAlias", "location"], + "type": "object" + }, + "type": "array" + }, + "description": { + "example": "The 2020 UEFA European Football Championship", + "type": "string" + }, + "id": { "example": 1, "type": "integer" }, + "title": { "example": "Euro2020", "type": "string" } + }, + "required": ["id", "title", "alias", "categories"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["specialEvents"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Special Events", + "tags": ["Radar Special Events"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/specialevents/{eventAlias}": { + "get": { + "description": "Get a single Special Event.", + "operationId": "radar_get_SpecialEventsGet", + "parameters": [ + { + "description": "Special Event alias", + "in": "path", + "name": "eventAlias", + "required": true, + "schema": { "description": "Special Event alias", "example": "eurovision-2022", "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "specialEvent": { + "properties": { + "alias": { "example": "euro2020", "type": "string" }, + "categories": { + "items": { + "properties": { + "categoryAlias": { "example": "streaming", "type": "string" }, + "location": { "example": "GLOBAL", "type": "string" } + }, + "required": ["categoryAlias", "location"], + "type": "object" + }, + "type": "array" + }, + "description": { + "example": "The 2020 UEFA European Football Championship", + "type": "string" + }, + "id": { "example": 1, "type": "integer" }, + "title": { "example": "Euro2020", "type": "string" } + }, + "required": ["id", "title", "alias", "categories"], + "type": "object" + } + }, + "required": ["specialEvent"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a Single Special Events", + "tags": ["Radar Special Events"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/specialevents/{eventAlias}/{categoryAlias}": { + "get": { + "operationId": "radar_get_TimeseriesSpecialEvents", + "parameters": [ + { + "description": "Aggregation interval results should be returned in (for example, in 15 minutes or 1 hour intervals). Refer to [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).", + "in": "query", + "name": "aggInterval", + "schema": { "enum": ["15m", "1h", "1d", "1w"], "type": "string" } + }, + { + "description": "Name that will be used to name the series in response.", + "in": "query", + "name": "name", + "schema": { + "description": "Name that will be used to name the series in response.", + "example": "main_series", + "type": "string" + } + }, + { + "description": "Start of the date range (inclusive).", + "in": "query", + "name": "dateStart", + "schema": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" } + }, + { + "description": "End of the date range (inclusive).", + "in": "query", + "name": "dateEnd", + "schema": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" } + }, + { + "description": "Location Alpha2 code.", + "in": "query", + "name": "location", + "schema": { "description": "Location Alpha2 code.", "example": "US", "type": "string" } + }, + { + "description": "Special Event alias", + "in": "path", + "name": "eventAlias", + "required": true, + "schema": { "description": "Special Event alias", "example": "eurovision-2022", "type": "string" } + }, + { + "description": "Special Event Category alias", + "in": "path", + "name": "categoryAlias", + "required": true, + "schema": { "description": "Special Event Category alias", "example": "videos", "type": "string" } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "serie_0": { + "properties": { + "timestamps": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + }, + "values": { "items": { "example": 0.56, "type": "string" }, "type": "array" } + }, + "required": ["timestamps", "values"], + "type": "object" + } + }, + "required": ["serie_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Special Events time series", + "tags": ["Radar Special Events"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/verified_bots/top/bots": { + "get": { + "description": "Get top verified bots by HTTP requests, with owner and category.", + "operationId": "radar_get_HttpTopVerifiedBots", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "botCategory": { "example": "Search Engine Crawler", "type": "string" }, + "botName": { "example": "GoogleBot", "type": "string" }, + "botOwner": { "example": "Google", "type": "string" }, + "value": { "example": "29.034407", "type": "string" } + }, + "required": ["botName", "botCategory", "botOwner", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top verified bots by HTTP requests", + "tags": ["Radar Verified Bots"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/radar/verified_bots/top/categories": { + "get": { + "description": "Get top verified bot categories by HTTP requests, along with their corresponding percentage, over the total verified bot HTTP requests.", + "operationId": "radar_get_HttpTopVerifiedBotCategories", + "parameters": [ + { + "description": "Limit the number of objects in the response.", + "in": "query", + "name": "limit", + "schema": { + "default": 5, + "description": "Limit the number of objects in the response.", + "example": 5, + "type": "integer" + } + }, + { + "description": "Array of names that will be used to name the series in responses.", + "in": "query", + "name": "name", + "schema": { + "items": { + "description": "Array of names that will be used to name the series in responses.", + "example": "main_series", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).", + "in": "query", + "name": "dateRange", + "schema": { + "items": { + "enum": [ + "1d", + "7d", + "14d", + "28d", + "12w", + "24w", + "52w", + "1dControl", + "7dControl", + "14dControl", + "28dControl", + "12wControl", + "24wControl" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the start of a series.", + "in": "query", + "name": "dateStart", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of datetimes to filter the end of a series.", + "in": "query", + "name": "dateEnd", + "schema": { + "items": { "example": "2022-09-15T00:00:00Z", "format": "date-time", "type": "string" }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "in": "query", + "name": "asn", + "schema": { + "items": { + "description": "Array of comma separated list of ASNs, start with `-` to exclude from results. For example, `-174, 3356` excludes results from AS174, but includes results from AS3356.", + "example": "15169", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "in": "query", + "name": "location", + "schema": { + "items": { + "description": "Array of comma separated list of locations (alpha-2 country codes). Start with `-` to exclude from results. For example, `-US,PT` excludes results from the US, but includes results from PT.", + "example": "US,CA", + "type": "string" + }, + "type": "array" + } + }, + { + "description": "Format results are returned in.", + "in": "query", + "name": "format", + "schema": { "enum": ["JSON", "CSV"], "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { + "meta": { + "properties": { + "confidenceInfo": { + "properties": { + "annotations": { + "items": { + "properties": { + "dataSource": { "type": "string" }, + "description": { "type": "string" }, + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "eventType": { "type": "string" }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["dataSource", "eventType", "description", "startTime", "endTime"], + "type": "object" + }, + "type": "array" + }, + "level": { "type": "integer" } + }, + "required": ["level", "annotations"], + "type": "object" + }, + "dateRange": { + "properties": { + "endTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + }, + "startTime": { + "example": "2022-09-15T00:00:00Z", + "format": "date-time", + "type": "string" + } + }, + "required": ["startTime", "endTime"], + "type": "object" + } + }, + "required": ["confidenceInfo", "dateRange"], + "type": "object" + }, + "top_0": { + "items": { + "properties": { + "botCategory": { "example": "Search", "type": "string" }, + "value": { "example": "65", "type": "string" } + }, + "required": ["botCategory", "value"], + "type": "object" + }, + "type": "array" + } + }, + "required": ["meta", "top_0"], + "type": "object" + }, + "success": { "example": true, "type": "boolean" } + }, + "required": ["result", "success"], + "type": "object" + } + } + }, + "description": "Successful Response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get top verified bot categories by HTTP requests", + "tags": ["Radar Verified Bots"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/railguns": { + "get": { + "description": "List, search, sort and filter your Railguns.", + "operationId": "railgun-list-railguns", + "parameters": [ + { + "in": "query", + "name": "page", + "schema": { + "default": 1, + "description": "Page number of paginated results.", + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { + "default": 20, + "description": "Number of items per page.", + "maximum": 50, + "minimum": 5, + "type": "number" + } + }, + { + "in": "query", + "name": "direction", + "schema": { + "description": "Sort Railguns in ascending or descending order.", + "enum": ["asc", "desc"], + "example": "desc", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/railgun_response_collection" } } + }, + "description": "List Railguns response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/railgun_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Railguns response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Railguns", + "tags": ["Railgun"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + }, + "post": { + "operationId": "railgun-create-railgun", + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "name": { "$ref": "#/components/schemas/railgun_components-schemas-name" } }, + "required": ["name"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/railgun_response_single" } } }, + "description": "Create Railgun response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/railgun_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Railgun response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Railgun", + "tags": ["Railgun"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + } + }, + "/railguns/{identifier}": { + "delete": { + "description": "Disable and delete a Railgun. This will immediately disable that Railgun for any connected zones.", + "operationId": "railgun-delete-a-railgun", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/railgun_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/railgun_response_single_id" } } + }, + "description": "Delete a Railgun response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/railgun_response_single_id" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete a Railgun response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete a Railgun", + "tags": ["Railgun"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + }, + "get": { + "operationId": "railgun-railgun-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/railgun_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/railgun_response_single" } } }, + "description": "Railgun details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/railgun_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Railgun details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Railgun details", + "tags": ["Railgun"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + }, + "patch": { + "description": "Enable or disable a Railgun for all zones connected to it.", + "operationId": "railgun-enable-or-disable-a-railgun", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/railgun_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "enabled": { "$ref": "#/components/schemas/railgun_components-schemas-enabled" } }, + "required": ["enabled"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/railgun_response_single" } } }, + "description": "Enable or disable a Railgun response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/railgun_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Enable or disable a Railgun response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Enable or disable a Railgun", + "tags": ["Railgun"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + } + }, + "/railguns/{identifier}/zones": { + "get": { + "description": "List the zones that are currently using this Railgun.", + "operationId": "railgun-list-railgun-zones", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/railgun_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "items": { "$ref": "#/components/schemas/components-schemas-zone" }, + "type": "array" + } + } + } + ] + } + } + }, + "description": "List Railgun zones response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "items": { "$ref": "#/components/schemas/components-schemas-zone" }, + "type": "array" + } + } + } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Railgun zones response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Railgun zones", + "tags": ["Railgun"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + } + }, + "/user": { + "get": { + "operationId": "user-user-details", + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/single_user_response" } } }, + "description": "User Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_user_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "User Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "User Details", + "tags": ["User"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Edit part of your user details.", + "operationId": "user-edit-user", + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "country": { "$ref": "#/components/schemas/country-DyJUDEcJ" }, + "first_name": { "$ref": "#/components/schemas/first_name" }, + "last_name": { "$ref": "#/components/schemas/last_name" }, + "telephone": { "$ref": "#/components/schemas/telephone" }, + "zipcode": { "$ref": "#/components/schemas/zipcode" } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/single_user_response" } } }, + "description": "Edit User response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_user_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Edit User response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Edit User", + "tags": ["User"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.user.update"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/user/audit_logs": { + "get": { + "description": "Gets a list of audit logs for a user account. The list can be filtered by who made the change, which zone was the change made on, and the timeframe of the change.", + "operationId": "audit-logs-get-user-audit-logs", + "parameters": [ + { + "in": "query", + "name": "id", + "schema": { + "description": "Finds a specific log by its ID.", + "example": "f174be97-19b1-40d6-954d-70cd5fbd52db", + "type": "string" + } + }, + { + "in": "query", + "name": "export", + "schema": { + "description": "Indicates that this request is an export of logs in CSV format.", + "example": true, + "type": "boolean" + } + }, + { + "in": "query", + "name": "action.type", + "schema": { "description": "Filters by the action type.", "example": "add", "type": "string" } + }, + { + "in": "query", + "name": "actor.ip", + "schema": { + "description": "Filters by the IP address of the request that made the change by specific IP address or valid CIDR Range.", + "example": "17.168.228.63", + "type": "string" + } + }, + { + "in": "query", + "name": "actor.email", + "schema": { + "description": "Filters by the email address of the actor that made the change.", + "example": "alice@example.com", + "format": "email", + "type": "string" + } + }, + { + "in": "query", + "name": "since", + "schema": { + "description": "Limits the returned results to logs newer than the specified date. This can be a date string `2019-04-30` or an absolute timestamp that conforms to RFC3339.", + "example": "2019-04-30T01:12:20Z", + "format": "date-time", + "type": "string" + } + }, + { + "in": "query", + "name": "before", + "schema": { + "description": "Limits the returned results to logs older than the specified date. This can be a date string `2019-04-30` or an absolute timestamp that conforms to RFC3339.", + "example": "2019-04-30T01:12:20Z", + "format": "date-time", + "type": "string" + } + }, + { + "in": "query", + "name": "zone.name", + "schema": { + "description": "Filters by the name of the zone associated to the change.", + "example": "example.com", + "type": "string" + } + }, + { + "in": "query", + "name": "direction", + "schema": { + "default": "desc", + "description": "Changes the direction of the chronological sorting.", + "enum": ["desc", "asc"], + "example": "desc", + "type": "string" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { + "default": 100, + "description": "Sets the number of results to return per page.", + "example": 25, + "maximum": 1000, + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "page", + "schema": { + "default": 1, + "description": "Defines which page of results to return.", + "example": 50, + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "hide_user_logs", + "schema": { + "default": false, + "description": "Indicates whether or not to hide user level audit logs.", + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/audit_logs_response_collection" } } + }, + "description": "Get user audit logs response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/audit_logs_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get user audit logs response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get user audit logs", + "tags": ["Audit Logs"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/user/billing/history": { + "get": { + "description": "Accesses your billing history object.", + "operationId": "user-billing-history-billing-history-details", + "parameters": [ + { + "in": "query", + "name": "page", + "schema": { + "default": 1, + "description": "Page number of paginated results.", + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { + "default": 20, + "description": "Number of items per page.", + "maximum": 50, + "minimum": 5, + "type": "number" + } + }, + { + "in": "query", + "name": "order", + "schema": { + "description": "Field to order billing history by.", + "enum": ["type", "occured_at", "action"], + "example": "occured_at", + "type": "string" + } + }, + { "in": "query", "name": "occured_at", "schema": { "$ref": "#/components/schemas/occurred_at" } }, + { "in": "query", "name": "occurred_at", "schema": { "$ref": "#/components/schemas/occurred_at" } }, + { + "in": "query", + "name": "type", + "schema": { + "description": "The billing item type.", + "example": "charge", + "maxLength": 30, + "readOnly": true, + "type": "string" + } + }, + { + "in": "query", + "name": "action", + "schema": { + "description": "The billing item action.", + "example": "subscription", + "maxLength": 30, + "readOnly": true, + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/billing_history_collection" } } + }, + "description": "Billing History Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/billing_history_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Billing History Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Billing History Details", + "tags": ["User Billing History"], + "x-cfPermissionsRequired": { "enum": ["#billing:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/user/billing/profile": { + "get": { + "description": "Accesses your billing profile object.", + "operationId": "user-billing-profile-billing-profile-details", + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing_response_single" } } }, + "description": "Billing Profile Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/billing_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Billing Profile Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Billing Profile Details", + "tags": ["User Billing Profile"], + "x-cfPermissionsRequired": { "enum": ["#billing:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/user/firewall/access_rules/rules": { + "get": { + "description": "Fetches IP Access rules of the user. You can filter the results using several optional parameters.", + "operationId": "ip-access-rules-for-a-user-list-ip-access-rules", + "parameters": [ + { "in": "query", "name": "filters", "schema": { "$ref": "#/components/schemas/schemas-filters" } }, + { "in": "query", "name": "egs-pagination.json", "schema": { "$ref": "#/components/schemas/egs-pagination" } }, + { + "in": "query", + "name": "page", + "schema": { + "description": "Requested page within paginated list of results.", + "example": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { "description": "Maximum number of results requested.", "example": 20, "type": "number" } + }, + { + "in": "query", + "name": "order", + "schema": { + "description": "The field used to sort returned rules.", + "enum": ["configuration.target", "configuration.value", "mode"], + "example": "mode", + "type": "string" + } + }, + { + "in": "query", + "name": "direction", + "schema": { + "description": "The direction used to sort returned rules.", + "enum": ["asc", "desc"], + "example": "desc", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/rule_collection_response" } } + }, + "description": "List IP Access rules response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/rule_collection_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List IP Access rules response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List IP Access rules", + "tags": ["IP Access rules for a user"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "post": { + "description": "Creates a new IP Access rule for all zones owned by the current user.\n\nNote: To create an IP Access rule that applies to a specific zone, refer to the [IP Access rules for a zone](#ip-access-rules-for-a-zone) endpoints.", + "operationId": "ip-access-rules-for-a-user-create-an-ip-access-rule", + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "configuration": { "$ref": "#/components/schemas/schemas-configuration" }, + "mode": { "$ref": "#/components/schemas/schemas-mode" }, + "notes": { "$ref": "#/components/schemas/notes" } + }, + "required": ["mode", "configuration"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rule_single_response" } } }, + "description": "Create an IP Access rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/rule_single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create an IP Access rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create an IP Access rule", + "tags": ["IP Access rules for a user"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/user/firewall/access_rules/rules/{identifier}": { + "delete": { + "description": "Deletes an IP Access rule at the user level.\n\nNote: Deleting a user-level rule will affect all zones owned by the user.", + "operationId": "ip-access-rules-for-a-user-delete-an-ip-access-rule", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/rule_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rule_single_id_response" } } }, + "description": "Delete an IP Access rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/rule_single_id_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete an IP Access rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete an IP Access rule", + "tags": ["IP Access rules for a user"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Updates an IP Access rule defined at the user level. You can only update the rule action (`mode` parameter) and notes.", + "operationId": "ip-access-rules-for-a-user-update-an-ip-access-rule", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/rule_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "mode": { "$ref": "#/components/schemas/schemas-mode" }, + "notes": { "$ref": "#/components/schemas/notes" } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rule_single_response" } } }, + "description": "Update an IP Access rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/rule_single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update an IP Access rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update an IP Access rule", + "tags": ["IP Access rules for a user"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/user/invites": { + "get": { + "description": "Lists all invitations associated with my user.", + "operationId": "user'-s-invites-list-invitations", + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-collection_invite_response" } } + }, + "description": "List Invitations response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-collection_invite_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Invitations response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Invitations", + "tags": ["User's Invites"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/user/invites/{identifier}": { + "get": { + "description": "Gets the details of an invitation.", + "operationId": "user'-s-invites-invitation-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/invite_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/single_invite_response" } } }, + "description": "Invitation Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_invite_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Invitation Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Invitation Details", + "tags": ["User's Invites"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "patch": { + "description": "Responds to an invitation.", + "operationId": "user'-s-invites-respond-to-invitation", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/invite_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "status": { + "description": "Status of your response to the invitation (rejected or accepted).", + "enum": ["accepted", "rejected"], + "example": "accepted" + } + }, + "required": ["status"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/single_invite_response" } } }, + "description": "Respond to Invitation response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_invite_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Respond to Invitation response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Respond to Invitation", + "tags": ["User's Invites"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/user/load_balancers/monitors": { + "get": { + "description": "List configured monitors for a user.", + "operationId": "load-balancer-monitors-list-monitors", + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/response_collection-IG638TJE" } } + }, + "description": "List Monitors response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/response_collection-IG638TJE" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Monitors response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Monitors", + "tags": ["Load Balancer Monitors"] + }, + "post": { + "description": "Create a configured monitor.", + "operationId": "load-balancer-monitors-create-monitor", + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "allow_insecure": { "$ref": "#/components/schemas/allow_insecure" }, + "description": { "$ref": "#/components/schemas/description-Jd6AMFjR" }, + "expected_body": { "$ref": "#/components/schemas/expected_body" }, + "expected_codes": { "$ref": "#/components/schemas/expected_codes" }, + "follow_redirects": { "$ref": "#/components/schemas/follow_redirects" }, + "header": { "$ref": "#/components/schemas/header" }, + "interval": { "$ref": "#/components/schemas/interval-hA6swy38" }, + "method": { "$ref": "#/components/schemas/method-guvmKTdR" }, + "path": { "$ref": "#/components/schemas/path-I0p9X4oI" }, + "port": { "$ref": "#/components/schemas/port-WXwz9tIV" }, + "probe_zone": { "$ref": "#/components/schemas/probe_zone" }, + "retries": { "$ref": "#/components/schemas/retries" }, + "timeout": { "$ref": "#/components/schemas/timeout" }, + "type": { "$ref": "#/components/schemas/type-gTI6cLgq" } + }, + "required": ["expected_codes"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response-xymoBSIP" } } + }, + "description": "Create Monitor response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response-xymoBSIP" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Monitor response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Monitor", + "tags": ["Load Balancer Monitors"] + } + }, + "/user/load_balancers/monitors/{identifier}": { + "delete": { + "description": "Delete a configured monitor.", + "operationId": "load-balancer-monitors-delete-monitor", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-FZThz4k7" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/id_response-99rIWUZu" } } }, + "description": "Delete Monitor response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/id_response-99rIWUZu" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Monitor response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Monitor", + "tags": ["Load Balancer Monitors"] + }, + "get": { + "description": "List a single configured monitor for a user.", + "operationId": "load-balancer-monitors-monitor-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-FZThz4k7" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response-xymoBSIP" } } + }, + "description": "Monitor Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response-xymoBSIP" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Monitor Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Monitor Details", + "tags": ["Load Balancer Monitors"] + }, + "patch": { + "description": "Apply changes to an existing monitor, overwriting the supplied properties.", + "operationId": "load-balancer-monitors-patch-monitor", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-FZThz4k7" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "allow_insecure": { "$ref": "#/components/schemas/allow_insecure" }, + "description": { "$ref": "#/components/schemas/description-Jd6AMFjR" }, + "expected_body": { "$ref": "#/components/schemas/expected_body" }, + "expected_codes": { "$ref": "#/components/schemas/expected_codes" }, + "follow_redirects": { "$ref": "#/components/schemas/follow_redirects" }, + "header": { "$ref": "#/components/schemas/header" }, + "interval": { "$ref": "#/components/schemas/interval-hA6swy38" }, + "method": { "$ref": "#/components/schemas/method-guvmKTdR" }, + "path": { "$ref": "#/components/schemas/path-I0p9X4oI" }, + "port": { "$ref": "#/components/schemas/port-WXwz9tIV" }, + "probe_zone": { "$ref": "#/components/schemas/probe_zone" }, + "retries": { "$ref": "#/components/schemas/retries" }, + "timeout": { "$ref": "#/components/schemas/timeout" }, + "type": { "$ref": "#/components/schemas/type-gTI6cLgq" } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response-xymoBSIP" } } + }, + "description": "Patch Monitor response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response-xymoBSIP" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Patch Monitor response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Patch Monitor", + "tags": ["Load Balancer Monitors"] + }, + "put": { + "description": "Modify a configured monitor.", + "operationId": "load-balancer-monitors-update-monitor", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-FZThz4k7" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "allow_insecure": { "$ref": "#/components/schemas/allow_insecure" }, + "description": { "$ref": "#/components/schemas/description-Jd6AMFjR" }, + "expected_body": { "$ref": "#/components/schemas/expected_body" }, + "expected_codes": { "$ref": "#/components/schemas/expected_codes" }, + "follow_redirects": { "$ref": "#/components/schemas/follow_redirects" }, + "header": { "$ref": "#/components/schemas/header" }, + "interval": { "$ref": "#/components/schemas/interval-hA6swy38" }, + "method": { "$ref": "#/components/schemas/method-guvmKTdR" }, + "path": { "$ref": "#/components/schemas/path-I0p9X4oI" }, + "port": { "$ref": "#/components/schemas/port-WXwz9tIV" }, + "probe_zone": { "$ref": "#/components/schemas/probe_zone" }, + "retries": { "$ref": "#/components/schemas/retries" }, + "timeout": { "$ref": "#/components/schemas/timeout" }, + "type": { "$ref": "#/components/schemas/type-gTI6cLgq" } + }, + "required": ["expected_codes"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response-xymoBSIP" } } + }, + "description": "Update Monitor response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response-xymoBSIP" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Monitor response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Monitor", + "tags": ["Load Balancer Monitors"] + } + }, + "/user/load_balancers/monitors/{identifier}/preview": { + "post": { + "description": "Preview pools using the specified monitor with provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results.", + "operationId": "load-balancer-monitors-preview-monitor", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-FZThz4k7" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "allow_insecure": { "$ref": "#/components/schemas/allow_insecure" }, + "expected_body": { "$ref": "#/components/schemas/expected_body" }, + "expected_codes": { "$ref": "#/components/schemas/expected_codes" }, + "follow_redirects": { "$ref": "#/components/schemas/follow_redirects" }, + "header": { "$ref": "#/components/schemas/header" }, + "method": { "$ref": "#/components/schemas/method-guvmKTdR" }, + "path": { "$ref": "#/components/schemas/path-I0p9X4oI" }, + "port": { "$ref": "#/components/schemas/port-WXwz9tIV" }, + "retries": { "$ref": "#/components/schemas/retries" }, + "timeout": { "$ref": "#/components/schemas/timeout" }, + "type": { "$ref": "#/components/schemas/type-gTI6cLgq" } + }, + "required": ["expected_codes"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/preview_response-ZWQ9Fl0k" } } + }, + "description": "Preview Monitor response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/preview_response-ZWQ9Fl0k" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Preview Monitor response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Preview Monitor", + "tags": ["Load Balancer Monitors"] + } + }, + "/user/load_balancers/monitors/{identifier}/references": { + "get": { + "description": "Get the list of resources that reference the provided monitor.", + "operationId": "load-balancer-monitors-list-monitor-references", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-FZThz4k7" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/references_response" } } }, + "description": "List Monitor References response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/references_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Monitor References response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Monitor References", + "tags": ["Load Balancer Monitors"] + } + }, + "/user/load_balancers/pools": { + "get": { + "description": "List configured pools.", + "operationId": "load-balancer-pools-list-pools", + "parameters": [ + { + "in": "query", + "name": "monitor", + "schema": { + "description": "The ID of the Monitor to use for checking the health of origins within this pool." + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-response_collection-PNoWMjSR" } } + }, + "description": "List Pools response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-response_collection-PNoWMjSR" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Pools response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Pools", + "tags": ["Load Balancer Pools"] + }, + "patch": { + "description": "Apply changes to a number of existing pools, overwriting the supplied properties. Pools are ordered by ascending `name`. Returns the list of affected pools. Supports the standard pagination query parameters, either `limit`/`offset` or `per_page`/`page`.", + "operationId": "load-balancer-pools-patch-pools", + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "notification_email": { "$ref": "#/components/schemas/patch_pools_notification_email" } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-response_collection-PNoWMjSR" } } + }, + "description": "Patch Pools response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-response_collection-PNoWMjSR" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Patch Pools response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Patch Pools", + "tags": ["Load Balancer Pools"] + }, + "post": { + "description": "Create a new pool.", + "operationId": "load-balancer-pools-create-pool", + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "check_regions": { "$ref": "#/components/schemas/check_regions-q46IR1gk" }, + "description": { "$ref": "#/components/schemas/schemas-description-XvtZaN2T" }, + "enabled": { "$ref": "#/components/schemas/enabled-WoQtkwsn" }, + "latitude": { "$ref": "#/components/schemas/latitude" }, + "load_shedding": { "$ref": "#/components/schemas/load_shedding" }, + "longitude": { "$ref": "#/components/schemas/longitude" }, + "minimum_origins": { "$ref": "#/components/schemas/minimum_origins" }, + "monitor": { "$ref": "#/components/schemas/schemas-monitor" }, + "name": { "$ref": "#/components/schemas/name-Pky1OOiR" }, + "notification_email": { "$ref": "#/components/schemas/notification_email" }, + "notification_filter": { "$ref": "#/components/schemas/notification_filter" }, + "origin_steering": { "$ref": "#/components/schemas/origin_steering" }, + "origins": { "$ref": "#/components/schemas/origins-BzaDTSuG" } + }, + "required": ["origins", "name"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-single_response-uzr0CVkk" } } + }, + "description": "Create Pool response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-single_response-uzr0CVkk" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Pool response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Pool", + "tags": ["Load Balancer Pools"] + } + }, + "/user/load_balancers/pools/{identifier}": { + "delete": { + "description": "Delete a configured pool.", + "operationId": "load-balancer-pools-delete-pool", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier-LDS3pdXe" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-id_response-n8mMAIdf" } } + }, + "description": "Delete Pool response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-id_response-n8mMAIdf" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Pool response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Pool", + "tags": ["Load Balancer Pools"] + }, + "get": { + "description": "Fetch a single configured pool.", + "operationId": "load-balancer-pools-pool-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier-LDS3pdXe" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-single_response-uzr0CVkk" } } + }, + "description": "Pool Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-single_response-uzr0CVkk" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Pool Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Pool Details", + "tags": ["Load Balancer Pools"] + }, + "patch": { + "description": "Apply changes to an existing pool, overwriting the supplied properties.", + "operationId": "load-balancer-pools-patch-pool", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier-LDS3pdXe" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "check_regions": { "$ref": "#/components/schemas/check_regions-q46IR1gk" }, + "description": { "$ref": "#/components/schemas/schemas-description-XvtZaN2T" }, + "disabled_at": { "$ref": "#/components/schemas/schemas-disabled_at" }, + "enabled": { "$ref": "#/components/schemas/enabled-WoQtkwsn" }, + "latitude": { "$ref": "#/components/schemas/latitude" }, + "load_shedding": { "$ref": "#/components/schemas/load_shedding" }, + "longitude": { "$ref": "#/components/schemas/longitude" }, + "minimum_origins": { "$ref": "#/components/schemas/minimum_origins" }, + "monitor": { "$ref": "#/components/schemas/schemas-monitor" }, + "name": { "$ref": "#/components/schemas/name-Pky1OOiR" }, + "notification_email": { "$ref": "#/components/schemas/notification_email" }, + "notification_filter": { "$ref": "#/components/schemas/notification_filter" }, + "origin_steering": { "$ref": "#/components/schemas/origin_steering" }, + "origins": { "$ref": "#/components/schemas/origins-BzaDTSuG" } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-single_response-uzr0CVkk" } } + }, + "description": "Patch Pool response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-single_response-uzr0CVkk" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Patch Pool response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Patch Pool", + "tags": ["Load Balancer Pools"] + }, + "put": { + "description": "Modify a configured pool.", + "operationId": "load-balancer-pools-update-pool", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier-LDS3pdXe" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "check_regions": { "$ref": "#/components/schemas/check_regions-q46IR1gk" }, + "description": { "$ref": "#/components/schemas/schemas-description-XvtZaN2T" }, + "disabled_at": { "$ref": "#/components/schemas/schemas-disabled_at" }, + "enabled": { "$ref": "#/components/schemas/enabled-WoQtkwsn" }, + "latitude": { "$ref": "#/components/schemas/latitude" }, + "load_shedding": { "$ref": "#/components/schemas/load_shedding" }, + "longitude": { "$ref": "#/components/schemas/longitude" }, + "minimum_origins": { "$ref": "#/components/schemas/minimum_origins" }, + "monitor": { "$ref": "#/components/schemas/schemas-monitor" }, + "name": { "$ref": "#/components/schemas/name-Pky1OOiR" }, + "notification_email": { "$ref": "#/components/schemas/notification_email" }, + "notification_filter": { "$ref": "#/components/schemas/notification_filter" }, + "origin_steering": { "$ref": "#/components/schemas/origin_steering" }, + "origins": { "$ref": "#/components/schemas/origins-BzaDTSuG" } + }, + "required": ["origins", "name"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-single_response-uzr0CVkk" } } + }, + "description": "Update Pool response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-single_response-uzr0CVkk" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Pool response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Pool", + "tags": ["Load Balancer Pools"] + } + }, + "/user/load_balancers/pools/{identifier}/health": { + "get": { + "description": "Fetch the latest pool health status for a single pool.", + "operationId": "load-balancer-pools-pool-health-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier-LDS3pdXe" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/health_details" } } }, + "description": "Pool Health Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/health_details" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Pool Health Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Pool Health Details", + "tags": ["Load Balancer Pools"] + } + }, + "/user/load_balancers/pools/{identifier}/preview": { + "post": { + "description": "Preview pool health using provided monitor details. The returned preview_id can be used in the preview endpoint to retrieve the results.", + "operationId": "load-balancer-pools-preview-pool", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier-LDS3pdXe" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "allow_insecure": { "$ref": "#/components/schemas/allow_insecure" }, + "expected_body": { "$ref": "#/components/schemas/expected_body" }, + "expected_codes": { "$ref": "#/components/schemas/expected_codes" }, + "follow_redirects": { "$ref": "#/components/schemas/follow_redirects" }, + "header": { "$ref": "#/components/schemas/header" }, + "method": { "$ref": "#/components/schemas/method-guvmKTdR" }, + "path": { "$ref": "#/components/schemas/path-I0p9X4oI" }, + "port": { "$ref": "#/components/schemas/port-WXwz9tIV" }, + "retries": { "$ref": "#/components/schemas/retries" }, + "timeout": { "$ref": "#/components/schemas/timeout" }, + "type": { "$ref": "#/components/schemas/type-gTI6cLgq" } + }, + "required": ["expected_codes"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/preview_response-ZWQ9Fl0k" } } + }, + "description": "Preview Pool response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/preview_response-ZWQ9Fl0k" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Preview Pool response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Preview Pool", + "tags": ["Load Balancer Pools"] + } + }, + "/user/load_balancers/pools/{identifier}/references": { + "get": { + "description": "Get the list of resources that reference the provided pool.", + "operationId": "load-balancer-pools-list-pool-references", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier-LDS3pdXe" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-references_response" } } + }, + "description": "List Pool References response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-references_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Pool References response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Pool References", + "tags": ["Load Balancer Pools"] + } + }, + "/user/load_balancers/preview/{preview_id}": { + "get": { + "description": "Get the result of a previous preview operation using the provided preview_id.", + "operationId": "load-balancer-monitors-preview-result", + "parameters": [ + { + "in": "path", + "name": "preview_id", + "required": true, + "schema": { "$ref": "#/components/schemas/preview_id" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/preview_result_response-181bkyJU" } } + }, + "description": "Preview Result response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/preview_result_response-181bkyJU" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Preview Result response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Preview Result", + "tags": ["Load Balancer Monitors"] + } + }, + "/user/load_balancing_analytics/events": { + "get": { + "description": "List origin health changes.", + "operationId": "load-balancer-healthcheck-events-list-healthcheck-events", + "parameters": [ + { "in": "query", "name": "until", "schema": { "$ref": "#/components/schemas/until-XGNiH7hs" } }, + { "in": "query", "name": "pool_name", "schema": { "$ref": "#/components/schemas/pool_name" } }, + { "in": "query", "name": "origin_healthy", "schema": { "$ref": "#/components/schemas/origin_healthy" } }, + { + "in": "query", + "name": "identifier", + "schema": { "$ref": "#/components/schemas/schemas-identifier-LDS3pdXe" } + }, + { + "in": "query", + "name": "since", + "schema": { + "description": "Start date and time of requesting data period in the ISO8601 format.", + "example": "2016-11-11T12:00:00Z", + "format": "date-time", + "type": "string" + } + }, + { + "in": "query", + "name": "origin_name", + "schema": { + "description": "The name for the origin to filter.", + "example": "primary-dc-1", + "type": "string" + } + }, + { + "in": "query", + "name": "pool_healthy", + "schema": { + "default": true, + "description": "If true, filter events where the pool status is healthy. If false, filter events where the pool status is unhealthy.", + "example": true, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-response_collection-Qwy7OnW5" } + } + }, + "description": "List Healthcheck Events response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-response_collection-Qwy7OnW5" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Healthcheck Events response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Healthcheck Events", + "tags": ["Load Balancer Healthcheck Events"] + } + }, + "/user/organizations": { + "get": { + "description": "Lists organizations the user is associated with.", + "operationId": "user'-s-organizations-list-organizations", + "parameters": [ + { "in": "query", "name": "name", "schema": { "$ref": "#/components/schemas/schemas-name-Usb6SCq8" } }, + { + "in": "query", + "name": "page", + "schema": { + "default": 1, + "description": "Page number of paginated results.", + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { + "default": 20, + "description": "Number of organizations per page.", + "maximum": 50, + "minimum": 5, + "type": "number" + } + }, + { + "in": "query", + "name": "order", + "schema": { + "description": "Field to order organizations by.", + "enum": ["id", "name", "status"], + "example": "status", + "type": "string" + } + }, + { + "in": "query", + "name": "direction", + "schema": { + "description": "Direction to order organizations.", + "enum": ["asc", "desc"], + "example": "desc", + "type": "string" + } + }, + { + "in": "query", + "name": "match", + "schema": { + "default": "all", + "description": "Whether to match all search requirements or at least one (any).", + "enum": ["any", "all"], + "type": "string" + } + }, + { + "in": "query", + "name": "status", + "schema": { + "description": "Whether the user is a member of the organization or has an inivitation pending.", + "enum": ["member", "invited"], + "example": "member", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/collection_organization_response" } } + }, + "description": "List Organizations response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/collection_organization_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Organizations response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Organizations", + "tags": ["User's Organizations"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/user/organizations/{identifier}": { + "delete": { + "description": "Removes association to an organization.", + "operationId": "user'-s-organizations-leave-organization", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" } }, + "type": "object" + } + } + }, + "description": "Leave Organization response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "properties": { "id": { "$ref": "#/components/schemas/common_components-schemas-identifier" } }, + "type": "object" + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Leave Organization response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Leave Organization", + "tags": ["User's Organizations"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "get": { + "description": "Gets a specific organization the user is associated with.", + "operationId": "user'-s-organizations-organization-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_organization_response" } } + }, + "description": "Organization Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_organization_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Organization Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Organization Details", + "tags": ["User's Organizations"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/user/subscriptions": { + "get": { + "description": "Lists all of a user's subscriptions.", + "operationId": "user-subscription-get-user-subscriptions", + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/user_subscription_response_collection" } } + }, + "description": "Get User Subscriptions response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/user_subscription_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get User Subscriptions response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get User Subscriptions", + "tags": ["User Subscription"], + "x-cfPermissionsRequired": { "enum": ["#billing:read"] } + } + }, + "/user/subscriptions/{identifier}": { + "delete": { + "description": "Deletes a user's subscription.", + "operationId": "user-subscription-delete-user-subscription", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/subscription-v2_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "subscription_id": { "$ref": "#/components/schemas/subscription-v2_components-schemas-identifier" } + }, + "type": "object" + } + } + }, + "description": "Delete User Subscription response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "properties": { + "subscription_id": { + "$ref": "#/components/schemas/subscription-v2_components-schemas-identifier" + } + }, + "type": "object" + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete User Subscription response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete User Subscription", + "tags": ["User Subscription"], + "x-cfPermissionsRequired": { "enum": ["#billing:edit"] } + }, + "put": { + "description": "Updates a user's subscriptions.", + "operationId": "user-subscription-update-user-subscription", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/subscription-v2_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription-v2" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/user_subscription_response_single" } } + }, + "description": "Update User Subscription response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/user_subscription_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update User Subscription response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update User Subscription", + "tags": ["User Subscription"], + "x-cfPermissionsRequired": { "enum": ["#billing:read", "#billing:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/user/tokens": { + "get": { + "description": "List all access tokens you created.", + "operationId": "user-api-tokens-list-tokens", + "parameters": [ + { + "in": "query", + "name": "page", + "schema": { + "default": 1, + "description": "Page number of paginated results.", + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { + "default": 20, + "description": "Maximum number of results per page.", + "maximum": 50, + "minimum": 5, + "type": "number" + } + }, + { + "in": "query", + "name": "direction", + "schema": { + "description": "Direction to order results.", + "enum": ["asc", "desc"], + "example": "desc", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/response_collection-NcnbjEgN" } } + }, + "description": "List Tokens response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/response_collection-NcnbjEgN" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Tokens response failure" + } + }, + "security": [{ "api_token": [] }], + "summary": "List Tokens", + "tags": ["User API Tokens"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.token.list"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "post": { + "description": "Create a new access token.", + "operationId": "user-api-tokens-create-token", + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_payload" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_create" } } }, + "description": "Create Token response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/response_create" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Token response failure" + } + }, + "security": [{ "api_token": [] }], + "summary": "Create Token", + "tags": ["User API Tokens"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.token.create"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/user/tokens/permission_groups": { + "get": { + "description": "Find all available permission groups.", + "operationId": "permission-groups-list-permission-groups", + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-response_collection-gsiDzBvh" } } + }, + "description": "List Permission Groups response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-response_collection-gsiDzBvh" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Permission Groups response failure" + } + }, + "security": [{ "api_token": [] }], + "summary": "List Permission Groups", + "tags": ["Permission Groups"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.token.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/user/tokens/verify": { + "get": { + "description": "Test whether a token works.", + "operationId": "user-api-tokens-verify-token", + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_single_segment" } } }, + "description": "Verify Token response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/response_single_segment" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Verify Token response failure" + } + }, + "security": [{ "api_token": [] }], + "summary": "Verify Token", + "tags": ["User API Tokens"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/user/tokens/{identifier}": { + "delete": { + "description": "Destroy a token.", + "operationId": "user-api-tokens-delete-token", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier-3n9sRq0H" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single-id-u7jsvBJu" } } + }, + "description": "Delete Token response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single-id-u7jsvBJu" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Token response failure" + } + }, + "security": [{ "api_token": [] }], + "summary": "Delete Token", + "tags": ["User API Tokens"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.token.delete"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "get": { + "description": "Get information about a specific token.", + "operationId": "user-api-tokens-token-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier-3n9sRq0H" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_single" } } }, + "description": "Token Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Token Details response failure" + } + }, + "security": [{ "api_token": [] }], + "summary": "Token Details", + "tags": ["User API Tokens"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.token.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "put": { + "description": "Update an existing token.", + "operationId": "user-api-tokens-update-token", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier-3n9sRq0H" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-token" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_single" } } }, + "description": "Update Token response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Token response failure" + } + }, + "security": [{ "api_token": [] }], + "summary": "Update Token", + "tags": ["User API Tokens"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.token.update"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/user/tokens/{identifier}/value": { + "put": { + "description": "Roll the token secret.", + "operationId": "user-api-tokens-roll-token", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier-3n9sRq0H" } + } + ], + "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/response_single_value" } } }, + "description": "Roll Token response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/response_single_value" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Roll Token response failure" + } + }, + "security": [{ "api_token": [] }], + "summary": "Roll Token", + "tags": ["User API Tokens"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.token.update"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones": { + "get": { + "description": "Lists, searches, sorts, and filters your zones.", + "operationId": "zones-get", + "parameters": [ + { + "in": "query", + "name": "name", + "schema": { + "description": "A domain name.", + "example": "example.com", + "format": "hostname", + "maxLength": 253, + "type": "string" + } + }, + { "in": "query", "name": "status", "schema": { "type": "string" } }, + { "in": "query", "name": "account.id", "schema": { "type": "string" } }, + { "in": "query", "name": "account.name", "schema": { "type": "string" } }, + { + "in": "query", + "name": "page", + "schema": { + "default": 1, + "description": "Page number of paginated results.", + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { + "default": 20, + "description": "Number of zones per page.", + "maximum": 50, + "minimum": 5, + "type": "number" + } + }, + { + "in": "query", + "name": "order", + "schema": { + "description": "Field to order zones by.", + "enum": ["name", "status", "account.id", "account.name"], + "example": "status", + "type": "string" + } + }, + { + "in": "query", + "name": "direction", + "schema": { + "description": "Direction to order zones.", + "enum": ["asc", "desc"], + "example": "desc", + "type": "string" + } + }, + { + "in": "query", + "name": "match", + "schema": { + "default": "all", + "description": "Whether to match all search requirements or at least one (any).", + "enum": ["any", "all"], + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common-jkxlh21Y" }, + { "properties": { "result_info": { "$ref": "#/components/schemas/result_info" } } }, + { + "properties": { "result": { "items": { "$ref": "#/components/schemas/zone" }, "type": "array" } } + } + ] + } + } + }, + "description": "List Zones response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "List Zones response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Zones", + "tags": ["Zone"] + }, + "post": { + "operationId": "zones-post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "account": { + "properties": { "id": { "$ref": "#/components/schemas/identifier-MZFDye9j" } }, + "type": "object" + }, + "name": { "$ref": "#/components/schemas/name-LiICrXvM" }, + "type": { "$ref": "#/components/schemas/type-kxPaBgXc" } + }, + "required": ["name", "account"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common-jkxlh21Y" }, + { "properties": { "result": { "$ref": "#/components/schemas/zone" } }, "type": "object" } + ] + } + } + }, + "description": "Create Zone response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Create Zone response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Zone", + "tags": ["Zone"] + } + }, + "/zones/{identifier1}/load_balancers/{identifier}": { + "delete": { + "description": "Delete a configured load balancer.", + "operationId": "load-balancers-delete-load-balancer", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/load-balancer_components-schemas-identifier" } + }, + { + "in": "path", + "name": "identifier1", + "required": true, + "schema": { "$ref": "#/components/schemas/load-balancer_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-id_response-Ujz7iPfP" } + } + }, + "description": "Delete Load Balancer response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-id_response-Ujz7iPfP" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Load Balancer response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Load Balancer", + "tags": ["Load Balancers"] + }, + "get": { + "description": "Fetch a single configured load balancer.", + "operationId": "load-balancers-load-balancer-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/load-balancer_components-schemas-identifier" } + }, + { + "in": "path", + "name": "identifier1", + "required": true, + "schema": { "$ref": "#/components/schemas/load-balancer_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/load-balancer_components-schemas-single_response" } + } + }, + "description": "Load Balancer Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/load-balancer_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Load Balancer Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Load Balancer Details", + "tags": ["Load Balancers"] + }, + "patch": { + "description": "Apply changes to an existing load balancer, overwriting the supplied properties.", + "operationId": "load-balancers-patch-load-balancer", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/load-balancer_components-schemas-identifier" } + }, + { + "in": "path", + "name": "identifier1", + "required": true, + "schema": { "$ref": "#/components/schemas/load-balancer_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "adaptive_routing": { "$ref": "#/components/schemas/adaptive_routing" }, + "country_pools": { "$ref": "#/components/schemas/country_pools" }, + "default_pools": { "$ref": "#/components/schemas/default_pools" }, + "description": { "$ref": "#/components/schemas/components-schemas-description-UH5FN4sh" }, + "enabled": { "$ref": "#/components/schemas/components-schemas-enabled-tktxdyPy" }, + "fallback_pool": { "$ref": "#/components/schemas/fallback_pool" }, + "location_strategy": { "$ref": "#/components/schemas/location_strategy" }, + "name": { "$ref": "#/components/schemas/components-schemas-name-h5gI0ndx" }, + "pop_pools": { "$ref": "#/components/schemas/pop_pools" }, + "proxied": { "$ref": "#/components/schemas/proxied-ZGed5Tdg" }, + "random_steering": { "$ref": "#/components/schemas/random_steering" }, + "region_pools": { "$ref": "#/components/schemas/region_pools" }, + "rules": { "$ref": "#/components/schemas/rules-8L4eu614" }, + "session_affinity": { "$ref": "#/components/schemas/session_affinity" }, + "session_affinity_attributes": { "$ref": "#/components/schemas/session_affinity_attributes" }, + "session_affinity_ttl": { "$ref": "#/components/schemas/session_affinity_ttl" }, + "steering_policy": { "$ref": "#/components/schemas/steering_policy" }, + "ttl": { "$ref": "#/components/schemas/ttl-0jCBhfJ2" } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/load-balancer_components-schemas-single_response" } + } + }, + "description": "Patch Load Balancer response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/load-balancer_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Patch Load Balancer response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Patch Load Balancer", + "tags": ["Load Balancers"] + }, + "put": { + "description": "Update a configured load balancer.", + "operationId": "load-balancers-update-load-balancer", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/load-balancer_components-schemas-identifier" } + }, + { + "in": "path", + "name": "identifier1", + "required": true, + "schema": { "$ref": "#/components/schemas/load-balancer_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "adaptive_routing": { "$ref": "#/components/schemas/adaptive_routing" }, + "country_pools": { "$ref": "#/components/schemas/country_pools" }, + "default_pools": { "$ref": "#/components/schemas/default_pools" }, + "description": { "$ref": "#/components/schemas/components-schemas-description-UH5FN4sh" }, + "enabled": { "$ref": "#/components/schemas/components-schemas-enabled-tktxdyPy" }, + "fallback_pool": { "$ref": "#/components/schemas/fallback_pool" }, + "location_strategy": { "$ref": "#/components/schemas/location_strategy" }, + "name": { "$ref": "#/components/schemas/components-schemas-name-h5gI0ndx" }, + "pop_pools": { "$ref": "#/components/schemas/pop_pools" }, + "proxied": { "$ref": "#/components/schemas/proxied-ZGed5Tdg" }, + "random_steering": { "$ref": "#/components/schemas/random_steering" }, + "region_pools": { "$ref": "#/components/schemas/region_pools" }, + "rules": { "$ref": "#/components/schemas/rules-8L4eu614" }, + "session_affinity": { "$ref": "#/components/schemas/session_affinity" }, + "session_affinity_attributes": { "$ref": "#/components/schemas/session_affinity_attributes" }, + "session_affinity_ttl": { "$ref": "#/components/schemas/session_affinity_ttl" }, + "steering_policy": { "$ref": "#/components/schemas/steering_policy" }, + "ttl": { "$ref": "#/components/schemas/ttl-0jCBhfJ2" } + }, + "required": ["name", "default_pools", "fallback_pool"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/load-balancer_components-schemas-single_response" } + } + }, + "description": "Update Load Balancer response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/load-balancer_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Load Balancer response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Load Balancer", + "tags": ["Load Balancers"] + } + }, + "/zones/{identifier}": { + "delete": { + "description": "Deletes an existing zone.", + "operationId": "zones-0-delete", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single-id-TFlitJo2" } } + }, + "description": "Delete Zone response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Delete Zone response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Zone", + "tags": ["Zone"], + "x-cfPermissionsRequired": { "enum": ["#zone:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "get": { + "operationId": "zones-0-get", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common-jkxlh21Y" }, + { "properties": { "result": { "$ref": "#/components/schemas/zone" } }, "type": "object" } + ] + } + } + }, + "description": "Zone Details response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Zone Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Zone Details", + "tags": ["Zone"], + "x-cfPermissionsRequired": { "enum": ["#zone:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Editz a zone. Only one zone property can be changed at a time.", + "operationId": "zones-0-patch", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "example": { "paused": true }, + "properties": { + "paused": { "$ref": "#/components/schemas/paused" }, + "plan": { + "description": "(Deprecated) Please use the `/zones/{identifier}/subscription` API\nto update a zone's plan. Changing this value will create/cancel\nassociated subscriptions. To view available plans for this zone,\nsee Zone Plans.\n", + "properties": { "id": { "$ref": "#/components/schemas/identifier-MZFDye9j" } }, + "type": "object" + }, + "type": { + "description": "A full zone implies that DNS is hosted with Cloudflare. A partial zone is typically a partner-hosted zone or a CNAME setup. This parameter is only available to Enterprise customers or if it has been explicitly enabled on a zone.", + "enum": ["full", "partial"], + "example": "full", + "type": "string" + }, + "vanity_name_servers": { "$ref": "#/components/schemas/vanity_name_servers" } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common-jkxlh21Y" }, + { "properties": { "result": { "$ref": "#/components/schemas/zone" } }, "type": "object" } + ] + } + } + }, + "description": "Edit Zone response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Edit Zone response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Edit Zone", + "tags": ["Zone"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{identifier}/access/apps": { + "get": { + "description": "List all Access Applications in a zone.", + "operationId": "zone-level-access-applications-list-access-applications", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/apps_components-schemas-response_collection-2" } + } + }, + "description": "List Access Applications response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/apps_components-schemas-response_collection-2" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Access Applications response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Access Applications", + "tags": ["Zone-Level Access applications"] + }, + "post": { + "description": "Adds a new application to Access.", + "operationId": "zone-level-access-applications-add-a-bookmark-application", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-apps" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/apps_components-schemas-single_response-2" }, + { "properties": { "result": { "$ref": "#/components/schemas/schemas-apps" } } } + ] + } + } + }, + "description": "Add an Access application response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/apps_components-schemas-single_response-2" }, + { + "properties": { + "result": { + "allOf": [ + { "$ref": "#/components/schemas/basic_app_response_props" }, + { "$ref": "#/components/schemas/schemas-bookmark_props" } + ] + } + } + } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Add an Access application response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Add an Access application", + "tags": ["Zone-Level Access applications"] + } + }, + "/zones/{identifier}/access/apps/ca": { + "get": { + "description": "Lists short-lived certificate CAs and their public keys.", + "operationId": "zone-level-access-short-lived-certificate-c-as-list-short-lived-certificate-c-as", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ca_components-schemas-response_collection" } + } + }, + "description": "List short-lived certificate CAs response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/ca_components-schemas-response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List short-lived certificate CAs response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List short-lived certificate CAs", + "tags": ["Zone-Level Access short-lived certificate CAs"] + } + }, + "/zones/{identifier}/access/apps/{app_id}": { + "delete": { + "description": "Deletes an application from Access.", + "operationId": "zone-level-access-applications-delete-an-access-application", + "parameters": [ + { + "in": "path", + "name": "app_id", + "required": true, + "schema": { "$ref": "#/components/schemas/app_id-akwLjhUv" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-id_response-th0exOPu" } + } + }, + "description": "Delete an Access application response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-id_response-th0exOPu" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete an Access application response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete an Access application", + "tags": ["Zone-Level Access applications"] + }, + "get": { + "description": "Fetches information about an Access application.", + "operationId": "zone-level-access-applications-get-an-access-application", + "parameters": [ + { + "in": "path", + "name": "app_id", + "required": true, + "schema": { "$ref": "#/components/schemas/app_id-akwLjhUv" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/apps_components-schemas-single_response-2" } + } + }, + "description": "Get an Access application response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/apps_components-schemas-single_response-2" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get an Access application response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get an Access application", + "tags": ["Zone-Level Access applications"] + }, + "put": { + "description": "Updates an Access application.", + "operationId": "zone-level-access-applications-update-a-bookmark-application", + "parameters": [ + { + "in": "path", + "name": "app_id", + "required": true, + "schema": { "$ref": "#/components/schemas/app_id-akwLjhUv" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-apps" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/apps_components-schemas-single_response-2" }, + { "properties": { "result": { "$ref": "#/components/schemas/schemas-apps" } } } + ] + } + } + }, + "description": "Update an Access application response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/apps_components-schemas-single_response-2" }, + { + "properties": { + "result": { + "allOf": [ + { "$ref": "#/components/schemas/basic_app_response_props" }, + { "$ref": "#/components/schemas/schemas-bookmark_props" } + ] + } + } + } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update an Access application response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update an Access application", + "tags": ["Zone-Level Access applications"] + } + }, + "/zones/{identifier}/access/apps/{app_id}/revoke_tokens": { + "post": { + "description": "Revokes all service tokens used by an application.", + "operationId": "zone-level-access-applications-revoke-service-tokens", + "parameters": [ + { + "in": "path", + "name": "app_id", + "required": true, + "schema": { "$ref": "#/components/schemas/app_id-akwLjhUv" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-empty_response" } } }, + "description": "Revoke service tokens response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-empty_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Revoke service tokens response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Revoke service tokens", + "tags": ["Zone-Level Access applications"] + } + }, + "/zones/{identifier}/access/apps/{app_id}/user_policy_checks": { + "get": { + "description": "Tests if a specific user has permission to access an application.", + "operationId": "zone-level-access-applications-test-access-policies", + "parameters": [ + { + "in": "path", + "name": "app_id", + "required": true, + "schema": { "$ref": "#/components/schemas/app_id-akwLjhUv" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/policy_check_response" } } }, + "description": "Test Access policies response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/policy_check_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Test Access policies response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Test Access policies", + "tags": ["Zone-Level Access applications"] + } + }, + "/zones/{identifier}/access/apps/{uuid1}/policies/{uuid}": { + "delete": { + "description": "Delete an Access policy.", + "operationId": "zone-level-access-policies-delete-an-access-policy", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-uuid" } + }, + { + "in": "path", + "name": "uuid1", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-uuid" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/policies_components-schemas-id_response" } + } + }, + "description": "Delete an Access policy response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/policies_components-schemas-id_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete an Access policy response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete an Access policy", + "tags": ["Zone-Level Access policies"] + }, + "get": { + "description": "Fetches a single Access policy.", + "operationId": "zone-level-access-policies-get-an-access-policy", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-uuid" } + }, + { + "in": "path", + "name": "uuid1", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-uuid" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/policies_components-schemas-single_response" } + } + }, + "description": "Get an Access policy response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/policies_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get an Access policy response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get an Access policy", + "tags": ["Zone-Level Access policies"] + }, + "put": { + "description": "Update a configured Access policy.", + "operationId": "zone-level-access-policies-update-an-access-policy", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-uuid" } + }, + { + "in": "path", + "name": "uuid1", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-uuid" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "approval_groups": { "$ref": "#/components/schemas/approval_groups" }, + "approval_required": { "$ref": "#/components/schemas/approval_required" }, + "decision": { "$ref": "#/components/schemas/decision" }, + "exclude": { "$ref": "#/components/schemas/schemas-exclude" }, + "include": { "$ref": "#/components/schemas/include" }, + "name": { "$ref": "#/components/schemas/policies_components-schemas-name" }, + "precedence": { "$ref": "#/components/schemas/precedence-GXhj5toi" }, + "purpose_justification_prompt": { "$ref": "#/components/schemas/purpose_justification_prompt" }, + "purpose_justification_required": { "$ref": "#/components/schemas/purpose_justification_required" }, + "require": { "$ref": "#/components/schemas/schemas-require" } + }, + "required": ["name", "decision", "include"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/policies_components-schemas-single_response" } + } + }, + "description": "Update an Access policy response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/policies_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update an Access policy response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update an Access policy", + "tags": ["Zone-Level Access policies"] + } + }, + "/zones/{identifier}/access/apps/{uuid}/ca": { + "delete": { + "description": "Deletes a short-lived certificate CA.", + "operationId": "zone-level-access-short-lived-certificate-c-as-delete-a-short-lived-certificate-ca", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-id_response-77ATe4Eu" } } + }, + "description": "Delete a short-lived certificate CA response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-id_response-77ATe4Eu" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete a short-lived certificate CA response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete a short-lived certificate CA", + "tags": ["Zone-Level Access short-lived certificate CAs"] + }, + "get": { + "description": "Fetches a short-lived certificate CA and its public key.", + "operationId": "zone-level-access-short-lived-certificate-c-as-get-a-short-lived-certificate-ca", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ca_components-schemas-single_response" } } + }, + "description": "Get a short-lived certificate CA response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/ca_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get a short-lived certificate CA response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a short-lived certificate CA", + "tags": ["Zone-Level Access short-lived certificate CAs"] + }, + "post": { + "description": "Generates a new short-lived certificate CA and public key.", + "operationId": "zone-level-access-short-lived-certificate-c-as-create-a-short-lived-certificate-ca", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ca_components-schemas-single_response" } } + }, + "description": "Create a short-lived certificate CA response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/ca_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create a short-lived certificate CA response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create a short-lived certificate CA", + "tags": ["Zone-Level Access short-lived certificate CAs"] + } + }, + "/zones/{identifier}/access/apps/{uuid}/policies": { + "get": { + "description": "Lists Access policies configured for an application.", + "operationId": "zone-level-access-policies-list-access-policies", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-uuid" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/policies_components-schemas-response_collection" } + } + }, + "description": "List Access policies response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/policies_components-schemas-response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Access policies response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Access policies", + "tags": ["Zone-Level Access policies"] + }, + "post": { + "description": "Create a new Access policy for an application.", + "operationId": "zone-level-access-policies-create-an-access-policy", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/components-schemas-uuid" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "approval_groups": { "$ref": "#/components/schemas/approval_groups" }, + "approval_required": { "$ref": "#/components/schemas/approval_required" }, + "decision": { "$ref": "#/components/schemas/decision" }, + "exclude": { "$ref": "#/components/schemas/schemas-exclude" }, + "include": { "$ref": "#/components/schemas/include" }, + "name": { "$ref": "#/components/schemas/policies_components-schemas-name" }, + "precedence": { "$ref": "#/components/schemas/precedence-GXhj5toi" }, + "purpose_justification_prompt": { "$ref": "#/components/schemas/purpose_justification_prompt" }, + "purpose_justification_required": { "$ref": "#/components/schemas/purpose_justification_required" }, + "require": { "$ref": "#/components/schemas/schemas-require" } + }, + "required": ["name", "decision", "include"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/policies_components-schemas-single_response" } + } + }, + "description": "Create an Access policy response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/policies_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create an Access policy response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create an Access policy", + "tags": ["Zone-Level Access policies"] + } + }, + "/zones/{identifier}/access/certificates": { + "get": { + "description": "Lists all mTLS certificates.", + "operationId": "zone-level-access-m-tls-authentication-list-m-tls-certificates", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/certificates_components-schemas-response_collection" } + } + }, + "description": "List mTLS certificates response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/certificates_components-schemas-response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List mTLS certificates response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List mTLS certificates", + "tags": ["Zone-Level Access mTLS authentication"] + }, + "post": { + "description": "Adds a new mTLS root certificate to Access.", + "operationId": "zone-level-access-m-tls-authentication-add-an-m-tls-certificate", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "associated_hostnames": { "$ref": "#/components/schemas/associated_hostnames" }, + "certificate": { + "description": "The certificate content.", + "example": "-----BEGIN CERTIFICATE-----\nMIIGAjCCA+qgAwIBAgIJAI7kymlF7CWT...N4RI7KKB7nikiuUf8vhULKy5IX10\nDrUtmu/B\n-----END CERTIFICATE-----", + "type": "string" + }, + "name": { "$ref": "#/components/schemas/certificates_components-schemas-name" } + }, + "required": ["name", "certificate"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/certificates_components-schemas-single_response" } + } + }, + "description": "Add an mTLS certificate response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/certificates_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Add an mTLS certificate response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Add an mTLS certificate", + "tags": ["Zone-Level Access mTLS authentication"] + } + }, + "/zones/{identifier}/access/certificates/settings": { + "get": { + "description": "List all mTLS hostname settings for this zone.", + "operationId": "zone-level-access-m-tls-authentication-list-m-tls-certificates-hostname-settings", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/response_collection_hostnames" } } + }, + "description": "List mTLS hostname settings response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/response_collection_hostnames" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List mTLS hostname settings response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List all mTLS hostname settings", + "tags": ["Zone-Level Access mTLS authentication"] + } + }, + "/zones/{identifier}/access/certificates/{uuid}": { + "delete": { + "description": "Deletes an mTLS certificate.", + "operationId": "zone-level-access-m-tls-authentication-delete-an-m-tls-certificate", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-id_response-th0exOPu" } + } + }, + "description": "Delete an mTLS certificate response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-id_response-th0exOPu" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete an mTLS certificate response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete an mTLS certificate", + "tags": ["Zone-Level Access mTLS authentication"] + }, + "get": { + "description": "Fetches a single mTLS certificate.", + "operationId": "zone-level-access-m-tls-authentication-get-an-m-tls-certificate", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/certificates_components-schemas-single_response" } + } + }, + "description": "Get an mTLS certificate response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/certificates_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get an mTLS certificate response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get an mTLS certificate", + "tags": ["Zone-Level Access mTLS authentication"] + }, + "put": { + "description": "Updates a configured mTLS certificate.", + "operationId": "zone-level-access-m-tls-authentication-update-an-m-tls-certificate", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "associated_hostnames": { "$ref": "#/components/schemas/associated_hostnames" }, + "name": { "$ref": "#/components/schemas/certificates_components-schemas-name" } + }, + "required": ["name", "associated_hostnames"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/certificates_components-schemas-single_response" } + } + }, + "description": "Update an mTLS certificate response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/certificates_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update an mTLS certificate response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update an mTLS certificate", + "tags": ["Zone-Level Access mTLS authentication"] + } + }, + "/zones/{identifier}/access/certificates/{uuid}/settings": { + "put": { + "description": "Updates an mTLS certificates hostname settings.", + "operationId": "zone-level-access-mtls-authentication-update-an-mtls-certificate-settings", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "settings": { "items": { "$ref": "#/components/schemas/settings-s418OBZp" }, "type": "array" } + }, + "required": ["settings"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response_hostnames" } } + }, + "description": "Update an mTLS certificates hostname settings response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response_hostnames" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update an mTLS certificates hostname settings failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update an mTLS certificates hostname settings", + "tags": ["Zone-Level Access mTLS authentication"] + } + }, + "/zones/{identifier}/access/groups": { + "get": { + "description": "Lists all Access groups.", + "operationId": "zone-level-access-groups-list-access-groups", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-response_collection-4HEckTYK" } } + }, + "description": "List Access groups response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-response_collection-4HEckTYK" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Access groups response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Access groups", + "tags": ["Zone-Level Access groups"] + }, + "post": { + "description": "Creates a new Access group.", + "operationId": "zone-level-access-groups-create-an-access-group", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "exclude": { "$ref": "#/components/schemas/exclude" }, + "include": { "$ref": "#/components/schemas/include" }, + "name": { "$ref": "#/components/schemas/components-schemas-name-4G3Rlgj8" }, + "require": { "$ref": "#/components/schemas/require" } + }, + "required": ["name", "include"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-single_response-gP2O4PI2" } + } + }, + "description": "Create an Access group response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-single_response-gP2O4PI2" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create an Access group response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create an Access group", + "tags": ["Zone-Level Access groups"] + } + }, + "/zones/{identifier}/access/groups/{uuid}": { + "delete": { + "description": "Deletes an Access group.", + "operationId": "zone-level-access-groups-delete-an-access-group", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-uuid-JmfIpL8C" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/id_response-DDywCCxj" } } }, + "description": "Delete an Access group response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/id_response-DDywCCxj" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete an Access group response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete an Access group", + "tags": ["Zone-Level Access groups"] + }, + "get": { + "description": "Fetches a single Access group.", + "operationId": "zone-level-access-groups-get-an-access-group", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-uuid-JmfIpL8C" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-single_response-gP2O4PI2" } + } + }, + "description": "Get an Access group response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-single_response-gP2O4PI2" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get an Access group response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get an Access group", + "tags": ["Zone-Level Access groups"] + }, + "put": { + "description": "Updates a configured Access group.", + "operationId": "zone-level-access-groups-update-an-access-group", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-uuid-JmfIpL8C" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "exclude": { "$ref": "#/components/schemas/exclude" }, + "include": { "$ref": "#/components/schemas/include" }, + "name": { "$ref": "#/components/schemas/components-schemas-name-4G3Rlgj8" }, + "require": { "$ref": "#/components/schemas/require" } + }, + "required": ["name", "include"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-single_response-gP2O4PI2" } + } + }, + "description": "Update an Access group response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-single_response-gP2O4PI2" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update an Access group response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update an Access group", + "tags": ["Zone-Level Access groups"] + } + }, + "/zones/{identifier}/access/identity_providers": { + "get": { + "description": "Lists all configured identity providers.", + "operationId": "zone-level-access-identity-providers-list-access-identity-providers", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/identity-providers_components-schemas-response_collection" } + } + }, + "description": "List Access identity providers response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/identity-providers_components-schemas-response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Access identity providers response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Access identity providers", + "tags": ["Zone-Level Access identity providers"] + }, + "post": { + "description": "Adds a new identity provider to Access.", + "operationId": "zone-level-access-identity-providers-add-an-access-identity-provider", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-identity-providers" } } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/identity-providers_components-schemas-single_response" } + } + }, + "description": "Add an Access identity provider response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/identity-providers_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Add an Access identity provider response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Add an Access identity provider", + "tags": ["Zone-Level Access identity providers"] + } + }, + "/zones/{identifier}/access/identity_providers/{uuid}": { + "delete": { + "description": "Deletes an identity provider from Access.", + "operationId": "zone-level-access-identity-providers-delete-an-access-identity-provider", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single-id" } } }, + "description": "Delete an Access identity provider response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/identity-providers_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete an Access identity provider response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete an Access identity provider", + "tags": ["Zone-Level Access identity providers"] + }, + "get": { + "description": "Fetches a configured identity provider.", + "operationId": "zone-level-access-identity-providers-get-an-access-identity-provider", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/identity-providers_components-schemas-single_response" } + } + }, + "description": "Get an Access identity provider response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/identity-providers_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get an Access identity provider response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get an Access identity provider", + "tags": ["Zone-Level Access identity providers"] + }, + "put": { + "description": "Updates a configured identity provider.", + "operationId": "zone-level-access-identity-providers-update-an-access-identity-provider", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-identity-providers" } } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/identity-providers_components-schemas-single_response" } + } + }, + "description": "Update an Access identity provider response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/identity-providers_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update an Access identity provider response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update an Access identity provider", + "tags": ["Zone-Level Access identity providers"] + } + }, + "/zones/{identifier}/access/organizations": { + "get": { + "description": "Returns the configuration for your Zero Trust organization.", + "operationId": "zone-level-zero-trust-organization-get-your-zero-trust-organization", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response-x2K6CTG8" } } + }, + "description": "Get your Zero Trust organization response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response-x2K6CTG8" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get your Zero Trust organization response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get your Zero Trust organization", + "tags": ["Zone-Level Zero Trust organization"] + }, + "post": { + "description": "Sets up a Zero Trust organization for your account.", + "operationId": "zone-level-zero-trust-organization-create-your-zero-trust-organization", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "auth_domain": { "$ref": "#/components/schemas/auth_domain" }, + "is_ui_read_only": { "$ref": "#/components/schemas/is_ui_read_only" }, + "login_design": { "$ref": "#/components/schemas/login_design" }, + "name": { "$ref": "#/components/schemas/name-xgxcxGi8" }, + "ui_read_only_toggle_reason": { "$ref": "#/components/schemas/ui_read_only_toggle_reason" }, + "user_seat_expiration_inactive_time": { + "$ref": "#/components/schemas/user_seat_expiration_inactive_time" + } + }, + "required": ["name", "auth_domain"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response-x2K6CTG8" } } + }, + "description": "Create your Zero Trust organization response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response-x2K6CTG8" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create your Zero Trust organization response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create your Zero Trust organization", + "tags": ["Zone-Level Zero Trust organization"] + }, + "put": { + "description": "Updates the configuration for your Zero Trust organization.", + "operationId": "zone-level-zero-trust-organization-update-your-zero-trust-organization", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "auth_domain": { "$ref": "#/components/schemas/auth_domain" }, + "is_ui_read_only": { "$ref": "#/components/schemas/is_ui_read_only" }, + "login_design": { "$ref": "#/components/schemas/login_design" }, + "name": { "$ref": "#/components/schemas/name-xgxcxGi8" }, + "ui_read_only_toggle_reason": { "$ref": "#/components/schemas/ui_read_only_toggle_reason" }, + "user_seat_expiration_inactive_time": { + "$ref": "#/components/schemas/user_seat_expiration_inactive_time" + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response-x2K6CTG8" } } + }, + "description": "Update your Zero Trust organization response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response-x2K6CTG8" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update your Zero Trust organization response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update your Zero Trust organization", + "tags": ["Zone-Level Zero Trust organization"] + } + }, + "/zones/{identifier}/access/organizations/revoke_user": { + "post": { + "description": "Revokes a user's access across all applications.", + "operationId": "zone-level-zero-trust-organization-revoke-all-access-tokens-for-a-user", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "email": { + "description": "The email of the user to revoke.", + "example": "test@example.com", + "type": "string" + } + }, + "required": ["email"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/empty_response-47a5DGxM" } } }, + "description": "Revoke all Access tokens for a user response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/empty_response-47a5DGxM" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Revoke all Access tokens for a user response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Revoke all Access tokens for a user", + "tags": ["Zone-Level Zero Trust organization"] + } + }, + "/zones/{identifier}/access/service_tokens": { + "get": { + "description": "Lists all service tokens.", + "operationId": "zone-level-access-service-tokens-list-service-tokens", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-response_collection-Qou49Scv" } + } + }, + "description": "List service tokens response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-response_collection-Qou49Scv" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List service tokens response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List service tokens", + "tags": ["Zone-Level Access service tokens"] + }, + "post": { + "description": "Generates a new service token. **Note:** This is the only time you can get the Client Secret. If you lose the Client Secret, you will have to create a new service token.", + "operationId": "zone-level-access-service-tokens-create-a-service-token", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "name": { "$ref": "#/components/schemas/service-tokens_components-schemas-name" } }, + "required": ["name"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_response" } } }, + "description": "Create a service token response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/create_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create a service token response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create a service token", + "tags": ["Zone-Level Access service tokens"] + } + }, + "/zones/{identifier}/access/service_tokens/{uuid}": { + "delete": { + "description": "Deletes a service token.", + "operationId": "zone-level-access-service-tokens-delete-a-service-token", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/service-tokens_components-schemas-single_response" } + } + }, + "description": "Delete a service token response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/service-tokens_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete a service token response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete a service token", + "tags": ["Zone-Level Access service tokens"] + }, + "put": { + "description": "Updates a configured service token.", + "operationId": "zone-level-access-service-tokens-update-a-service-token", + "parameters": [ + { + "in": "path", + "name": "uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-EBZK5Bp1" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "name": { "$ref": "#/components/schemas/service-tokens_components-schemas-name" } } + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/service-tokens_components-schemas-single_response" } + } + }, + "description": "Update a service token response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/service-tokens_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update a service token response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update a service token", + "tags": ["Zone-Level Access service tokens"] + } + }, + "/zones/{identifier}/dns_analytics/report": { + "get": { + "description": "Retrieves a list of summarised aggregate metrics over a given time period.\n\nSee [Analytics API properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/) for detailed information about the available query parameters.", + "operationId": "dns-analytics-table", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-98VX040R" } + }, + { "in": "query", "name": "metrics", "schema": { "$ref": "#/components/schemas/metrics" } }, + { "in": "query", "name": "dimensions", "schema": { "$ref": "#/components/schemas/dimensions" } }, + { "in": "query", "name": "since", "schema": { "$ref": "#/components/schemas/since" } }, + { "in": "query", "name": "until", "schema": { "$ref": "#/components/schemas/until" } }, + { "in": "query", "name": "limit", "schema": { "$ref": "#/components/schemas/limit" } }, + { "in": "query", "name": "sort", "schema": { "$ref": "#/components/schemas/sort" } }, + { "in": "query", "name": "filters", "schema": { "$ref": "#/components/schemas/filters-6K6BiPDe" } } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/report" } }, "type": "object" } + ] + } + } + }, + "description": "Table response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/report" } }, "type": "object" } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Table response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Table", + "tags": ["DNS Analytics"], + "x-cfPermissionsRequired": { "enum": ["#analytics:read"] } + } + }, + "/zones/{identifier}/dns_analytics/report/bytime": { + "get": { + "description": "Retrieves a list of aggregate metrics grouped by time interval.\n\nSee [Analytics API properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/) for detailed information about the available query parameters.", + "operationId": "dns-analytics-by-time", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-98VX040R" } + }, + { "in": "query", "name": "metrics", "schema": { "$ref": "#/components/schemas/metrics" } }, + { "in": "query", "name": "dimensions", "schema": { "$ref": "#/components/schemas/dimensions" } }, + { "in": "query", "name": "since", "schema": { "$ref": "#/components/schemas/since" } }, + { "in": "query", "name": "until", "schema": { "$ref": "#/components/schemas/until" } }, + { "in": "query", "name": "limit", "schema": { "$ref": "#/components/schemas/limit" } }, + { "in": "query", "name": "sort", "schema": { "$ref": "#/components/schemas/sort" } }, + { "in": "query", "name": "filters", "schema": { "$ref": "#/components/schemas/filters-6K6BiPDe" } }, + { "in": "query", "name": "time_delta", "schema": { "$ref": "#/components/schemas/time_delta" } } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/report_bytime" } }, "type": "object" } + ] + } + } + }, + "description": "By Time response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { "result": { "$ref": "#/components/schemas/report_bytime" } }, + "type": "object" + } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "By Time response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "By Time", + "tags": ["DNS Analytics"], + "x-cfPermissionsRequired": { "enum": ["#analytics:read"] } + } + }, + "/zones/{identifier}/load_balancers": { + "get": { + "description": "List configured load balancers.", + "operationId": "load-balancers-list-load-balancers", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/load-balancer_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/load-balancer_components-schemas-response_collection" } + } + }, + "description": "List Load Balancers response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/load-balancer_components-schemas-response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Load Balancers response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Load Balancers", + "tags": ["Load Balancers"] + }, + "post": { + "description": "Create a new load balancer.", + "operationId": "load-balancers-create-load-balancer", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/load-balancer_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "adaptive_routing": { "$ref": "#/components/schemas/adaptive_routing" }, + "country_pools": { "$ref": "#/components/schemas/country_pools" }, + "default_pools": { "$ref": "#/components/schemas/default_pools" }, + "description": { "$ref": "#/components/schemas/components-schemas-description-UH5FN4sh" }, + "fallback_pool": { "$ref": "#/components/schemas/fallback_pool" }, + "location_strategy": { "$ref": "#/components/schemas/location_strategy" }, + "name": { "$ref": "#/components/schemas/components-schemas-name-h5gI0ndx" }, + "pop_pools": { "$ref": "#/components/schemas/pop_pools" }, + "proxied": { "$ref": "#/components/schemas/proxied-ZGed5Tdg" }, + "random_steering": { "$ref": "#/components/schemas/random_steering" }, + "region_pools": { "$ref": "#/components/schemas/region_pools" }, + "rules": { "$ref": "#/components/schemas/rules-8L4eu614" }, + "session_affinity": { "$ref": "#/components/schemas/session_affinity" }, + "session_affinity_attributes": { "$ref": "#/components/schemas/session_affinity_attributes" }, + "session_affinity_ttl": { "$ref": "#/components/schemas/session_affinity_ttl" }, + "steering_policy": { "$ref": "#/components/schemas/steering_policy" }, + "ttl": { "$ref": "#/components/schemas/ttl-0jCBhfJ2" } + }, + "required": ["name", "default_pools", "fallback_pool"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/load-balancer_components-schemas-single_response" } + } + }, + "description": "Create Load Balancer response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/load-balancer_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Load Balancer response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Load Balancer", + "tags": ["Load Balancers"] + } + }, + "/zones/{identifier}/purge_cache": { + "post": { + "description": "### Purge All Cached Content\nRemoves ALL files from Cloudflare's cache. All tiers can purge everything.\n\n### Purge Cached Content by URL\nGranularly removes one or more files from Cloudflare's cache by specifying URLs. All tiers can purge by URL.\n\nTo purge files with custom cache keys, include the headers used to compute the cache key as in the example. If you have a device type or geo in your cache key, you will need to include the CF-Device-Type or CF-IPCountry headers.\n\n**NB:** When including the Origin header, be sure to include the **scheme** and **hostname**. The port number can be omitted if it is the default port (80 for http, 443 for https), but must be included otherwise.\n\n### Purge Cached Content by Tag, Host or Prefix\nGranularly removes one or more files from Cloudflare's cache either by specifying the host, the associated Cache-Tag, or a Prefix. Only Enterprise customers are permitted to purge by Tag, Host or Prefix.\n\n**NB:** Cache-Tag, host, and prefix purging each have a rate limit of 30,000 purge API calls in every 24 hour period. You may purge up to 30 tags, hosts, or prefixes in one API call. This rate limit can be raised for customers who need to purge at higher volume.\n", + "operationId": "zone-purge", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-BccsQUhC" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "anyOf": [ + { "$ref": "#/components/schemas/Flex" }, + { "$ref": "#/components/schemas/Everything" }, + { "$ref": "#/components/schemas/Files" } + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single-id" } } }, + "description": "Purge Cached Content" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single-id" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Purge Cached Content failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Purge Cached Content", + "tags": ["Zone"], + "x-cfPermissionsRequired": { "enum": ["#cache_purge:edit"] } + } + }, + "/zones/{identifier}/ssl/analyze": { + "post": { + "description": "Returns the set of hostnames, the signature algorithm, and the expiration date of the certificate.", + "operationId": "analyze-certificate-analyze-certificate", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "bundle_method": { "$ref": "#/components/schemas/bundle_method" }, + "certificate": { "$ref": "#/components/schemas/certificate" } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/certificate_analyze_response" } } + }, + "description": "Analyze Certificate response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/certificate_analyze_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Analyze Certificate response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Analyze Certificate", + "tags": ["Analyze Certificate"], + "x-cfPermissionsRequired": { "enum": ["#ssl:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{identifier}/subscription": { + "get": { + "description": "Lists zone subscription details.", + "operationId": "zone-subscription-zone-subscription-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/subscription-v2_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/zone_subscription_response_single" } } + }, + "description": "Zone Subscription Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_subscription_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Zone Subscription Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Zone Subscription Details", + "tags": ["Zone Subscription"], + "x-cfPermissionsRequired": { "enum": ["#billing:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "post": { + "description": "Create a zone subscription, either plan or add-ons.", + "operationId": "zone-subscription-create-zone-subscription", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/subscription-v2_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription-v2" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/zone_subscription_response_single" } } + }, + "description": "Create Zone Subscription response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_subscription_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Zone Subscription response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Zone Subscription", + "tags": ["Zone Subscription"], + "x-cfPermissionsRequired": { "enum": ["#billing:read", "#billing:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "put": { + "description": "Updates zone subscriptions, either plan or add-ons.", + "operationId": "zone-subscription-update-zone-subscription", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/subscription-v2_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/subscription-v2" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/zone_subscription_response_single" } } + }, + "description": "Update Zone Subscription response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_subscription_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Zone Subscription response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Zone Subscription", + "tags": ["Zone Subscription"], + "x-cfPermissionsRequired": { "enum": ["#billing:read", "#billing:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/acm/total_tls": { + "get": { + "description": "Get Total TLS Settings for a Zone.", + "operationId": "total-tls-total-tls-settings-details", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/total_tls_settings_response-uh822r21" } } + }, + "description": "Total TLS Settings Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/total_tls_settings_response-uh822r21" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Total TLS Settings Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Total TLS Settings Details", + "tags": ["Total TLS"], + "x-cfPermissionsRequired": { "enum": ["#ssl:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "post": { + "description": "Set Total TLS Settings or disable the feature for a Zone.", + "operationId": "total-tls-enable-or-disable-total-tls", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "certificate_authority": { "$ref": "#/components/schemas/schemas-certificate_authority-mu8utRU0" }, + "enabled": { "$ref": "#/components/schemas/components-schemas-enabled" } + }, + "required": ["enabled"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/total_tls_settings_response-uh822r21" } } + }, + "description": "Enable or Disable Total TLS response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/total_tls_settings_response-uh822r21" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Enable or Disable Total TLS response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Enable or Disable Total TLS", + "tags": ["Total TLS"], + "x-cfPermissionsRequired": { "enum": ["#ssl:read", "#ssl:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/analytics/colos": { + "get": { + "deprecated": true, + "description": "This view provides a breakdown of analytics data by datacenter. Note: This is available to Enterprise customers only.", + "operationId": "zone-analytics-(-deprecated)-get-analytics-by-co-locations", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { "in": "query", "name": "until", "schema": { "$ref": "#/components/schemas/until-HpHDrENT" } }, + { + "in": "query", + "name": "since", + "schema": { + "anyOf": [{ "type": "string" }, { "type": "integer" }], + "default": -10080, + "description": "The (inclusive) beginning of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. At this point in time, it cannot exceed a time in the past greater than one year.\n\nRanges that the Cloudflare web application provides will provide the following period length for each point:\n- Last 60 minutes (from -59 to -1): 1 minute resolution\n- Last 7 hours (from -419 to -60): 15 minutes resolution\n- Last 15 hours (from -899 to -420): 30 minutes resolution\n- Last 72 hours (from -4320 to -900): 1 hour resolution\n- Older than 3 days (-525600 to -4320): 1 day resolution.", + "example": "2015-01-01T12:23:00Z" + } + }, + { + "in": "query", + "name": "continuous", + "schema": { + "default": true, + "description": "When set to true, the API will move the requested time window backward, until it finds a region with completely aggregated data.\n\nThe API response _may not represent the requested time window_.", + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/colo_response" } } }, + "description": "Get analytics by Co-locations response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/colo_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get analytics by Co-locations response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get analytics by Co-locations", + "tags": ["Zone Analytics (Deprecated)"], + "x-cfDeprecation": { + "description": "Please use the new GraphQL Analytics API instead: https://developers.cloudflare.com/analytics/graphql-api/. It provides equivalent data and more features, including the ability to select only the metrics you need. Migration guide: https://developers.cloudflare.com/analytics/migration-guides/zone-analytics/.", + "display": true, + "eol": "2021-03-01", + "id": "zone_analytics_deprecation" + }, + "x-cfPermissionsRequired": { "enum": ["#analytics:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/analytics/dashboard": { + "get": { + "deprecated": true, + "description": "The dashboard view provides both totals and timeseries data for the given zone and time period across the entire Cloudflare network.", + "operationId": "zone-analytics-(-deprecated)-get-dashboard", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { "in": "query", "name": "until", "schema": { "$ref": "#/components/schemas/until-HpHDrENT" } }, + { + "in": "query", + "name": "since", + "schema": { + "anyOf": [{ "type": "string" }, { "type": "integer" }], + "default": -10080, + "description": "The (inclusive) beginning of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. At this point in time, it cannot exceed a time in the past greater than one year.\n\nRanges that the Cloudflare web application provides will provide the following period length for each point:\n- Last 60 minutes (from -59 to -1): 1 minute resolution\n- Last 7 hours (from -419 to -60): 15 minutes resolution\n- Last 15 hours (from -899 to -420): 30 minutes resolution\n- Last 72 hours (from -4320 to -900): 1 hour resolution\n- Older than 3 days (-525600 to -4320): 1 day resolution.", + "example": "2015-01-01T12:23:00Z" + } + }, + { + "in": "query", + "name": "continuous", + "schema": { + "default": true, + "description": "When set to true, the API will move the requested time window backward, until it finds a region with completely aggregated data.\n\nThe API response _may not represent the requested time window_.", + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dashboard_response" } } }, + "description": "Get dashboard response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/dashboard_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get dashboard response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get dashboard", + "tags": ["Zone Analytics (Deprecated)"], + "x-cfDeprecation": { + "description": "Please use the new GraphQL Analytics API instead: https://developers.cloudflare.com/analytics/graphql-api/. It provides equivalent data and more features, including the ability to select only the metrics you need. Migration guide: https://developers.cloudflare.com/analytics/migration-guides/zone-analytics/.", + "display": true, + "eol": "2021-03-01", + "id": "zone_analytics_deprecation" + }, + "x-cfPermissionsRequired": { "enum": ["#analytics:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/analytics/latency": { + "get": { + "operationId": "argo-analytics-for-zone-argo-analytics-for-a-zone", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { "in": "query", "name": "bins", "schema": { "type": "string" } } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-response_single" } } }, + "description": "Argo Analytics for a zone response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Argo Analytics for a zone response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Argo Analytics for a zone", + "tags": ["Argo Analytics for Zone"], + "x-cfPermissionsRequired": { "enum": ["#analytics:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/analytics/latency/colos": { + "get": { + "operationId": "argo-analytics-for-geolocation-argo-analytics-for-a-zone-at-different-po-ps", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-response_single" } } }, + "description": "Argo Analytics for a zone at different PoPs response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Argo Analytics for a zone at different PoPs response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Argo Analytics for a zone at different PoPs", + "tags": ["Argo Analytics for Geolocation"], + "x-cfPermissionsRequired": { "enum": ["#analytics:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/argo/smart_routing": { + "get": { + "operationId": "argo-smart-routing-get-argo-smart-routing-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-response_single" } } }, + "description": "Get Argo Smart Routing setting response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Argo Smart Routing setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Argo Smart Routing setting", + "tags": ["Argo Smart Routing"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Updates enablement of Argo Smart Routing.", + "operationId": "argo-smart-routing-patch-argo-smart-routing-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/patch" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-response_single" } } }, + "description": "Patch Argo Smart Routing setting response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Patch Argo Smart Routing setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Patch Argo Smart Routing setting", + "tags": ["Argo Smart Routing"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read", "#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/argo/tiered_caching": { + "get": { + "operationId": "tiered-caching-get-tiered-caching-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-response_single" } } }, + "description": "Get Tiered Caching setting response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Tiered Caching setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Tiered Caching setting", + "tags": ["Tiered Caching"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Updates enablement of Tiered Caching", + "operationId": "tiered-caching-patch-tiered-caching-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-patch" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-response_single" } } }, + "description": "Patch Tiered Caching setting response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Patch Tiered Caching setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Patch Tiered Caching setting", + "tags": ["Tiered Caching"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read", "#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/available_plans": { + "get": { + "description": "Lists available plans the zone can subscribe to.", + "operationId": "zone-rate-plan-list-available-plans", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/available-rate-plan" }, "type": "array" } + } + } + ] + } + } + }, + "description": "List Available Plans response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-collection" }, + { + "properties": { + "result": { + "items": { "$ref": "#/components/schemas/available-rate-plan" }, + "type": "array" + } + } + } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Available Plans response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Available Plans", + "tags": ["Zone Rate Plan"], + "x-cfPermissionsRequired": { "enum": ["#billing:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/available_plans/{plan_identifier}": { + "get": { + "description": "Details of the available plan that the zone can subscribe to.", + "operationId": "zone-rate-plan-available-plan-details", + "parameters": [ + { + "in": "path", + "name": "plan_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/available-rate-plan" } } } + ] + } + } + }, + "description": "Available Plan Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "properties": { "result": { "$ref": "#/components/schemas/available-rate-plan" } } } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Available Plan Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Available Plan Details", + "tags": ["Zone Rate Plan"], + "x-cfPermissionsRequired": { "enum": ["#billing:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/available_rate_plans": { + "get": { + "description": "Lists all rate plans the zone can subscribe to.", + "operationId": "zone-rate-plan-list-available-rate-plans", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/plan_response_collection" } } + }, + "description": "List Available Rate Plans response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/plan_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Available Rate Plans response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Available Rate Plans", + "tags": ["Zone Rate Plan"], + "x-cfPermissionsRequired": { "enum": ["#billing:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/cache/cache_reserve": { + "get": { + "description": "Increase cache lifetimes by automatically storing all cacheable files into Cloudflare's persistent object storage buckets. Requires Cache Reserve subscription. Note: using Tiered Cache with Cache Reserve is highly recommended to reduce Reserve operations costs. See the [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve) for more information.", + "operationId": "zone-cache-settings-get-cache-reserve-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_cache_settings_response_single" }, + { "$ref": "#/components/schemas/cache_reserve_response_value" } + ] + } + } + }, + "description": "Get Cache Reserve setting response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/zone_cache_settings_response_single" }, + { "$ref": "#/components/schemas/cache_reserve_response_value" } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Cache Reserve setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Cache Reserve setting", + "tags": ["Zone Cache Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Increase cache lifetimes by automatically storing all cacheable files into Cloudflare's persistent object storage buckets. Requires Cache Reserve subscription. Note: using Tiered Cache with Cache Reserve is highly recommended to reduce Reserve operations costs. See the [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve) for more information.", + "operationId": "zone-cache-settings-change-cache-reserve-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/cache_reserve_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_cache_settings_response_single" }, + { "$ref": "#/components/schemas/cache_reserve_response_value" } + ] + } + } + }, + "description": "Change Cache Reserve setting response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/zone_cache_settings_response_single" }, + { "$ref": "#/components/schemas/cache_reserve_response_value" } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Change Cache Reserve setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Cache Reserve setting", + "tags": ["Zone Cache Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/cache/tiered_cache_smart_topology_enable": { + "delete": { + "description": "Remvoves enablement of Smart Tiered Cache", + "operationId": "smart-tiered-cache-delete-smart-tiered-cache-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-response_single" } } }, + "description": "Delete Smart Tiered Cache setting response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Smart Tiered Cache setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Smart Tiered Cache setting", + "tags": ["Smart Tiered Cache"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "get": { + "operationId": "smart-tiered-cache-get-smart-tiered-cache-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-response_single" } } }, + "description": "Get Smart Tiered Cache setting response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Smart Tiered Cache setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Smart Tiered Cache setting", + "tags": ["Smart Tiered Cache"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Updates enablement of Tiered Cache", + "operationId": "smart-tiered-cache-patch-smart-tiered-cache-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/components-schemas-patch" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-response_single" } } }, + "description": "Patch Smart Tiered Cache setting response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Patch Smart Tiered Cache setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Patch Smart Tiered Cache setting", + "tags": ["Smart Tiered Cache"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read", "#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/cache/variants": { + "delete": { + "description": "Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.", + "operationId": "zone-cache-settings-delete-variants-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_cache_settings_response_single" }, + { "properties": { "result": { "$ref": "#/components/schemas/variants" } } } + ] + } + } + }, + "description": "Delete variants setting response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/zone_cache_settings_response_single" }, + { "properties": { "result": { "$ref": "#/components/schemas/variants" } } } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete variants setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete variants setting", + "tags": ["Zone Cache Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + }, + "get": { + "description": "Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.", + "operationId": "zone-cache-settings-get-variants-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_cache_settings_response_single" }, + { "$ref": "#/components/schemas/variants_response_value" } + ] + } + } + }, + "description": "Get variants setting response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/zone_cache_settings_response_single" }, + { "$ref": "#/components/schemas/variants_response_value" } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get variants setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get variants setting", + "tags": ["Zone Cache Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + }, + "patch": { + "description": "Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.", + "operationId": "zone-cache-settings-change-variants-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/variants_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_cache_settings_response_single" }, + { "$ref": "#/components/schemas/variants_response_value" } + ] + } + } + }, + "description": "Change variants setting response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/zone_cache_settings_response_single" }, + { "$ref": "#/components/schemas/variants_response_value" } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Change variants setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change variants setting", + "tags": ["Zone Cache Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + } + }, + "/zones/{zone_identifier}/certificate_authorities/hostname_associations": { + "get": { + "description": "List Hostname Associations", + "operationId": "client-certificate-for-a-zone-list-hostname-associations", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-tZwYoMuc" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/hostname_associations_response" } } + }, + "description": "List Hostname Associations Response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { "allOf": [{ "$ref": "#/components/schemas/api-response-common-failure" }] } + } + }, + "description": "List Hostname Associations Response Failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Hostname Associations", + "tags": ["API Shield Client Certificates for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#ssl:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "put": { + "description": "Replace Hostname Associations", + "operationId": "client-certificate-for-a-zone-put-hostname-associations", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-tZwYoMuc" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/hostname_association" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/hostname_associations_response" } } + }, + "description": "Replace Hostname Associations Response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "Replace Hostname Associations Response Failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Replace Hostname Associations", + "tags": ["API Shield Client Certificates for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#ssl:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/client_certificates": { + "get": { + "description": "List all of your Zone's API Shield mTLS Client Certificates by Status and/or using Pagination", + "operationId": "client-certificate-for-a-zone-list-client-certificates", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-tZwYoMuc" } + }, + { + "in": "query", + "name": "status", + "schema": { + "description": "Client Certitifcate Status to filter results by.", + "enum": ["all", "active", "pending_reactivation", "pending_revocation", "revoked"], + "example": "all" + } + }, + { + "in": "query", + "name": "page", + "schema": { + "default": 1, + "description": "Page number of paginated results.", + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { + "default": 20, + "description": "Number of records per page.", + "maximum": 50, + "minimum": 5, + "type": "number" + } + }, + { + "in": "query", + "name": "limit", + "schema": { "description": "Limit to the number of records returned.", "example": 10, "type": "integer" } + }, + { + "in": "query", + "name": "offset", + "schema": { "description": "Offset the results", "example": 10, "type": "integer" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/client_certificate_response_collection" } + } + }, + "description": "List Client Certificates Response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { "allOf": [{ "$ref": "#/components/schemas/api-response-common-failure" }] } + } + }, + "description": "List Client Certificates Response Failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Client Certificates", + "tags": ["API Shield Client Certificates for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#ssl:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "post": { + "description": "Create a new API Shield mTLS Client Certificate", + "operationId": "client-certificate-for-a-zone-create-client-certificate", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-tZwYoMuc" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "csr": { "$ref": "#/components/schemas/schemas-csr" }, + "validity_days": { "$ref": "#/components/schemas/components-schemas-validity_days" } + }, + "required": ["csr", "validity_days"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/client_certificate_response_single" } } + }, + "description": "Create Client Certificate Response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/client_certificate_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Client Certificate Response Failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Client Certificate", + "tags": ["API Shield Client Certificates for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#ssl:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/client_certificates/{client_certificate_identifier}": { + "delete": { + "description": "Set a API Shield mTLS Client Certificate to pending_revocation status for processing to revoked status.", + "operationId": "client-certificate-for-a-zone-delete-client-certificate", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-tZwYoMuc" } + }, + { + "in": "path", + "name": "client_certificate_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-tZwYoMuc" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/client_certificate_response_single" } } + }, + "description": "Revoke Client Certificate Response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "Revoke Client Certificate Response Failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Revoke Client Certificate", + "tags": ["API Shield Client Certificates for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#ssl:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "get": { + "description": "Get Details for a single mTLS API Shield Client Certificate", + "operationId": "client-certificate-for-a-zone-client-certificate-details", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-tZwYoMuc" } + }, + { + "in": "path", + "name": "client_certificate_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-tZwYoMuc" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/client_certificate_response_single" } } + }, + "description": "Client Certificate Details Response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "Client Certificate Details Response Failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Client Certificate Details", + "tags": ["API Shield Client Certificates for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#ssl:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "If a API Shield mTLS Client Certificate is in a pending_revocation state, you may reactivate it with this endpoint.", + "operationId": "client-certificate-for-a-zone-edit-client-certificate", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-tZwYoMuc" } + }, + { + "in": "path", + "name": "client_certificate_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-tZwYoMuc" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/client_certificate_response_single" } } + }, + "description": "Reactivate Client Certificate Response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure" } } + }, + "description": "Reactivate Client Certificate Response Failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Reactivate Client Certificate", + "tags": ["API Shield Client Certificates for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#ssl:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/custom_certificates": { + "get": { + "description": "List, search, and filter all of your custom SSL certificates. The higher priority will break ties across overlapping 'legacy_custom' certificates, but 'legacy_custom' certificates will always supercede 'sni_custom' certificates.", + "operationId": "custom-ssl-for-a-zone-list-ssl-configurations", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "query", + "name": "page", + "schema": { + "default": 1, + "description": "Page number of paginated results.", + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { + "default": 20, + "description": "Number of zones per page.", + "maximum": 50, + "minimum": 5, + "type": "number" + } + }, + { + "in": "query", + "name": "match", + "schema": { + "default": "all", + "description": "Whether to match all search requirements or at least one (any).", + "enum": ["any", "all"], + "type": "string" + } + }, + { + "in": "query", + "name": "status", + "schema": { + "description": "Status of the zone's custom SSL.", + "enum": ["active", "expired", "deleted", "pending", "initializing"], + "example": "active", + "readOnly": true + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/certificate_response_collection" } } + }, + "description": "List SSL Configurations response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/certificate_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List SSL Configurations response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List SSL Configurations", + "tags": ["Custom SSL for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#ssl:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + }, + "post": { + "description": "Upload a new SSL certificate for a zone.", + "operationId": "custom-ssl-for-a-zone-create-ssl-configuration", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "bundle_method": { "$ref": "#/components/schemas/bundle_method" }, + "certificate": { "$ref": "#/components/schemas/certificate" }, + "geo_restrictions": { "$ref": "#/components/schemas/geo_restrictions" }, + "policy": { "$ref": "#/components/schemas/policy" }, + "private_key": { "$ref": "#/components/schemas/private_key" }, + "type": { "$ref": "#/components/schemas/components-schemas-type" } + }, + "required": ["certificate", "private_key"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/certificate_response_single" } } + }, + "description": "Create SSL Configuration response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/certificate_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create SSL Configuration response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create SSL Configuration", + "tags": ["Custom SSL for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#ssl:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/custom_certificates/prioritize": { + "put": { + "description": "If a zone has multiple SSL certificates, you can set the order in which they should be used during a request. The higher priority will break ties across overlapping 'legacy_custom' certificates.", + "operationId": "custom-ssl-for-a-zone-re-prioritize-ssl-certificates", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "certificates": { + "description": "Array of ordered certificates.", + "example": [ + { "id": "5a7805061c76ada191ed06f989cc3dac", "priority": 2 }, + { "id": "9a7806061c88ada191ed06f989cc3dac", "priority": 1 } + ], + "items": { + "properties": { + "id": { "$ref": "#/components/schemas/custom-certificate_components-schemas-identifier" }, + "priority": { "$ref": "#/components/schemas/priority-eLZLlpCp" } + }, + "type": "object" + }, + "type": "array" + } + }, + "required": ["certificates"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/certificate_response_collection" } } + }, + "description": "Re-prioritize SSL Certificates response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/certificate_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Re-prioritize SSL Certificates response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Re-prioritize SSL Certificates", + "tags": ["Custom SSL for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#ssl:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/custom_certificates/{identifier}": { + "delete": { + "description": "Remove a SSL certificate from a zone.", + "operationId": "custom-ssl-for-a-zone-delete-ssl-configuration", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/custom-certificate_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/certificate_response_id_only-e7wXd3xw" } } + }, + "description": "Delete SSL Configuration response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/certificate_response_id_only-e7wXd3xw" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete SSL Configuration response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete SSL Configuration", + "tags": ["Custom SSL for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#ssl:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + }, + "get": { + "operationId": "custom-ssl-for-a-zone-ssl-configuration-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/custom-certificate_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/certificate_response_single" } } + }, + "description": "SSL Configuration Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/certificate_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "SSL Configuration Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "SSL Configuration Details", + "tags": ["Custom SSL for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#ssl:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + }, + "patch": { + "description": "Upload a new private key and/or PEM/CRT for the SSL certificate. Note: PATCHing a configuration for sni_custom certificates will result in a new resource id being returned, and the previous one being deleted.", + "operationId": "custom-ssl-for-a-zone-edit-ssl-configuration", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/custom-certificate_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "bundle_method": { "$ref": "#/components/schemas/bundle_method" }, + "certificate": { "$ref": "#/components/schemas/certificate" }, + "geo_restrictions": { "$ref": "#/components/schemas/geo_restrictions" }, + "policy": { "$ref": "#/components/schemas/policy" }, + "private_key": { "$ref": "#/components/schemas/private_key" } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/certificate_response_single" } } + }, + "description": "Edit SSL Configuration response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/certificate_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Edit SSL Configuration response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Edit SSL Configuration", + "tags": ["Custom SSL for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#ssl:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/custom_hostnames": { + "get": { + "description": "List, search, sort, and filter all of your custom hostnames.", + "operationId": "custom-hostname-for-a-zone-list-custom-hostnames", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "query", + "name": "hostname", + "schema": { + "description": "Fully qualified domain name to match against. This parameter cannot be used with the 'id' parameter.", + "example": "app.example.com", + "maxLength": 255, + "type": "string" + } + }, + { + "in": "query", + "name": "id", + "schema": { + "description": "Hostname ID to match against. This ID was generated and returned during the initial custom_hostname creation. This parameter cannot be used with the 'hostname' parameter.", + "example": "0d89c70d-ad9f-4843-b99f-6cc0252067e9", + "maxLength": 36, + "minLength": 36, + "type": "string" + } + }, + { + "in": "query", + "name": "page", + "schema": { + "default": 1, + "description": "Page number of paginated results.", + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { + "default": 20, + "description": "Number of hostnames per page.", + "maximum": 50, + "minimum": 5, + "type": "number" + } + }, + { + "in": "query", + "name": "order", + "schema": { + "default": "ssl", + "description": "Field to order hostnames by.", + "enum": ["ssl", "ssl_status"], + "example": "ssl" + } + }, + { + "in": "query", + "name": "direction", + "schema": { "description": "Direction to order hostnames.", "enum": ["asc", "desc"], "example": "desc" } + }, + { + "in": "query", + "name": "ssl", + "schema": { + "default": "0", + "description": "Whether to filter hostnames based on if they have SSL enabled.", + "enum": [0, 1] + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/custom_hostname_response_collection" } } + }, + "description": "List Custom Hostnames response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/custom_hostname_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Custom Hostnames response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Custom Hostnames", + "tags": ["Custom Hostname for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#ssl:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "post": { + "description": "Add a new custom hostname and request that an SSL certificate be issued for it. One of three validation methods—http, txt, email—should be used, with 'http' recommended if the CNAME is already in place (or will be soon). Specifying 'email' will send an email to the WHOIS contacts on file for the base domain plus hostmaster, postmaster, webmaster, admin, administrator. If http is used and the domain is not already pointing to the Managed CNAME host, the PATCH method must be used once it is (to complete validation).", + "operationId": "custom-hostname-for-a-zone-create-custom-hostname", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "custom_metadata": { "$ref": "#/components/schemas/custom_metadata" }, + "hostname": { "$ref": "#/components/schemas/hostname" }, + "ssl": { "$ref": "#/components/schemas/sslpost-TcVapXSa" } + }, + "required": ["hostname", "ssl"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/custom_hostname_response_single-sVpYaC2x" } + } + }, + "description": "Create Custom Hostname response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/custom_hostname_response_single-sVpYaC2x" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Custom Hostname response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Custom Hostname", + "tags": ["Custom Hostname for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#ssl:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/custom_hostnames/fallback_origin": { + "delete": { + "operationId": "custom-hostname-fallback-origin-for-a-zone-delete-fallback-origin-for-custom-hostnames", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/fallback_origin_response" } } + }, + "description": "Delete Fallback Origin for Custom Hostnames response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/fallback_origin_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Fallback Origin for Custom Hostnames response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Fallback Origin for Custom Hostnames", + "tags": ["Custom Hostname Fallback Origin for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#ssl:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "get": { + "operationId": "custom-hostname-fallback-origin-for-a-zone-get-fallback-origin-for-custom-hostnames", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/fallback_origin_response" } } + }, + "description": "Get Fallback Origin for Custom Hostnames response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/fallback_origin_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Fallback Origin for Custom Hostnames response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Fallback Origin for Custom Hostnames", + "tags": ["Custom Hostname Fallback Origin for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#ssl:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "put": { + "operationId": "custom-hostname-fallback-origin-for-a-zone-update-fallback-origin-for-custom-hostnames", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "origin": { "$ref": "#/components/schemas/origin" } }, + "required": ["origin"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/fallback_origin_response" } } + }, + "description": "Update Fallback Origin for Custom Hostnames response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/fallback_origin_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Fallback Origin for Custom Hostnames response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Fallback Origin for Custom Hostnames", + "tags": ["Custom Hostname Fallback Origin for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#ssl:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/custom_hostnames/{identifier}": { + "delete": { + "operationId": "custom-hostname-for-a-zone-delete-custom-hostname-(-and-any-issued-ssl-certificates)", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/custom-hostname_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "id": { "$ref": "#/components/schemas/custom-hostname_components-schemas-identifier" } + }, + "type": "object" + } + } + }, + "description": "Delete Custom Hostname (and any issued SSL certificates) response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "properties": { + "id": { "$ref": "#/components/schemas/custom-hostname_components-schemas-identifier" } + }, + "type": "object" + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Custom Hostname (and any issued SSL certificates) response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Custom Hostname (and any issued SSL certificates)", + "tags": ["Custom Hostname for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#ssl:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "get": { + "operationId": "custom-hostname-for-a-zone-custom-hostname-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/custom-hostname_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/custom_hostname_response_single-sVpYaC2x" } + } + }, + "description": "Custom Hostname Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/custom_hostname_response_single-sVpYaC2x" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Custom Hostname Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Custom Hostname Details", + "tags": ["Custom Hostname for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#ssl:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Modify SSL configuration for a custom hostname. When sent with SSL config that matches existing config, used to indicate that hostname should pass domain control validation (DCV). Can also be used to change validation type, e.g., from 'http' to 'email'.", + "operationId": "custom-hostname-for-a-zone-edit-custom-hostname", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/custom-hostname_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "custom_metadata": { "$ref": "#/components/schemas/custom_metadata" }, + "custom_origin_server": { "$ref": "#/components/schemas/custom_origin_server" }, + "custom_origin_sni": { "$ref": "#/components/schemas/custom_origin_sni" }, + "ssl": { "$ref": "#/components/schemas/sslpost-TcVapXSa" } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/custom_hostname_response_single-sVpYaC2x" } + } + }, + "description": "Edit Custom Hostname response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/custom_hostname_response_single-sVpYaC2x" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Edit Custom Hostname response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Edit Custom Hostname", + "tags": ["Custom Hostname for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#ssl:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/custom_ns": { + "get": { + "description": "Get metadata for account-level custom nameservers on a zone.\n", + "operationId": "account-level-custom-nameservers-usage-for-a-zone-get-account-custom-nameserver-related-zone-metadata", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_response" } } }, + "description": "Get Account Custom Nameserver Related Zone Metadata response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/get_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Account Custom Nameserver Related Zone Metadata response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Account Custom Nameserver Related Zone Metadata", + "tags": ["Account-Level Custom Nameservers Usage for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#zone:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + }, + "put": { + "description": "Set metadata for account-level custom nameservers on a zone.\n\nIf you would like new zones in the account to use account custom nameservers by default, use PUT /accounts/:identifier to set the account setting use_account_custom_ns_by_default to true.\n", + "operationId": "account-level-custom-nameservers-usage-for-a-zone-set-account-custom-nameserver-related-zone-metadata", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/zone_metadata" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/empty_response-V46LqGZw" } } }, + "description": "Set Account Custom Nameserver Related Zone Metadata response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/empty_response-V46LqGZw" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Set Account Custom Nameserver Related Zone Metadata response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Set Account Custom Nameserver Related Zone Metadata", + "tags": ["Account-Level Custom Nameservers Usage for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#zone:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/custom_pages": { + "get": { + "description": "Fetches all the custom pages at the zone level.", + "operationId": "custom-pages-for-a-zone-list-custom-pages", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/custom_pages_response_collection" } } + }, + "description": "List custom pages response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/custom_pages_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List custom pages response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List custom pages", + "tags": ["Custom pages for a zone"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + } + }, + "/zones/{zone_identifier}/custom_pages/{identifier}": { + "get": { + "description": "Fetches the details of a custom page.", + "operationId": "custom-pages-for-a-zone-get-a-custom-page", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/custom-pages_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/custom_pages_response_single" } } + }, + "description": "Get a custom page response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/custom_pages_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get a custom page response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a custom page", + "tags": ["Custom pages for a zone"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + }, + "put": { + "description": "Updates the configuration of an existing custom page.", + "operationId": "custom-pages-for-a-zone-update-a-custom-page", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/custom-pages_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "state": { "$ref": "#/components/schemas/schemas-state" }, + "url": { "$ref": "#/components/schemas/url" } + }, + "required": ["url", "state"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/custom_pages_response_single" } } + }, + "description": "Update a custom page response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/custom_pages_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update a custom page response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update a custom page", + "tags": ["Custom pages for a zone"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + } + }, + "/zones/{zone_identifier}/dns_records": { + "get": { + "description": "List, search, sort, and filter a zones' DNS records.", + "operationId": "dns-records-for-a-zone-list-dns-records", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-zpETYDGh" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_response_collection" } } }, + "description": "List DNS Records response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/dns_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List DNS Records response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List DNS Records", + "tags": ["DNS Records for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#dns_records:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "post": { + "description": "Create a new DNS record for a zone. See the record object definitions for required attributes for each record type.", + "operationId": "dns-records-for-a-zone-create-dns-record", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-zpETYDGh" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns-record" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_response_single" } } }, + "description": "Create DNS Record response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/dns_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create DNS Record response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create DNS Record", + "tags": ["DNS Records for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#dns_records:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/dns_records/export": { + "get": { + "description": "You can export your [BIND config](https://en.wikipedia.org/wiki/Zone_file \"Zone file\") through this endpoint.\n\nSee [the documentation](https://developers.cloudflare.com/dns/manage-dns-records/how-to/import-and-export/ \"Import and export records\") for more information.", + "operationId": "dns-records-for-a-zone-export-dns-records", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-zpETYDGh" } + } + ], + "responses": { + "200": { "content": { "application/json": { "schema": {} } }, "description": "Export DNS Records response" }, + "4xx": { + "content": { + "application/json": { + "schema": { "allOf": [{}, { "$ref": "#/components/schemas/api-response-common-failure" }] } + } + }, + "description": "Export DNS Records response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Export DNS Records", + "tags": ["DNS Records for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#dns_records:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/dns_records/import": { + "post": { + "description": "You can upload your [BIND config](https://en.wikipedia.org/wiki/Zone_file \"Zone file\") through this endpoint. It assumes that cURL is called from a location with bind_config.txt (valid BIND config) present.\n\nSee [the documentation](https://developers.cloudflare.com/dns/manage-dns-records/how-to/import-and-export/ \"Import and export records\") for more information.", + "operationId": "dns-records-for-a-zone-import-dns-records", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-zpETYDGh" } + } + ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "properties": { + "file": { "description": "BIND config to upload.", "example": "@bind_config.txt", "type": "string" }, + "proxied": { + "description": "Whether or not proxiable records should receive the performance and security benefits of Cloudflare.", + "example": false, + "type": "boolean" + } + }, + "required": ["file"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/dns_response_import_scan" } } + }, + "description": "Import DNS Records response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/dns_response_import_scan" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Import DNS Records response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Import DNS Records", + "tags": ["DNS Records for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#dns_records:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/dns_records/scan": { + "post": { + "description": "Scan for common DNS records on your domain and automatically add them to your zone. Useful if you haven't updated your nameservers yet.", + "operationId": "dns-records-for-a-zone-scan-dns-records", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-zpETYDGh" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/dns_response_import_scan" } } + }, + "description": "Scan DNS Records response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/dns_response_import_scan" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Scan DNS Records response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Scan DNS Records", + "tags": ["DNS Records for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#dns_records:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/dns_records/{identifier}": { + "delete": { + "operationId": "dns-records-for-a-zone-delete-dns-record", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-zpETYDGh" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-zpETYDGh" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { "properties": { "id": { "$ref": "#/components/schemas/identifier-zpETYDGh" } } } + }, + "type": "object" + } + } + }, + "description": "Delete DNS Record response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "properties": { + "result": { "properties": { "id": { "$ref": "#/components/schemas/identifier-zpETYDGh" } } } + }, + "type": "object" + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete DNS Record response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete DNS Record", + "tags": ["DNS Records for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#dns_records:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "get": { + "operationId": "dns-records-for-a-zone-dns-record-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-zpETYDGh" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-zpETYDGh" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_response_single" } } }, + "description": "DNS Record Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/dns_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "DNS Record Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "DNS Record Details", + "tags": ["DNS Records for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#dns_records:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "operationId": "dns-records-for-a-zone-patch-dns-record", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-zpETYDGh" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-zpETYDGh" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns-record" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_response_single" } } }, + "description": "Patch DNS Record response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/dns_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Patch DNS Record response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Patch DNS Record", + "tags": ["DNS Records for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#dns_records:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "put": { + "operationId": "dns-records-for-a-zone-update-dns-record", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-zpETYDGh" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-zpETYDGh" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns-record" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dns_response_single" } } }, + "description": "Update DNS Record response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/dns_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update DNS Record response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update DNS Record", + "tags": ["DNS Records for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#dns_records:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/dnssec": { + "delete": { + "description": "Delete DNSSEC.", + "operationId": "dnssec-delete-dnssec-records", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-smPsQb9r" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/delete_dnssec_response_single" } } + }, + "description": "Delete DNSSEC records response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/delete_dnssec_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete DNSSEC records response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete DNSSEC records", + "tags": ["DNSSEC"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "get": { + "description": "Details about DNSSEC status and configuration.", + "operationId": "dnssec-dnssec-details", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-smPsQb9r" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dnssec_response_single" } } }, + "description": "DNSSEC Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/dnssec_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "DNSSEC Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "DNSSEC Details", + "tags": ["DNSSEC"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Enable or disable DNSSEC.", + "operationId": "dnssec-edit-dnssec-status", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-smPsQb9r" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "status": { + "description": "Status of DNSSEC, based on user-desired state and presence of necessary records.", + "enum": ["active", "disabled"], + "example": "active" + } + }, + "required": ["status"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dnssec_response_single" } } }, + "description": "Edit DNSSEC Status response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/dnssec_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Edit DNSSEC Status response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Edit DNSSEC Status", + "tags": ["DNSSEC"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/email/routing": { + "get": { + "description": "Get information about the settings for your Email Routing zone.", + "operationId": "email-routing-settings-get-email-routing-settings", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-YhmC5GTP" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/email-settings_response_single" } } + }, + "description": "Get Email Routing settings response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Email Routing settings", + "tags": ["Email Routing settings"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.email.routing.config.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/email/routing/disable": { + "post": { + "description": "Disable your Email Routing zone. Also removes additional MX records previously required for Email Routing to work.", + "operationId": "email-routing-settings-disable-email-routing", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-YhmC5GTP" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/email-settings_response_single" } } + }, + "description": "Disable Email Routing response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Disable Email Routing", + "tags": ["Email Routing settings"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.email.routing.config.update"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/email/routing/dns": { + "get": { + "description": "Show the DNS records needed to configure your Email Routing zone.", + "operationId": "email-routing-settings-email-routing-dns-settings", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-YhmC5GTP" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/dns-settings_response_collection" } } + }, + "description": "Email Routing - DNS settings response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Email Routing - DNS settings", + "tags": ["Email Routing settings"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.email.routing.config.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/email/routing/enable": { + "post": { + "description": "Enable you Email Routing zone. Add and lock the necessary MX and SPF records.", + "operationId": "email-routing-settings-enable-email-routing", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-YhmC5GTP" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/email-settings_response_single" } } + }, + "description": "Enable Email Routing response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Enable Email Routing", + "tags": ["Email Routing settings"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.email.routing.config.update"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/email/routing/rules": { + "get": { + "description": "Lists existing routing rules.", + "operationId": "email-routing-routing-rules-list-routing-rules", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-YhmC5GTP" } + }, + { + "in": "query", + "name": "page", + "schema": { + "default": 1, + "description": "Page number of paginated results.", + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { + "default": 20, + "description": "Maximum number of results per page.", + "maximum": 50, + "minimum": 5, + "type": "number" + } + }, + { + "in": "query", + "name": "enabled", + "schema": { + "description": "Filter by enabled routing rules.", + "enum": [true, false], + "example": true, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/rules_response_collection-Fgtzw0xK" } } + }, + "description": "List routing rules response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List routing rules", + "tags": ["Email Routing routing rules"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.email.routing.rule.list"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "post": { + "description": "Rules consist of a set of criteria for matching emails (such as an email being sent to a specific custom email address) plus a set of actions to take on the email (like forwarding it to a specific destination address).", + "operationId": "email-routing-routing-rules-create-routing-rule", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-YhmC5GTP" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_rule_properties" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/rule_response_single-rvlRijjw" } } + }, + "description": "Create routing rule response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create routing rule", + "tags": ["Email Routing routing rules"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.email.routing.rule.create"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/email/routing/rules/catch_all": { + "get": { + "description": "Get information on the default catch-all routing rule.", + "operationId": "email-routing-routing-rules-get-catch-all-rule", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-YhmC5GTP" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/catch_all_rule_response_single" } } + }, + "description": "Get catch-all rule response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get catch-all rule", + "tags": ["Email Routing routing rules"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.email.routing.rule.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "put": { + "description": "Enable or disable catch-all routing rule, or change action to forward to specific destination address.", + "operationId": "email-routing-routing-rules-update-catch-all-rule", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-YhmC5GTP" } + } + ], + "requestBody": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/update_catch_all_rule_properties" } } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/catch_all_rule_response_single" } } + }, + "description": "Update catch-all rule response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update catch-all rule", + "tags": ["Email Routing routing rules"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.email.routing.rule.update"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/email/routing/rules/{rule_identifier}": { + "delete": { + "description": "Delete a specific routing rule.", + "operationId": "email-routing-routing-rules-delete-routing-rule", + "parameters": [ + { + "in": "path", + "name": "rule_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/rule_identifier-wpFBeqHF" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-YhmC5GTP" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/rule_response_single-rvlRijjw" } } + }, + "description": "Delete routing rule response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete routing rule", + "tags": ["Email Routing routing rules"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.email.routing.rule.delete"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "get": { + "description": "Get information for a specific routing rule already created.", + "operationId": "email-routing-routing-rules-get-routing-rule", + "parameters": [ + { + "in": "path", + "name": "rule_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/rule_identifier-wpFBeqHF" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-YhmC5GTP" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/rule_response_single-rvlRijjw" } } + }, + "description": "Get routing rule response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get routing rule", + "tags": ["Email Routing routing rules"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.email.routing.rule.read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "put": { + "description": "Update actions and matches, or enable/disable specific routing rules.", + "operationId": "email-routing-routing-rules-update-routing-rule", + "parameters": [ + { + "in": "path", + "name": "rule_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/rule_identifier-wpFBeqHF" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-YhmC5GTP" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_rule_properties" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/rule_response_single-rvlRijjw" } } + }, + "description": "Update routing rule response" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update routing rule", + "tags": ["Email Routing routing rules"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.email.routing.rule.update"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/filters": { + "delete": { + "description": "Deletes one or more existing filters.", + "operationId": "filters-delete-filters", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "id": { "$ref": "#/components/schemas/filters_components-schemas-id" } }, + "required": ["id"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/filter-delete-response-collection" } } + }, + "description": "Delete filters response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/filter-delete-response-collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete filters response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete filters", + "tags": ["Filters"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "get": { + "description": "Fetches filters in a zone. You can filter the results using several optional parameters.", + "operationId": "filters-list-filters", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "query", + "name": "paused", + "schema": { "$ref": "#/components/schemas/filters_components-schemas-paused" } + }, + { + "in": "query", + "name": "expression", + "schema": { + "description": "A case-insensitive string to find in the expression.", + "example": "php", + "type": "string" + } + }, + { + "in": "query", + "name": "description", + "schema": { + "description": "A case-insensitive string to find in the description.", + "example": "browsers", + "type": "string" + } + }, + { + "in": "query", + "name": "ref", + "schema": { + "description": "The filter ref (a short reference tag) to search for. Must be an exact match.", + "example": "FIL-100", + "type": "string" + } + }, + { + "in": "query", + "name": "page", + "schema": { + "default": 1, + "description": "Page number of paginated results.", + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { + "default": 25, + "description": "Number of filters per page.", + "maximum": 100, + "minimum": 5, + "type": "number" + } + }, + { + "in": "query", + "name": "id", + "schema": { + "description": "The unique identifier of the filter.", + "example": "372e67954025e0ba6aaa6d586b9e0b61", + "maxLength": 32, + "minLength": 32, + "readOnly": true, + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-filter-response-collection" } } + }, + "description": "List filters response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-filter-response-collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List filters response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List filters", + "tags": ["Filters"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "post": { + "description": "Creates one or more filters.", + "operationId": "filters-create-filters", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "required": ["expression"] } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-filter-response-collection" } } + }, + "description": "Create filters response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-filter-response-collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create filters response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create filters", + "tags": ["Filters"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "put": { + "description": "Updates one or more existing filters.", + "operationId": "filters-update-filters", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": { "schema": { "required": ["id"] } } }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-filter-response-collection" } } + }, + "description": "Update filters response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-filter-response-collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update filters response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update filters", + "tags": ["Filters"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/filters/{id}": { + "delete": { + "description": "Deletes an existing filter.", + "operationId": "filters-delete-a-filter", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { "$ref": "#/components/schemas/filters_components-schemas-id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/filter-delete-response-single" } } + }, + "description": "Delete a filter response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/filter-delete-response-single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete a filter response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete a filter", + "tags": ["Filters"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "get": { + "description": "Fetches the details of a filter.", + "operationId": "filters-get-a-filter", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { "$ref": "#/components/schemas/filters_components-schemas-id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-filter-response-single" } } + }, + "description": "Get a filter response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-filter-response-single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get a filter response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a filter", + "tags": ["Filters"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "put": { + "description": "Updates an existing filter.", + "operationId": "filters-update-a-filter", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { "$ref": "#/components/schemas/filters_components-schemas-id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": { "schema": { "required": ["id"] } } }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-filter-response-single" } } + }, + "description": "Update a filter response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-filter-response-single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update a filter response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update a filter", + "tags": ["Filters"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/firewall/lockdowns": { + "get": { + "description": "Fetches Zone Lockdown rules. You can filter the results using several optional parameters.", + "operationId": "zone-lockdown-list-zone-lockdown-rules", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "query", + "name": "page", + "schema": { + "default": 1, + "description": "Page number of paginated results.", + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "description", + "schema": { "$ref": "#/components/schemas/schemas-description_search" } + }, + { + "in": "query", + "name": "modified_on", + "schema": { "$ref": "#/components/schemas/components-schemas-modified_on" } + }, + { "in": "query", "name": "ip", "schema": { "$ref": "#/components/schemas/ip_search" } }, + { + "in": "query", + "name": "priority", + "schema": { "$ref": "#/components/schemas/lockdowns_components-schemas-priority" } + }, + { "in": "query", "name": "uri_search", "schema": { "$ref": "#/components/schemas/uri_search" } }, + { "in": "query", "name": "ip_range_search", "schema": { "$ref": "#/components/schemas/ip_range_search" } }, + { + "in": "query", + "name": "per_page", + "schema": { + "default": 20, + "description": "The maximum number of results per page. You can only set the value to `1` or to a multiple of 5 such as `5`, `10`, `15`, or `20`.", + "maximum": 1000, + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "created_on", + "schema": { + "description": "The timestamp of when the rule was created.", + "example": "2014-01-01T05:20:00.12345Z", + "format": "date-time", + "readOnly": true, + "type": "string" + } + }, + { + "in": "query", + "name": "description_search", + "schema": { + "description": "A string to search for in the description of existing rules.", + "example": "endpoints", + "type": "string" + } + }, + { + "in": "query", + "name": "ip_search", + "schema": { + "description": "A single IP address to search for in existing rules.", + "example": "1.2.3.4", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/zonelockdown_response_collection" } } + }, + "description": "List Zone Lockdown rules response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zonelockdown_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Zone Lockdown rules response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Zone Lockdown rules", + "tags": ["Zone Lockdown"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + }, + "post": { + "description": "Creates a new Zone Lockdown rule.", + "operationId": "zone-lockdown-create-a-zone-lockdown-rule", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "required": ["urls", "configurations"] } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/zonelockdown_response_single" } } + }, + "description": "Create a Zone Lockdown rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zonelockdown_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create a Zone Lockdown rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create a Zone Lockdown rule", + "tags": ["Zone Lockdown"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + } + }, + "/zones/{zone_identifier}/firewall/lockdowns/{id}": { + "delete": { + "description": "Deletes an existing Zone Lockdown rule.", + "operationId": "zone-lockdown-delete-a-zone-lockdown-rule", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { "$ref": "#/components/schemas/lockdowns_components-schemas-id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { "id": { "$ref": "#/components/schemas/lockdowns_components-schemas-id" } } + } + }, + "type": "object" + } + } + }, + "description": "Delete a Zone Lockdown rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "properties": { + "result": { + "properties": { "id": { "$ref": "#/components/schemas/lockdowns_components-schemas-id" } } + } + }, + "type": "object" + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete a Zone Lockdown rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete a Zone Lockdown rule", + "tags": ["Zone Lockdown"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + }, + "get": { + "description": "Fetches the details of a Zone Lockdown rule.", + "operationId": "zone-lockdown-get-a-zone-lockdown-rule", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { "$ref": "#/components/schemas/lockdowns_components-schemas-id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/zonelockdown_response_single" } } + }, + "description": "Get a Zone Lockdown rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zonelockdown_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get a Zone Lockdown rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a Zone Lockdown rule", + "tags": ["Zone Lockdown"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + }, + "put": { + "description": "Updates an existing Zone Lockdown rule.", + "operationId": "zone-lockdown-update-a-zone-lockdown-rule", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { "$ref": "#/components/schemas/lockdowns_components-schemas-id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "required": ["urls", "configurations"] } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/zonelockdown_response_single" } } + }, + "description": "Update a Zone Lockdown rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zonelockdown_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update a Zone Lockdown rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update a Zone Lockdown rule", + "tags": ["Zone Lockdown"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + } + }, + "/zones/{zone_identifier}/firewall/rules": { + "delete": { + "description": "Deletes existing firewall rules.", + "operationId": "firewall-rules-delete-firewall-rules", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "id": { "$ref": "#/components/schemas/firewall-rules_components-schemas-id" } }, + "required": ["id"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/filter-rules-response-collection-delete" } + } + }, + "description": "Delete firewall rules response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/filter-rules-response-collection-delete" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete firewall rules response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete firewall rules", + "tags": ["Firewall rules"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "get": { + "description": "Fetches firewall rules in a zone. You can filter the results using several optional parameters.", + "operationId": "firewall-rules-list-firewall-rules", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "query", + "name": "description", + "schema": { + "description": "A case-insensitive string to find in the description.", + "example": "mir", + "type": "string" + } + }, + { + "in": "query", + "name": "action", + "schema": { + "description": "The action to search for. Must be an exact match.", + "example": "block", + "type": "string" + } + }, + { + "in": "query", + "name": "page", + "schema": { + "default": 1, + "description": "Page number of paginated results.", + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { + "default": 25, + "description": "Number of firewall rules per page.", + "maximum": 100, + "minimum": 5, + "type": "number" + } + }, + { + "in": "query", + "name": "id", + "schema": { + "description": "The unique identifier of the firewall rule.", + "example": "372e67954025e0ba6aaa6d586b9e0b60", + "maxLength": 32, + "readOnly": true, + "type": "string" + } + }, + { + "in": "query", + "name": "paused", + "schema": { + "description": "When true, indicates that the firewall rule is currently paused.", + "example": false, + "type": "boolean" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/filter-rules-response-collection" } } + }, + "description": "List firewall rules response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/filter-rules-response-collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List firewall rules response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List firewall rules", + "tags": ["Firewall rules"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Updates the priority of existing firewall rules.", + "operationId": "firewall-rules-update-priority-of-firewall-rules", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": { "schema": { "required": ["id"] } } }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/filter-rules-response-collection" } } + }, + "description": "Update priority of firewall rules response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/filter-rules-response-collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update priority of firewall rules response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update priority of firewall rules", + "tags": ["Firewall rules"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "post": { + "description": "Create one or more firewall rules.", + "operationId": "firewall-rules-create-firewall-rules", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "required": ["filter", "action"] } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/filter-rules-response-collection" } } + }, + "description": "Create firewall rules response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/filter-rules-response-collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create firewall rules response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create firewall rules", + "tags": ["Firewall rules"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "put": { + "description": "Updates one or more existing firewall rules.", + "operationId": "firewall-rules-update-firewall-rules", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": { "schema": { "required": ["id"] } } }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/filter-rules-response-collection" } } + }, + "description": "Update firewall rules response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/filter-rules-response-collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update firewall rules response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update firewall rules", + "tags": ["Firewall rules"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/firewall/rules/{id}": { + "delete": { + "description": "Deletes an existing firewall rule.", + "operationId": "firewall-rules-delete-a-firewall-rule", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { "$ref": "#/components/schemas/firewall-rules_components-schemas-id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "delete_filter_if_unused": { "$ref": "#/components/schemas/delete_filter_if_unused" } }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/filter-rules-single-response-delete" } } + }, + "description": "Delete a firewall rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/filter-rules-single-response-delete" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete a firewall rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete a firewall rule", + "tags": ["Firewall rules"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "get": { + "description": "Fetches the details of a firewall rule.", + "operationId": "firewall-rules-get-a-firewall-rule", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { "$ref": "#/components/schemas/firewall-rules_components-schemas-id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "query", + "name": "id", + "schema": { "$ref": "#/components/schemas/firewall-rules_components-schemas-id" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/filter-rules-single-response" } } + }, + "description": "Get a firewall rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/filter-rules-single-response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get a firewall rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a firewall rule", + "tags": ["Firewall rules"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Updates the priority of an existing firewall rule.", + "operationId": "firewall-rules-update-priority-of-a-firewall-rule", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { "$ref": "#/components/schemas/firewall-rules_components-schemas-id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": { "schema": { "required": ["id"] } } }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/filter-rules-response-collection" } } + }, + "description": "Update priority of a firewall rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/filter-rules-response-collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update priority of a firewall rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update priority of a firewall rule", + "tags": ["Firewall rules"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "put": { + "description": "Updates an existing firewall rule.", + "operationId": "firewall-rules-update-a-firewall-rule", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { "$ref": "#/components/schemas/firewall-rules_components-schemas-id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "required": ["id", "filter", "action"] } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/filter-rules-single-response" } } + }, + "description": "Update a firewall rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/filter-rules-single-response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update a firewall rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update a firewall rule", + "tags": ["Firewall rules"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/firewall/ua_rules": { + "get": { + "description": "Fetches User Agent Blocking rules in a zone. You can filter the results using several optional parameters.", + "operationId": "user-agent-blocking-rules-list-user-agent-blocking-rules", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "query", + "name": "page", + "schema": { + "default": 1, + "description": "Page number of paginated results.", + "minimum": 1, + "type": "number" + } + }, + { "in": "query", "name": "description", "schema": { "$ref": "#/components/schemas/description_search" } }, + { + "in": "query", + "name": "description_search", + "schema": { "$ref": "#/components/schemas/description_search" } + }, + { + "in": "query", + "name": "per_page", + "schema": { + "default": 20, + "description": "The maximum number of results per page. You can only set the value to `1` or to a multiple of 5 such as `5`, `10`, `15`, or `20`.", + "maximum": 1000, + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "ua_search", + "schema": { + "description": "A string to search for in the user agent values of existing rules.", + "example": "Safari", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/firewalluablock_response_collection" } } + }, + "description": "List User Agent Blocking rules response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/firewalluablock_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List User Agent Blocking rules response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List User Agent Blocking rules", + "tags": ["User Agent Blocking rules"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "post": { + "description": "Creates a new User Agent Blocking rule in a zone.", + "operationId": "user-agent-blocking-rules-create-a-user-agent-blocking-rule", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "required": ["mode", "configuration"] } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/firewalluablock_response_single" } } + }, + "description": "Create a User Agent Blocking rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/firewalluablock_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create a User Agent Blocking rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create a User Agent Blocking rule", + "tags": ["User Agent Blocking rules"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/firewall/ua_rules/{id}": { + "delete": { + "description": "Deletes an existing User Agent Blocking rule.", + "operationId": "user-agent-blocking-rules-delete-a-user-agent-blocking-rule", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { "$ref": "#/components/schemas/ua-rules_components-schemas-id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/firewalluablock_response_single" }, + { + "properties": { + "result": { + "properties": { "id": { "$ref": "#/components/schemas/ua-rules_components-schemas-id" } } + } + }, + "type": "object" + } + ] + } + } + }, + "description": "Delete a User Agent Blocking rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/firewalluablock_response_single" }, + { + "properties": { + "result": { + "properties": { "id": { "$ref": "#/components/schemas/ua-rules_components-schemas-id" } } + } + }, + "type": "object" + } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete a User Agent Blocking rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete a User Agent Blocking rule", + "tags": ["User Agent Blocking rules"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "get": { + "description": "Fetches the details of a User Agent Blocking rule.", + "operationId": "user-agent-blocking-rules-get-a-user-agent-blocking-rule", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { "$ref": "#/components/schemas/ua-rules_components-schemas-id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/firewalluablock_response_single" } } + }, + "description": "Get a User Agent Blocking rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/firewalluablock_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get a User Agent Blocking rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a User Agent Blocking rule", + "tags": ["User Agent Blocking rules"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "put": { + "description": "Updates an existing User Agent Blocking rule.", + "operationId": "user-agent-blocking-rules-update-a-user-agent-blocking-rule", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { "$ref": "#/components/schemas/ua-rules_components-schemas-id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "required": ["id", "mode", "configuration"] } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/firewalluablock_response_single" } } + }, + "description": "Update a User Agent Blocking rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/firewalluablock_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update a User Agent Blocking rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update a User Agent Blocking rule", + "tags": ["User Agent Blocking rules"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/firewall/waf/overrides": { + "get": { + "description": "Fetches the URI-based WAF overrides in a zone.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).", + "operationId": "waf-overrides-list-waf-overrides", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "query", + "name": "page", + "schema": { + "default": 1, + "description": "The page number of paginated results.", + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { + "default": 50, + "description": "The number of WAF overrides per page.", + "maximum": 100, + "minimum": 5, + "type": "number" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/override_response_collection" } } + }, + "description": "List WAF overrides response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/override_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List WAF overrides response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List WAF overrides", + "tags": ["WAF overrides"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "post": { + "description": "Creates a URI-based WAF override for a zone.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).", + "operationId": "waf-overrides-create-a-waf-override", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": { "schema": { "required": ["urls"] } } }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/override_response_single" } } + }, + "description": "Create a WAF override response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/override_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create a WAF override response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create a WAF override", + "tags": ["WAF overrides"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/firewall/waf/overrides/{id}": { + "delete": { + "description": "Deletes an existing URI-based WAF override.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).", + "operationId": "waf-overrides-delete-a-waf-override", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { "$ref": "#/components/schemas/overrides_components-schemas-id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "result": { + "properties": { "id": { "$ref": "#/components/schemas/overrides_components-schemas-id" } } + } + }, + "type": "object" + } + } + }, + "description": "Delete a WAF override response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "properties": { + "result": { + "properties": { "id": { "$ref": "#/components/schemas/overrides_components-schemas-id" } } + } + }, + "type": "object" + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete a WAF override response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete a WAF override", + "tags": ["WAF overrides"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "get": { + "description": "Fetches the details of a URI-based WAF override.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).", + "operationId": "waf-overrides-get-a-waf-override", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { "$ref": "#/components/schemas/overrides_components-schemas-id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/override_response_single" } } + }, + "description": "Get a WAF override response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/override_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get a WAF override response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a WAF override", + "tags": ["WAF overrides"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "put": { + "description": "Updates an existing URI-based WAF override.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).", + "operationId": "waf-overrides-update-waf-override", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { "$ref": "#/components/schemas/overrides_components-schemas-id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "required": ["id", "urls", "rules", "rewrite_action"] } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/override_response_single" } } + }, + "description": "Update WAF override response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/override_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update WAF override response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update WAF override", + "tags": ["WAF overrides"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/firewall/waf/packages": { + "get": { + "description": "Fetches WAF packages for a zone.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).", + "operationId": "waf-packages-list-waf-packages", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "query", + "name": "page", + "schema": { + "default": 1, + "description": "The page number of paginated results.", + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { + "default": 50, + "description": "The number of packages per page.", + "maximum": 100, + "minimum": 5, + "type": "number" + } + }, + { + "in": "query", + "name": "order", + "schema": { + "description": "The field used to sort returned packages.", + "enum": ["name"], + "example": "status", + "type": "string" + } + }, + { + "in": "query", + "name": "direction", + "schema": { + "description": "The direction used to sort returned packages.", + "enum": ["asc", "desc"], + "example": "desc", + "type": "string" + } + }, + { + "in": "query", + "name": "match", + "schema": { + "default": "all", + "description": "When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match.", + "enum": ["any", "all"], + "type": "string" + } + }, + { + "in": "query", + "name": "name", + "schema": { + "description": "The name of the WAF package.", + "example": "USER", + "readOnly": true, + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/package_response_collection" } } + }, + "description": "List WAF packages response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/package_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List WAF packages response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List WAF packages", + "tags": ["WAF packages"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + } + }, + "/zones/{zone_identifier}/firewall/waf/packages/{identifier}": { + "get": { + "description": "Fetches the details of a WAF package.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).", + "operationId": "waf-packages-get-a-waf-package", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/package_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/package_response_single" } } }, + "description": "Get a WAF package response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/package_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get a WAF package response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a WAF package", + "tags": ["WAF packages"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + }, + "patch": { + "description": "Updates a WAF package. You can update the sensitivity and the action of an anomaly detection WAF package.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).", + "operationId": "waf-packages-update-a-waf-package", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/package_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "action_mode": { "$ref": "#/components/schemas/action_mode" }, + "sensitivity": { "$ref": "#/components/schemas/sensitivity" } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/package_response_single" }, + { "properties": { "result": { "$ref": "#/components/schemas/anomaly_package" } } } + ] + } + } + }, + "description": "Update a WAF package response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/package_response_single" }, + { "properties": { "result": { "$ref": "#/components/schemas/anomaly_package" } } } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update a WAF package response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update a WAF package", + "tags": ["WAF packages"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + } + }, + "/zones/{zone_identifier}/firewall/waf/packages/{package_identifier}/groups": { + "get": { + "description": "Fetches the WAF rule groups in a WAF package.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).", + "operationId": "waf-rule-groups-list-waf-rule-groups", + "parameters": [ + { + "in": "path", + "name": "package_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/package_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { "in": "query", "name": "mode", "schema": { "$ref": "#/components/schemas/components-schemas-mode" } }, + { + "in": "query", + "name": "page", + "schema": { + "default": 1, + "description": "The page number of paginated results.", + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { + "default": 50, + "description": "The number of rule groups per page.", + "maximum": 100, + "minimum": 5, + "type": "number" + } + }, + { + "in": "query", + "name": "order", + "schema": { + "description": "The field used to sort returned rule groups.", + "enum": ["mode", "rules_count"], + "example": "mode" + } + }, + { + "in": "query", + "name": "direction", + "schema": { + "description": "The direction used to sort returned rule groups.", + "enum": ["asc", "desc"], + "example": "desc" + } + }, + { + "in": "query", + "name": "match", + "schema": { + "default": "all", + "description": "When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match.", + "enum": ["any", "all"] + } + }, + { + "in": "query", + "name": "name", + "schema": { + "description": "The name of the rule group.", + "example": "Project Honey Pot", + "readOnly": true, + "type": "string" + } + }, + { + "in": "query", + "name": "rules_count", + "schema": { + "default": 0, + "description": "The number of rules in the current rule group.", + "example": 10, + "readOnly": true, + "type": "number" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/rule_group_response_collection" } } + }, + "description": "List WAF rule groups response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/rule_group_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List WAF rule groups response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List WAF rule groups", + "tags": ["WAF rule groups"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + } + }, + "/zones/{zone_identifier}/firewall/waf/packages/{package_identifier}/groups/{identifier}": { + "get": { + "description": "Fetches the details of a WAF rule group.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).", + "operationId": "waf-rule-groups-get-a-waf-rule-group", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/group_components-schemas-identifier" } + }, + { + "in": "path", + "name": "package_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/package_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/rule_group_response_single" } } + }, + "description": "Get a WAF rule group response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/rule_group_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get a WAF rule group response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a WAF rule group", + "tags": ["WAF rule groups"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + }, + "patch": { + "description": "Updates a WAF rule group. You can update the state (`mode` parameter) of a rule group.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).", + "operationId": "waf-rule-groups-update-a-waf-rule-group", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/group_components-schemas-identifier" } + }, + { + "in": "path", + "name": "package_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/package_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { "properties": { "mode": { "$ref": "#/components/schemas/components-schemas-mode" } } } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/rule_group_response_single" } } + }, + "description": "Update a WAF rule group response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/rule_group_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update a WAF rule group response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update a WAF rule group", + "tags": ["WAF rule groups"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + } + }, + "/zones/{zone_identifier}/healthchecks": { + "get": { + "description": "List configured health checks.", + "operationId": "health-checks-list-health-checks", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Kg4WBtjI" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/response_collection-MecJdTin" } } + }, + "description": "List Health Checks response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/response_collection-MecJdTin" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Health Checks response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Health Checks", + "tags": ["Health Checks"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + }, + "post": { + "description": "Create a new health check.", + "operationId": "health-checks-create-health-check", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Kg4WBtjI" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/query_healthcheck" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response-JiiItTpX" } } + }, + "description": "Create Health Check response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response-JiiItTpX" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Health Check response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Health Check", + "tags": ["Health Checks"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + } + }, + "/zones/{zone_identifier}/healthchecks/preview": { + "post": { + "description": "Create a new preview health check.", + "operationId": "health-checks-create-preview-health-check", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Kg4WBtjI" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/query_healthcheck" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response-JiiItTpX" } } + }, + "description": "Create Preview Health Check response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response-JiiItTpX" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Preview Health Check response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Preview Health Check", + "tags": ["Health Checks"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + } + }, + "/zones/{zone_identifier}/healthchecks/preview/{identifier}": { + "delete": { + "description": "Delete a health check.", + "operationId": "health-checks-delete-preview-health-check", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Kg4WBtjI" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Kg4WBtjI" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/id_response" } } }, + "description": "Delete Preview Health Check response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/id_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Preview Health Check response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Preview Health Check", + "tags": ["Health Checks"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + }, + "get": { + "description": "Fetch a single configured health check preview.", + "operationId": "health-checks-health-check-preview-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Kg4WBtjI" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Kg4WBtjI" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response-JiiItTpX" } } + }, + "description": "Health Check Preview Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response-JiiItTpX" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Health Check Preview Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Health Check Preview Details", + "tags": ["Health Checks"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + } + }, + "/zones/{zone_identifier}/healthchecks/{identifier}": { + "delete": { + "description": "Delete a health check.", + "operationId": "health-checks-delete-health-check", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Kg4WBtjI" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Kg4WBtjI" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/id_response" } } }, + "description": "Delete Health Check response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/id_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Health Check response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Health Check", + "tags": ["Health Checks"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + }, + "get": { + "description": "Fetch a single configured health check.", + "operationId": "health-checks-health-check-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Kg4WBtjI" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Kg4WBtjI" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response-JiiItTpX" } } + }, + "description": "Health Check Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response-JiiItTpX" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Health Check Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Health Check Details", + "tags": ["Health Checks"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + }, + "patch": { + "description": "Patch a configured health check.", + "operationId": "health-checks-patch-health-check", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Kg4WBtjI" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Kg4WBtjI" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/query_healthcheck" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response-JiiItTpX" } } + }, + "description": "Patch Health Check response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response-JiiItTpX" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Patch Health Check response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Patch Health Check", + "tags": ["Health Checks"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + }, + "put": { + "description": "Update a configured health check.", + "operationId": "health-checks-update-health-check", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Kg4WBtjI" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Kg4WBtjI" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/query_healthcheck" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response-JiiItTpX" } } + }, + "description": "Update Health Check response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response-JiiItTpX" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Health Check response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Health Check", + "tags": ["Health Checks"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + } + }, + "/zones/{zone_identifier}/keyless_certificates": { + "get": { + "description": "List all Keyless SSL configurations for a given zone.", + "operationId": "keyless-ssl-for-a-zone-list-keyless-ssl-configurations", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/keyless_response_collection" } } + }, + "description": "List Keyless SSL Configurations response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/keyless_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Keyless SSL Configurations response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Keyless SSL Configurations", + "tags": ["Keyless SSL for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#ssl:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "post": { + "operationId": "keyless-ssl-for-a-zone-create-keyless-ssl-configuration", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "bundle_method": { "$ref": "#/components/schemas/bundle_method" }, + "certificate": { "$ref": "#/components/schemas/schemas-certificate" }, + "host": { "$ref": "#/components/schemas/schemas-host" }, + "name": { "$ref": "#/components/schemas/keyless-certificate_components-schemas-name" }, + "port": { "$ref": "#/components/schemas/port-0Rcq4sy6" } + }, + "required": ["host", "port", "certificate"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/keyless_response_single-D6V6oKzw" } } + }, + "description": "Create Keyless SSL Configuration response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/keyless_response_single-D6V6oKzw" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Keyless SSL Configuration response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Keyless SSL Configuration", + "tags": ["Keyless SSL for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#ssl:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/keyless_certificates/{identifier}": { + "delete": { + "operationId": "keyless-ssl-for-a-zone-delete-keyless-ssl-configuration", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/keyless-certificate_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/keyless_response_single_id-oOZ29VcY" } } + }, + "description": "Delete Keyless SSL Configuration response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/keyless_response_single_id-oOZ29VcY" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Keyless SSL Configuration response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Keyless SSL Configuration", + "tags": ["Keyless SSL for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#ssl:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "get": { + "description": "Get details for one Keyless SSL configuration.", + "operationId": "keyless-ssl-for-a-zone-get-keyless-ssl-configuration", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/keyless-certificate_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/keyless_response_single-D6V6oKzw" } } + }, + "description": "Get Keyless SSL Configuration response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/keyless_response_single-D6V6oKzw" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Keyless SSL Configuration response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Keyless SSL Configuration", + "tags": ["Keyless SSL for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#ssl:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "patch": { + "description": "This will update attributes of a Keyless SSL. Consists of one or more of the following: host,name,port,certificate,enabled.", + "operationId": "keyless-ssl-for-a-zone-edit-keyless-ssl-configuration", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/keyless-certificate_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "enabled": { "$ref": "#/components/schemas/enabled-mOUbjYfQ" }, + "host": { "$ref": "#/components/schemas/schemas-host" }, + "name": { "$ref": "#/components/schemas/keyless-certificate_components-schemas-name" }, + "port": { "$ref": "#/components/schemas/port-0Rcq4sy6" } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/keyless_response_single-D6V6oKzw" } } + }, + "description": "Edit Keyless SSL Configuration response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/keyless_response_single-D6V6oKzw" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Edit Keyless SSL Configuration response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Edit Keyless SSL Configuration", + "tags": ["Keyless SSL for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#ssl:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/logpush/datasets/{dataset}/fields": { + "get": { + "description": "Lists all fields available for a dataset. The response result is an object with key-value pairs, where keys are field names, and values are descriptions.", + "operationId": "get-zones-zone_identifier-logpush-datasets-dataset-fields", + "parameters": [ + { "in": "path", "name": "dataset", "required": true, "schema": { "$ref": "#/components/schemas/dataset" } }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Gw95Cj70" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/logpush_field_response_collection" } } + }, + "description": "List fields response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/logpush_field_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List fields response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List fields", + "tags": ["Logpush jobs for a zone"], + "x-cfPermissionsRequired": { "enum": ["#logs:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/logpush/datasets/{dataset}/jobs": { + "get": { + "description": "Lists Logpush jobs for a zone for a dataset.", + "operationId": "get-zones-zone_identifier-logpush-datasets-dataset-jobs", + "parameters": [ + { "in": "path", "name": "dataset", "required": true, "schema": { "$ref": "#/components/schemas/dataset" } }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Gw95Cj70" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/logpush_job_response_collection" } } + }, + "description": "List Logpush jobs for a dataset response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/logpush_job_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Logpush jobs for a dataset response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Logpush jobs for a dataset", + "tags": ["Logpush jobs for a zone"], + "x-cfPermissionsRequired": { "enum": ["#logs:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/logpush/edge": { + "get": { + "description": "Lists Instant Logs jobs for a zone.", + "operationId": "get-zones-zone_identifier-logpush-edge-jobs", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Gw95Cj70" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/instant_logs_job_response_collection" } } + }, + "description": "List Instant Logs jobs response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/instant_logs_job_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Instant Logs jobs response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Instant Logs jobs", + "tags": ["Instant Logs jobs for a zone"], + "x-cfPermissionsRequired": { "enum": ["#logs:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "post": { + "description": "Creates a new Instant Logs job for a zone.", + "operationId": "post-zones-zone_identifier-logpush-edge-jobs", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Gw95Cj70" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "fields": { "$ref": "#/components/schemas/fields" }, + "filter": { "$ref": "#/components/schemas/filter" }, + "sample": { "$ref": "#/components/schemas/sample" } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/instant_logs_job_response_single" } } + }, + "description": "Create Instant Logs job response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/instant_logs_job_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Instant Logs job response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Instant Logs job", + "tags": ["Instant Logs jobs for a zone"], + "x-cfPermissionsRequired": { "enum": ["#logs:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/logpush/jobs": { + "get": { + "description": "Lists Logpush jobs for a zone.", + "operationId": "get-zones-zone_identifier-logpush-jobs", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Gw95Cj70" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/logpush_job_response_collection" } } + }, + "description": "List Logpush jobs response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/logpush_job_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Logpush jobs response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Logpush jobs", + "tags": ["Logpush jobs for a zone"], + "x-cfPermissionsRequired": { "enum": ["#logs:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "post": { + "description": "Creates a new Logpush job for a zone.", + "operationId": "post-zones-zone_identifier-logpush-jobs", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Gw95Cj70" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "dataset": { "$ref": "#/components/schemas/dataset" }, + "destination_conf": { "$ref": "#/components/schemas/destination_conf" }, + "enabled": { "$ref": "#/components/schemas/enabled-A6pti18n" }, + "frequency": { "$ref": "#/components/schemas/frequency" }, + "logpull_options": { "$ref": "#/components/schemas/logpull_options" }, + "name": { "$ref": "#/components/schemas/name-rRqaJzmt" }, + "ownership_challenge": { "$ref": "#/components/schemas/ownership_challenge" } + }, + "required": ["destination_conf"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/logpush_job_response_single" } } + }, + "description": "Create Logpush job response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/logpush_job_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Logpush job response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Logpush job", + "tags": ["Logpush jobs for a zone"], + "x-cfPermissionsRequired": { "enum": ["#logs:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/logpush/jobs/{job_identifier}": { + "delete": { + "description": "Deletes a Logpush job.", + "operationId": "delete-zones-zone_identifier-logpush-jobs-job_identifier", + "parameters": [ + { + "in": "path", + "name": "job_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/id-Un5diNDY" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Gw95Cj70" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { "properties": { "result": { "example": {}, "nullable": true, "type": "object" } } } + ] + } + } + }, + "description": "Delete Logpush job response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { "properties": { "result": { "example": {}, "nullable": true, "type": "object" } } } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Logpush job response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Logpush job", + "tags": ["Logpush jobs for a zone"], + "x-cfPermissionsRequired": { "enum": ["#logs:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "get": { + "description": "Gets the details of a Logpush job.", + "operationId": "get-zones-zone_identifier-logpush-jobs-job_identifier", + "parameters": [ + { + "in": "path", + "name": "job_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/id-Un5diNDY" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Gw95Cj70" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/logpush_job_response_single" } } + }, + "description": "Get Logpush job details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/logpush_job_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Logpush job details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Logpush job details", + "tags": ["Logpush jobs for a zone"], + "x-cfPermissionsRequired": { "enum": ["#logs:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "put": { + "description": "Updates a Logpush job.", + "operationId": "put-zones-zone_identifier-logpush-jobs-job_identifier", + "parameters": [ + { + "in": "path", + "name": "job_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/id-Un5diNDY" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Gw95Cj70" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "destination_conf": { "$ref": "#/components/schemas/destination_conf" }, + "enabled": { "$ref": "#/components/schemas/enabled-A6pti18n" }, + "frequency": { "$ref": "#/components/schemas/frequency" }, + "logpull_options": { "$ref": "#/components/schemas/logpull_options" }, + "ownership_challenge": { "$ref": "#/components/schemas/ownership_challenge" } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/logpush_job_response_single" } } + }, + "description": "Update Logpush job response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/logpush_job_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Logpush job response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Logpush job", + "tags": ["Logpush jobs for a zone"], + "x-cfPermissionsRequired": { "enum": ["#logs:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/logpush/ownership": { + "post": { + "description": "Gets a new ownership challenge sent to your destination.", + "operationId": "post-zones-zone_identifier-logpush-ownership", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Gw95Cj70" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "destination_conf": { "$ref": "#/components/schemas/destination_conf" } }, + "required": ["destination_conf"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/get_ownership_response" } } }, + "description": "Get ownership challenge response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/get_ownership_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get ownership challenge response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get ownership challenge", + "tags": ["Logpush jobs for a zone"], + "x-cfPermissionsRequired": { "enum": ["#logs:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/logpush/ownership/validate": { + "post": { + "description": "Validates ownership challenge of the destination.", + "operationId": "post-zones-zone_identifier-logpush-ownership-validate", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Gw95Cj70" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "destination_conf": { "$ref": "#/components/schemas/destination_conf" }, + "ownership_challenge": { "$ref": "#/components/schemas/ownership_challenge" } + }, + "required": ["destination_conf", "ownership_challenge"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/validate_ownership_response" } } + }, + "description": "Validate ownership challenge response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/validate_ownership_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Validate ownership challenge response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Validate ownership challenge", + "tags": ["Logpush jobs for a zone"], + "x-cfPermissionsRequired": { "enum": ["#logs:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/logpush/validate/destination/exists": { + "post": { + "description": "Checks if there is an existing job with a destination.", + "operationId": "post-zones-zone_identifier-logpush-validate-destination-exists", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Gw95Cj70" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "destination_conf": { "$ref": "#/components/schemas/destination_conf" } }, + "required": ["destination_conf"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/destination_exists_response" } } + }, + "description": "Check destination exists response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/destination_exists_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Check destination exists response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Check destination exists", + "tags": ["Logpush jobs for a zone"], + "x-cfPermissionsRequired": { "enum": ["#logs:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/logpush/validate/origin": { + "post": { + "description": "Validates logpull origin with logpull_options.", + "operationId": "post-zones-zone_identifier-logpush-validate-origin", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-Gw95Cj70" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "logpull_options": { "$ref": "#/components/schemas/logpull_options" } }, + "required": ["logpull_options"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/validate_response-PaQpkUV3" } } + }, + "description": "Validate origin response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/validate_response-PaQpkUV3" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Validate origin response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Validate origin", + "tags": ["Logpush jobs for a zone"], + "x-cfPermissionsRequired": { "enum": ["#logs:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/logs/control/retention/flag": { + "get": { + "description": "Gets log retention flag for Logpull API.", + "operationId": "logs-received-get-log-retention-flag", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/flag_response" } } }, + "description": "Get log retention flag response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/flag_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get log retention flag response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get log retention flag", + "tags": ["Logs Received"], + "x-cfPermissionsRequired": { "enum": ["#logs:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "post": { + "description": "Updates log retention flag for Logpull API.", + "operationId": "logs-received-update-log-retention-flag", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "flag": { "$ref": "#/components/schemas/flag" } }, + "required": ["flag"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/flag_response" } } }, + "description": "Update log retention flag response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/flag_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update log retention flag response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update log retention flag", + "tags": ["Logs Received"], + "x-cfPermissionsRequired": { "enum": ["#logs:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/logs/rayids/{ray_identifier}": { + "get": { + "description": "The `/rayids` api route allows lookups by specific rayid. The rayids route will return zero, one, or more records (ray ids are not unique).", + "operationId": "logs-received-get-logs-ray-i-ds", + "parameters": [ + { + "in": "path", + "name": "ray_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/ray_identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { "in": "query", "name": "timestamps", "schema": { "$ref": "#/components/schemas/timestamps" } }, + { + "in": "query", + "name": "fields", + "schema": { + "description": "The `/received` route by default returns a limited set of fields, and allows customers to override the default field set by specifying individual fields. The reasons for this are: 1. Most customers require only a small subset of fields, but that subset varies from customer to customer; 2. Flat schema is much easier to work with downstream (importing into BigTable etc); 3. Performance (time to process, file size). If `?fields=` is not specified, default field set is returned. This default field set may change at any time. When `?fields=` is provided, each record is returned with the specified fields. `fields` must be specified as a comma separated list without any whitespaces, and all fields must exist. The order in which fields are specified does not matter, and the order of fields in the response is not specified.", + "example": "ClientIP,RayID,EdgeStartTimestamp", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logs" } } }, + "description": "Get logs RayIDs response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/logs" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get logs RayIDs response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get logs RayIDs", + "tags": ["Logs Received"], + "x-cfPermissionsRequired": { "enum": ["#logs:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/logs/received": { + "get": { + "description": "The `/received` api route allows customers to retrieve their edge HTTP logs. The basic access pattern is \"give me all the logs for zone Z for minute M\", where the minute M refers to the time records were received at Cloudflare's central data center. `start` is inclusive, and `end` is exclusive. Because of that, to get all data, at minutely cadence, starting at 10AM, the proper values are: `start=2018-05-20T10:00:00Z\u0026end=2018-05-20T10:01:00Z`, then `start=2018-05-20T10:01:00Z\u0026end=2018-05-20T10:02:00Z` and so on; the overlap will be handled properly.", + "operationId": "logs-received-get-logs-received", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { "in": "query", "name": "end", "required": true, "schema": { "$ref": "#/components/schemas/end" } }, + { "in": "query", "name": "sample", "schema": { "$ref": "#/components/schemas/sample-qlwBkrnD" } }, + { "in": "query", "name": "timestamps", "schema": { "$ref": "#/components/schemas/timestamps" } }, + { + "in": "query", + "name": "count", + "schema": { + "description": "When `?count=` is provided, the response will contain up to `count` results. Since results are not sorted, you are likely to get different data for repeated requests. `count` must be an integer \u003e 0.", + "minimum": 1, + "type": "integer" + } + }, + { + "in": "query", + "name": "fields", + "schema": { + "description": "The `/received` route by default returns a limited set of fields, and allows customers to override the default field set by specifying individual fields. The reasons for this are: 1. Most customers require only a small subset of fields, but that subset varies from customer to customer; 2. Flat schema is much easier to work with downstream (importing into BigTable etc); 3. Performance (time to process, file size). If `?fields=` is not specified, default field set is returned. This default field set may change at any time. When `?fields=` is provided, each record is returned with the specified fields. `fields` must be specified as a comma separated list without any whitespaces, and all fields must exist. The order in which fields are specified does not matter, and the order of fields in the response is not specified.", + "example": "ClientIP,RayID,EdgeStartTimestamp", + "type": "string" + } + }, + { + "in": "query", + "name": "start", + "schema": { + "anyOf": [{ "type": "string" }, { "type": "integer" }], + "description": "Sets the (inclusive) beginning of the requested time frame. This can be a unix timestamp (in seconds or nanoseconds), or an absolute timestamp that conforms to RFC 3339. At this point in time, it cannot exceed a time in the past greater than seven days.", + "example": "2018-05-20T10:00:00Z" + } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/logs" } } }, + "description": "Get logs received response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/logs" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get logs received response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get logs received", + "tags": ["Logs Received"], + "x-cfPermissionsRequired": { "enum": ["#logs:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/logs/received/fields": { + "get": { + "description": "Lists all fields available. The response is json object with key-value pairs, where keys are field names, and values are descriptions.", + "operationId": "logs-received-list-fields", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fields_response" } } }, + "description": "List fields response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/fields_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List fields response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List fields", + "tags": ["Logs Received"], + "x-cfPermissionsRequired": { "enum": ["#logs:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/origin_tls_client_auth": { + "get": { + "operationId": "zone-level-authenticated-origin-pulls-list-certificates", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-certificate_response_collection" } + } + }, + "description": "List Certificates response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-certificate_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Certificates response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Certificates", + "tags": ["Zone-Level Authenticated Origin Pulls"], + "x-cfPermissionsRequired": { "enum": ["#ssl:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "post": { + "description": "Upload your own certificate you want Cloudflare to use for edge-to-origin communication to override the shared certificate. Please note that it is important to keep only one certificate active. Also, make sure to enable zone-level authenticated origin pulls by making a PUT call to settings endpoint to see the uploaded certificate in use.", + "operationId": "zone-level-authenticated-origin-pulls-upload-certificate", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "certificate": { + "$ref": "#/components/schemas/zone-authenticated-origin-pull_components-schemas-certificate" + }, + "private_key": { "$ref": "#/components/schemas/private_key" } + }, + "required": ["certificate", "private_key"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/certificate_response_single" } } + }, + "description": "Upload Certificate response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/certificate_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Upload Certificate response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Upload Certificate", + "tags": ["Zone-Level Authenticated Origin Pulls"], + "x-cfPermissionsRequired": { "enum": ["#ssl:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/origin_tls_client_auth/hostnames": { + "put": { + "description": "Associate a hostname to a certificate and enable, disable or invalidate the association. If disabled, client certificate will not be sent to the hostname even if activated at the zone level. 100 maximum associations on a single certificate are allowed. Note: Use a null value for parameter *enabled* to invalidate the association.", + "operationId": "per-hostname-authenticated-origin-pull-enable-or-disable-a-hostname-for-client-authentication", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "config": { "$ref": "#/components/schemas/config" } }, + "required": ["config"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/hostname_aop_response_collection" } } + }, + "description": "Enable or Disable a Hostname for Client Authentication response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/hostname_aop_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Enable or Disable a Hostname for Client Authentication response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Enable or Disable a Hostname for Client Authentication", + "tags": ["Per-hostname Authenticated Origin Pull"], + "x-cfPermissionsRequired": { "enum": ["#ssl:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/origin_tls_client_auth/hostnames/certificates": { + "get": { + "operationId": "per-hostname-authenticated-origin-pull-list-certificates", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate_response_collection" + } + } + }, + "description": "List Certificates response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate_response_collection" + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Certificates response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Certificates", + "tags": ["Per-hostname Authenticated Origin Pull"], + "x-cfPermissionsRequired": { "enum": ["#ssl:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "post": { + "description": "Upload a certificate to be used for client authentication on a hostname. 10 hostname certificates per zone are allowed.", + "operationId": "per-hostname-authenticated-origin-pull-upload-a-hostname-client-certificate", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "certificate": { + "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate" + }, + "private_key": { "$ref": "#/components/schemas/schemas-private_key" } + }, + "required": ["certificate", "private_key"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-certificate_response_single" } + } + }, + "description": "Upload a Hostname Client Certificate response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-certificate_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Upload a Hostname Client Certificate response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Upload a Hostname Client Certificate", + "tags": ["Per-hostname Authenticated Origin Pull"], + "x-cfPermissionsRequired": { "enum": ["#ssl:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/origin_tls_client_auth/hostnames/certificates/{identifier}": { + "delete": { + "operationId": "per-hostname-authenticated-origin-pull-delete-hostname-client-certificate", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { + "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier" + } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-certificate_response_single" } + } + }, + "description": "Delete Hostname Client Certificate response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-certificate_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Hostname Client Certificate response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Hostname Client Certificate", + "tags": ["Per-hostname Authenticated Origin Pull"], + "x-cfPermissionsRequired": { "enum": ["#ssl:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "get": { + "description": "Get the certificate by ID to be used for client authentication on a hostname.", + "operationId": "per-hostname-authenticated-origin-pull-get-the-hostname-client-certificate", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { + "$ref": "#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier" + } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-certificate_response_single" } + } + }, + "description": "Get the Hostname Client Certificate response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-certificate_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get the Hostname Client Certificate response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get the Hostname Client Certificate", + "tags": ["Per-hostname Authenticated Origin Pull"], + "x-cfPermissionsRequired": { "enum": ["#ssl:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/origin_tls_client_auth/hostnames/{hostname}": { + "get": { + "operationId": "per-hostname-authenticated-origin-pull-get-the-hostname-status-for-client-authentication", + "parameters": [ + { + "in": "path", + "name": "hostname", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-hostname" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/hostname_aop_single_response" } } + }, + "description": "Get the Hostname Status for Client Authentication response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/hostname_aop_single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get the Hostname Status for Client Authentication response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get the Hostname Status for Client Authentication", + "tags": ["Per-hostname Authenticated Origin Pull"], + "x-cfPermissionsRequired": { "enum": ["#ssl:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/origin_tls_client_auth/settings": { + "get": { + "description": "Get whether zone-level authenticated origin pulls is enabled or not. It is false by default.", + "operationId": "zone-level-authenticated-origin-pulls-get-enablement-setting-for-zone", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/enabled_response" } } }, + "description": "Get Enablement Setting for Zone response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/enabled_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Enablement Setting for Zone response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Enablement Setting for Zone", + "tags": ["Zone-Level Authenticated Origin Pulls"], + "x-cfPermissionsRequired": { "enum": ["#ssl:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "put": { + "description": "Enable or disable zone-level authenticated origin pulls. 'enabled' should be set true either before/after the certificate is uploaded to see the certificate in use.", + "operationId": "zone-level-authenticated-origin-pulls-set-enablement-for-zone", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "enabled": { + "$ref": "#/components/schemas/zone-authenticated-origin-pull_components-schemas-enabled" + } + }, + "required": ["enabled"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/enabled_response" } } }, + "description": "Set Enablement for Zone response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/enabled_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Set Enablement for Zone response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Set Enablement for Zone", + "tags": ["Zone-Level Authenticated Origin Pulls"], + "x-cfPermissionsRequired": { "enum": ["#ssl:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/origin_tls_client_auth/{identifier}": { + "delete": { + "operationId": "zone-level-authenticated-origin-pulls-delete-certificate", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/zone-authenticated-origin-pull_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/certificate_response_single" } } + }, + "description": "Delete Certificate response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/certificate_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Certificate response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Certificate", + "tags": ["Zone-Level Authenticated Origin Pulls"], + "x-cfPermissionsRequired": { "enum": ["#ssl:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "get": { + "operationId": "zone-level-authenticated-origin-pulls-get-certificate-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/zone-authenticated-origin-pull_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/certificate_response_single" } } + }, + "description": "Get Certificate Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/certificate_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Certificate Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Certificate Details", + "tags": ["Zone-Level Authenticated Origin Pulls"], + "x-cfPermissionsRequired": { "enum": ["#ssl:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/pagerules": { + "get": { + "description": "Fetches Page Rules in a zone.", + "operationId": "page-rules-list-page-rules", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + }, + { + "in": "query", + "name": "order", + "schema": { + "default": "priority", + "description": "The field used to sort returned Page Rules.", + "enum": ["status", "priority"], + "example": "status", + "type": "string" + } + }, + { + "in": "query", + "name": "direction", + "schema": { + "default": "desc", + "description": "The direction used to sort returned Page Rules.", + "enum": ["asc", "desc"], + "example": "desc", + "type": "string" + } + }, + { + "in": "query", + "name": "match", + "schema": { + "default": "all", + "description": "When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match.", + "enum": ["any", "all"], + "type": "string" + } + }, + { + "in": "query", + "name": "status", + "schema": { + "default": "disabled", + "description": "The status of the Page Rule.", + "enum": ["active", "disabled"], + "example": "active", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/pagerule_response_collection" } } + }, + "description": "List Page Rules response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/pagerule_response_collection" }, + { "$ref": "#/components/schemas/schemas-api-response-common-failure" } + ] + } + } + }, + "description": "List Page Rules response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Page Rules", + "tags": ["Page Rules"], + "x-cfPermissionsRequired": { "enum": ["#zone:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "post": { + "description": "Creates a new Page Rule.", + "operationId": "page-rules-create-a-page-rule", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "actions": { "$ref": "#/components/schemas/actions" }, + "priority": { "$ref": "#/components/schemas/priority-21tFu5p5" }, + "status": { "$ref": "#/components/schemas/status-cnKVAn0b" }, + "targets": { "$ref": "#/components/schemas/targets" } + }, + "required": ["targets", "actions"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/pagerule_response_single" } } + }, + "description": "Create a Page Rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/pagerule_response_single" }, + { "$ref": "#/components/schemas/schemas-api-response-common-failure" } + ] + } + } + }, + "description": "Create a Page Rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create a Page Rule", + "tags": ["Page Rules"], + "x-cfPermissionsRequired": { "enum": ["#zone:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/pagerules/settings": { + "get": { + "description": "Returns a list of settings (and their details) that Page Rules can apply to matching requests.", + "operationId": "available-page-rules-settings-list-available-page-rules-settings", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/pagerule_settings_response_collection" } } + }, + "description": "List available Page Rules settings response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/pagerule_settings_response_collection" }, + { "$ref": "#/components/schemas/schemas-api-response-common-failure" } + ] + } + } + }, + "description": "List available Page Rules settings response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List available Page Rules settings", + "tags": ["Available Page Rules settings"], + "x-cfPermissionsRequired": { "enum": ["#zone:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/pagerules/{identifier}": { + "delete": { + "description": "Deletes an existing Page Rule.", + "operationId": "page-rules-delete-a-page-rule", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-api-response-single-id" } } + }, + "description": "Delete a Page Rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-api-response-single-id" }, + { "$ref": "#/components/schemas/schemas-api-response-common-failure" } + ] + } + } + }, + "description": "Delete a Page Rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete a Page Rule", + "tags": ["Page Rules"], + "x-cfPermissionsRequired": { "enum": ["#zone:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "get": { + "description": "Fetches the details of a Page Rule.", + "operationId": "page-rules-get-a-page-rule", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/pagerule_response_single" } } + }, + "description": "Get a Page Rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/pagerule_response_single" }, + { "$ref": "#/components/schemas/schemas-api-response-common-failure" } + ] + } + } + }, + "description": "Get a Page Rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a Page Rule", + "tags": ["Page Rules"], + "x-cfPermissionsRequired": { "enum": ["#zone:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Updates one or more fields of an existing Page Rule.", + "operationId": "page-rules-edit-a-page-rule", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "actions": { "$ref": "#/components/schemas/actions" }, + "priority": { "$ref": "#/components/schemas/priority-21tFu5p5" }, + "status": { "$ref": "#/components/schemas/status-cnKVAn0b" }, + "targets": { "$ref": "#/components/schemas/targets" } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/pagerule_response_single" } } + }, + "description": "Edit a Page Rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/pagerule_response_single" }, + { "$ref": "#/components/schemas/schemas-api-response-common-failure" } + ] + } + } + }, + "description": "Edit a Page Rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Edit a Page Rule", + "tags": ["Page Rules"], + "x-cfPermissionsRequired": { "enum": ["#zone:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "put": { + "description": "Replaces the configuration of an existing Page Rule. The configuration of the updated Page Rule will exactly match the data passed in the API request.", + "operationId": "page-rules-update-a-page-rule", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "actions": { "$ref": "#/components/schemas/actions" }, + "priority": { "$ref": "#/components/schemas/priority-21tFu5p5" }, + "status": { "$ref": "#/components/schemas/status-cnKVAn0b" }, + "targets": { "$ref": "#/components/schemas/targets" } + }, + "required": ["targets", "actions"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/pagerule_response_single" } } + }, + "description": "Update a Page Rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/pagerule_response_single" }, + { "$ref": "#/components/schemas/schemas-api-response-common-failure" } + ] + } + } + }, + "description": "Update a Page Rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update a Page Rule", + "tags": ["Page Rules"], + "x-cfPermissionsRequired": { "enum": ["#zone:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/railguns": { + "get": { + "description": "A list of available Railguns the zone can use.", + "operationId": "railgun-connections-for-a-zone-list-available-railguns", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-railgun_response_collection" } } + }, + "description": "List available Railguns response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-railgun_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List available Railguns response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List available Railguns", + "tags": ["Railgun Connections for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/railguns/{identifier}": { + "get": { + "description": "Lists details about a specific Railgun.", + "operationId": "railgun-connections-for-a-zone-railgun-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/railgun_components-schemas-identifier-2" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/railgun_response_single" } } }, + "description": "Railgun details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/railgun_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Railgun details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Railgun details", + "tags": ["Railgun Connections for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + }, + "patch": { + "description": "Connect or disconnect a Railgun.", + "operationId": "railgun-connections-for-a-zone-connect-or-disconnect-a-railgun", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/railgun_components-schemas-identifier-2" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "connected": { "$ref": "#/components/schemas/connected" } }, + "required": ["connected"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/railgun_response_single" } } }, + "description": "Connect or disconnect a Railgun response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/railgun_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Connect or disconnect a Railgun response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Connect or disconnect a Railgun", + "tags": ["Railgun Connections for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/railguns/{identifier}/diagnose": { + "get": { + "description": "Tests the Railgun connection to the zone.", + "operationId": "railgun-connections-for-a-zone-test-railgun-connection", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/railgun_components-schemas-identifier-2" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/test_connection_response" } } + }, + "description": "Test Railgun connection response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/test_connection_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Test Railgun connection response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Test Railgun connection", + "tags": ["Railgun Connections for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/rate_limits": { + "get": { + "description": "Fetches the rate limits for a zone.", + "operationId": "rate-limits-for-a-zone-list-rate-limits", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "query", + "name": "page", + "schema": { + "default": 1, + "description": "The page number of paginated results.", + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { + "default": 20, + "description": "The maximum number of results per page. You can only set the value to `1` or to a multiple of 5 such as `5`, `10`, `15`, or `20`.", + "maximum": 1000, + "minimum": 1, + "type": "number" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ratelimit_response_collection" } } + }, + "description": "List rate limits response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/ratelimit_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List rate limits response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List rate limits", + "tags": ["Rate limits for a zone"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "post": { + "description": "Creates a new rate limit for a zone. Refer to the object definition for a list of required attributes.", + "operationId": "rate-limits-for-a-zone-create-a-rate-limit", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "required": ["match", "threshold", "period", "action"] } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ratelimit_response_single" } } + }, + "description": "Create a rate limit response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/ratelimit_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create a rate limit response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create a rate limit", + "tags": ["Rate limits for a zone"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/rate_limits/{id}": { + "delete": { + "description": "Deletes an existing rate limit.", + "operationId": "rate-limits-for-a-zone-delete-a-rate-limit", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { "$ref": "#/components/schemas/rate-limits_components-schemas-id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/ratelimit_response_single" }, + { + "properties": { + "result": { + "properties": { "id": { "$ref": "#/components/schemas/rate-limits_components-schemas-id" } } + } + }, + "type": "object" + } + ] + } + } + }, + "description": "Delete a rate limit response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/ratelimit_response_single" }, + { + "properties": { + "result": { + "properties": { + "id": { "$ref": "#/components/schemas/rate-limits_components-schemas-id" } + } + } + }, + "type": "object" + } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete a rate limit response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete a rate limit", + "tags": ["Rate limits for a zone"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "get": { + "description": "Fetches the details of a rate limit.", + "operationId": "rate-limits-for-a-zone-get-a-rate-limit", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { "$ref": "#/components/schemas/rate-limits_components-schemas-id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ratelimit_response_single" } } + }, + "description": "Get a rate limit response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/ratelimit_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get a rate limit response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a rate limit", + "tags": ["Rate limits for a zone"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "put": { + "description": "Updates an existing rate limit.", + "operationId": "rate-limits-for-a-zone-update-a-rate-limit", + "parameters": [ + { + "in": "path", + "name": "id", + "required": true, + "schema": { "$ref": "#/components/schemas/rate-limits_components-schemas-id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { "schema": { "required": ["id", "match", "threshold", "period", "action"] } } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ratelimit_response_single" } } + }, + "description": "Update a rate limit response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/ratelimit_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update a rate limit response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update a rate limit", + "tags": ["Rate limits for a zone"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/secondary_dns/force_axfr": { + "post": { + "description": "Sends AXFR zone transfer request to primary nameserver(s).", + "operationId": "secondary-dns-(-secondary-zone)-force-axfr", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-ahBjrSIO" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/force_response" } } }, + "description": "Force AXFR response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/force_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Force AXFR response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Force AXFR", + "tags": ["Secondary DNS (Secondary Zone)"], + "x-cfPermissionsRequired": { "enum": ["#dns_records:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/secondary_dns/incoming": { + "delete": { + "description": "Delete secondary zone configuration for incoming zone transfers.", + "operationId": "secondary-dns-(-secondary-zone)-delete-secondary-zone-configuration", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-ahBjrSIO" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/id_response-lg4lL9us" } } }, + "description": "Delete Secondary Zone Configuration response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/id_response-lg4lL9us" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Secondary Zone Configuration response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Secondary Zone Configuration", + "tags": ["Secondary DNS (Secondary Zone)"], + "x-cfPermissionsRequired": { "enum": ["#dns_records:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "get": { + "description": "Get secondary zone configuration for incoming zone transfers.", + "operationId": "secondary-dns-(-secondary-zone)-secondary-zone-configuration-details", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-ahBjrSIO" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response_incoming" } } + }, + "description": "Secondary Zone Configuration Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response_incoming" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Secondary Zone Configuration Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Secondary Zone Configuration Details", + "tags": ["Secondary DNS (Secondary Zone)"], + "x-cfPermissionsRequired": { "enum": ["#dns_records:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "post": { + "description": "Create secondary zone configuration for incoming zone transfers.", + "operationId": "secondary-dns-(-secondary-zone)-create-secondary-zone-configuration", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-ahBjrSIO" } + } + ], + "requestBody": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/dns-secondary-secondary-zone" } } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response_incoming" } } + }, + "description": "Create Secondary Zone Configuration response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response_incoming" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Secondary Zone Configuration response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Secondary Zone Configuration", + "tags": ["Secondary DNS (Secondary Zone)"], + "x-cfPermissionsRequired": { "enum": ["#dns_records:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "put": { + "description": "Update secondary zone configuration for incoming zone transfers.", + "operationId": "secondary-dns-(-secondary-zone)-update-secondary-zone-configuration", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-ahBjrSIO" } + } + ], + "requestBody": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/dns-secondary-secondary-zone" } } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response_incoming" } } + }, + "description": "Update Secondary Zone Configuration response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response_incoming" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Secondary Zone Configuration response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Secondary Zone Configuration", + "tags": ["Secondary DNS (Secondary Zone)"], + "x-cfPermissionsRequired": { "enum": ["#dns_records:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/secondary_dns/outgoing": { + "delete": { + "description": "Delete primary zone configuration for outgoing zone transfers.", + "operationId": "secondary-dns-(-primary-zone)-delete-primary-zone-configuration", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-ahBjrSIO" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/id_response-lg4lL9us" } } }, + "description": "Delete Primary Zone Configuration response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/id_response-lg4lL9us" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Primary Zone Configuration response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Primary Zone Configuration", + "tags": ["Secondary DNS (Primary Zone)"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "get": { + "description": "Get primary zone configuration for outgoing zone transfers.", + "operationId": "secondary-dns-(-primary-zone)-primary-zone-configuration-details", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-ahBjrSIO" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response_outgoing" } } + }, + "description": "Primary Zone Configuration Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response_outgoing" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Primary Zone Configuration Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Primary Zone Configuration Details", + "tags": ["Secondary DNS (Primary Zone)"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "post": { + "description": "Create primary zone configuration for outgoing zone transfers.", + "operationId": "secondary-dns-(-primary-zone)-create-primary-zone-configuration", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-ahBjrSIO" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/single_request_outgoing" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response_outgoing" } } + }, + "description": "Create Primary Zone Configuration response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response_outgoing" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Primary Zone Configuration response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Primary Zone Configuration", + "tags": ["Secondary DNS (Primary Zone)"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "put": { + "description": "Update primary zone configuration for outgoing zone transfers.", + "operationId": "secondary-dns-(-primary-zone)-update-primary-zone-configuration", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-ahBjrSIO" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/single_request_outgoing" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response_outgoing" } } + }, + "description": "Update Primary Zone Configuration response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response_outgoing" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Primary Zone Configuration response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Primary Zone Configuration", + "tags": ["Secondary DNS (Primary Zone)"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/secondary_dns/outgoing/disable": { + "post": { + "description": "Disable outgoing zone transfers for primary zone and clears IXFR backlog of primary zone.", + "operationId": "secondary-dns-(-primary-zone)-disable-outgoing-zone-transfers", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-ahBjrSIO" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/disable_transfer_response" } } + }, + "description": "Disable Outgoing Zone Transfers response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/disable_transfer_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Disable Outgoing Zone Transfers response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Disable Outgoing Zone Transfers", + "tags": ["Secondary DNS (Primary Zone)"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/secondary_dns/outgoing/enable": { + "post": { + "description": "Enable outgoing zone transfers for primary zone.", + "operationId": "secondary-dns-(-primary-zone)-enable-outgoing-zone-transfers", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-ahBjrSIO" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/enable_transfer_response" } } + }, + "description": "Enable Outgoing Zone Transfers response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/enable_transfer_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Enable Outgoing Zone Transfers response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Enable Outgoing Zone Transfers", + "tags": ["Secondary DNS (Primary Zone)"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/secondary_dns/outgoing/force_notify": { + "post": { + "description": "Notifies the secondary nameserver(s) and clears IXFR backlog of primary zone.", + "operationId": "secondary-dns-(-primary-zone)-force-dns-notify", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-ahBjrSIO" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-force_response" } } }, + "description": "Force DNS NOTIFY response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-force_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Force DNS NOTIFY response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Force DNS NOTIFY", + "tags": ["Secondary DNS (Primary Zone)"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/secondary_dns/outgoing/status": { + "get": { + "description": "Get primary zone transfer status.", + "operationId": "secondary-dns-(-primary-zone)-get-outgoing-zone-transfer-status", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-ahBjrSIO" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/enable_transfer_response" } } + }, + "description": "Get Outgoing Zone Transfer Status response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/enable_transfer_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Outgoing Zone Transfer Status response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Outgoing Zone Transfer Status", + "tags": ["Secondary DNS (Primary Zone)"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/settings": { + "get": { + "description": "Available settings for your user in relation to a zone.", + "operationId": "zone-settings-get-all-zone-settings", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/zone_settings_response_collection" } } + }, + "description": "Get all Zone settings response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get all Zone settings response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get all Zone settings", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Edit settings for a zone.", + "operationId": "zone-settings-edit-zone-settings-info", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "items": { + "description": "One or more zone setting objects. Must contain an ID and a value.", + "example": [ + { "id": "always_online", "value": "on" }, + { "id": "browser_cache_ttl", "value": 18000 }, + { "id": "ip_geolocation", "value": "off" } + ], + "items": { "$ref": "#/components/schemas/setting" }, + "minItems": 1, + "type": "array" + } + }, + "required": ["items"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/zone_settings_response_collection" } } + }, + "description": "Edit zone settings info response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Edit zone settings info response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Edit zone settings info", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/0rtt": { + "get": { + "description": "Gets 0-RTT session resumption setting.", + "operationId": "zone-settings-get-0-rtt-session-resumption-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/0rtt" } } } + ] + } + } + }, + "description": "Get 0-RTT session resumption setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get 0-RTT session resumption setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get 0-RTT session resumption setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Changes the 0-RTT session resumption setting.", + "operationId": "zone-settings-change-0-rtt-session-resumption-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/0rtt_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/0rtt" } } } + ] + } + } + }, + "description": "Change 0-RTT session resumption setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change 0-RTT session resumption setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change 0-RTT session resumption setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/advanced_ddos": { + "get": { + "description": "Advanced protection from Distributed Denial of Service (DDoS) attacks on your website. This is an uneditable value that is 'on' in the case of Business and Enterprise zones.", + "operationId": "zone-settings-get-advanced-ddos-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/advanced_ddos" } } } + ] + } + } + }, + "description": "Get Advanced DDOS setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Advanced DDOS setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Advanced DDOS setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/settings/always_online": { + "get": { + "description": "When enabled, Cloudflare serves limited copies of web pages available from the [Internet Archive's Wayback Machine](https://archive.org/web/) if your server is offline. Refer to [Always Online](https://developers.cloudflare.com/cache/about/always-online) for more information.", + "operationId": "zone-settings-get-always-online-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/always_online" } } } + ] + } + } + }, + "description": "Get Always Online setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Always Online setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Always Online setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "When enabled, Cloudflare serves limited copies of web pages available from the [Internet Archive's Wayback Machine](https://archive.org/web/) if your server is offline. Refer to [Always Online](https://developers.cloudflare.com/cache/about/always-online) for more information.", + "operationId": "zone-settings-change-always-online-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/always_online_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/always_online" } } } + ] + } + } + }, + "description": "Change Always Online setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Always Online setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Always Online setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/always_use_https": { + "get": { + "description": "Reply to all requests for URLs that use \"http\" with a 301 redirect to the equivalent \"https\" URL. If you only want to redirect for a subset of requests, consider creating an \"Always use HTTPS\" page rule.", + "operationId": "zone-settings-get-always-use-https-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/always_use_https" } } } + ] + } + } + }, + "description": "Get Always Use HTTPS setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Always Use HTTPS setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Always Use HTTPS setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Reply to all requests for URLs that use \"http\" with a 301 redirect to the equivalent \"https\" URL. If you only want to redirect for a subset of requests, consider creating an \"Always use HTTPS\" page rule.", + "operationId": "zone-settings-change-always-use-https-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/always_use_https_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/always_use_https" } } } + ] + } + } + }, + "description": "Change Always Use HTTPS setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Always Use HTTPS setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Always Use HTTPS setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/automatic_https_rewrites": { + "get": { + "description": "Enable the Automatic HTTPS Rewrites feature for this zone.", + "operationId": "zone-settings-get-automatic-https-rewrites-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/automatic_https_rewrites" } } } + ] + } + } + }, + "description": "Get Automatic HTTPS Rewrites setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Automatic HTTPS Rewrites setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Automatic HTTPS Rewrites setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Enable the Automatic HTTPS Rewrites feature for this zone.", + "operationId": "zone-settings-change-automatic-https-rewrites-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/automatic_https_rewrites_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/automatic_https_rewrites" } } } + ] + } + } + }, + "description": "Change Automatic HTTPS Rewrites setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Automatic HTTPS Rewrites setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Automatic HTTPS Rewrites setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/automatic_platform_optimization": { + "get": { + "description": "[Automatic Platform Optimization for WordPress](https://developers.cloudflare.com/automatic-platform-optimization/)\nserves your WordPress site from Cloudflare's edge network and caches\nthird-party fonts.\n", + "operationId": "zone-settings-get-automatic_platform_optimization-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/automatic_platform_optimization" } } } + ] + } + } + }, + "description": "Get Automatic Platform Optimization for WordPress setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Automatic Platform Optimization for WordPress setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Automatic Platform Optimization for WordPress setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "[Automatic Platform Optimization for WordPress](https://developers.cloudflare.com/automatic-platform-optimization/)\nserves your WordPress site from Cloudflare's edge network and caches\nthird-party fonts.\n", + "operationId": "zone-settings-change-automatic_platform_optimization-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/automatic_platform_optimization" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/automatic_platform_optimization" } } } + ] + } + } + }, + "description": "Change Automatic Platform Optimization for WordPress setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Automatic Platform Optimization for WordPress setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Automatic Platform Optimization for WordPress setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/brotli": { + "get": { + "description": "When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset.", + "operationId": "zone-settings-get-brotli-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/brotli" } } } + ] + } + } + }, + "description": "Get Brotli setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Brotli setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Brotli setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset.", + "operationId": "zone-settings-change-brotli-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/brotli_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/brotli" } } } + ] + } + } + }, + "description": "Change Brotli setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Brotli setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Brotli setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/browser_cache_ttl": { + "get": { + "description": "Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources will remain on your visitors' computers. Cloudflare will honor any larger times specified by your server. (https://support.cloudflare.com/hc/en-us/articles/200168276).", + "operationId": "zone-settings-get-browser-cache-ttl-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/browser_cache_ttl" } } } + ] + } + } + }, + "description": "Get Browser Cache TTL setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Browser Cache TTL setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Browser Cache TTL setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources will remain on your visitors' computers. Cloudflare will honor any larger times specified by your server. (https://support.cloudflare.com/hc/en-us/articles/200168276).", + "operationId": "zone-settings-change-browser-cache-ttl-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/browser_cache_ttl_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/browser_cache_ttl" } } } + ] + } + } + }, + "description": "Change Browser Cache TTL setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Browser Cache TTL setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Browser Cache TTL setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/browser_check": { + "get": { + "description": "Browser Integrity Check is similar to Bad Behavior and looks for common HTTP headers abused most commonly by spammers and denies access to your page. It will also challenge visitors that do not have a user agent or a non standard user agent (also commonly used by abuse bots, crawlers or visitors). (https://support.cloudflare.com/hc/en-us/articles/200170086).", + "operationId": "zone-settings-get-browser-check-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/browser_check" } } } + ] + } + } + }, + "description": "Get Browser Check setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Browser Check setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Browser Check setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Browser Integrity Check is similar to Bad Behavior and looks for common HTTP headers abused most commonly by spammers and denies access to your page. It will also challenge visitors that do not have a user agent or a non standard user agent (also commonly used by abuse bots, crawlers or visitors). (https://support.cloudflare.com/hc/en-us/articles/200170086).", + "operationId": "zone-settings-change-browser-check-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/browser_check_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/browser_check" } } } + ] + } + } + }, + "description": "Change Browser Check setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Browser Check setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Browser Check setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/cache_level": { + "get": { + "description": "Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). The simplified setting will ignore the query string when delivering a cached resource. The aggressive setting will cache all static resources, including ones with a query string. (https://support.cloudflare.com/hc/en-us/articles/200168256).", + "operationId": "zone-settings-get-cache-level-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/cache_level" } } } + ] + } + } + }, + "description": "Get Cache Level setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Cache Level setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Cache Level setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). The simplified setting will ignore the query string when delivering a cached resource. The aggressive setting will cache all static resources, including ones with a query string. (https://support.cloudflare.com/hc/en-us/articles/200168256).", + "operationId": "zone-settings-change-cache-level-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/cache_level_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/cache_level" } } } + ] + } + } + }, + "description": "Change Cache Level setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Cache Level setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Cache Level setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/challenge_ttl": { + "get": { + "description": "Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136).", + "operationId": "zone-settings-get-challenge-ttl-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/challenge_ttl" } } } + ] + } + } + }, + "description": "Get Challenge TTL setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Challenge TTL setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Challenge TTL setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136).", + "operationId": "zone-settings-change-challenge-ttl-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/challenge_ttl_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/challenge_ttl" } } } + ] + } + } + }, + "description": "Change Challenge TTL setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Challenge TTL setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Challenge TTL setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/ciphers": { + "get": { + "description": "Gets ciphers setting.", + "operationId": "zone-settings-get-ciphers-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/ciphers" } } } + ] + } + } + }, + "description": "Get ciphers setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get ciphers setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get ciphers setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Changes ciphers setting.", + "operationId": "zone-settings-change-ciphers-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/ciphers_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/ciphers" } } } + ] + } + } + }, + "description": "Change ciphers setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change ciphers setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change ciphers setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/development_mode": { + "get": { + "description": "Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare's accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off.", + "operationId": "zone-settings-get-development-mode-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/development_mode" } } } + ] + } + } + }, + "description": "Get Development Mode setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Development Mode setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Development Mode setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare's accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off.", + "operationId": "zone-settings-change-development-mode-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/development_mode_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/development_mode" } } } + ] + } + } + }, + "description": "Change Development Mode setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Development Mode setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Development Mode setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/early_hints": { + "get": { + "description": "When enabled, Cloudflare will attempt to speed up overall page loads by serving `103` responses with `Link` headers from the final response. Refer to [Early Hints](https://developers.cloudflare.com/cache/about/early-hints) for more information.", + "operationId": "zone-settings-get-early-hints-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/early_hints" } } } + ] + } + } + }, + "description": "Get Early Hints setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Early Hints setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Early Hints setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "When enabled, Cloudflare will attempt to speed up overall page loads by serving `103` responses with `Link` headers from the final response. Refer to [Early Hints](https://developers.cloudflare.com/cache/about/early-hints) for more information.", + "operationId": "zone-settings-change-early-hints-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/early_hints_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/early_hints" } } } + ] + } + } + }, + "description": "Change Early Hints setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Early Hints setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Early Hints setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/email_obfuscation": { + "get": { + "description": "Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016).", + "operationId": "zone-settings-get-email-obfuscation-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/email_obfuscation" } } } + ] + } + } + }, + "description": "Get Email Obfuscation setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Email Obfuscation setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Email Obfuscation setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016).", + "operationId": "zone-settings-change-email-obfuscation-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/email_obfuscation_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/email_obfuscation" } } } + ] + } + } + }, + "description": "Change Email Obfuscation setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Email Obfuscation setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Email Obfuscation setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/h2_prioritization": { + "get": { + "description": "Gets HTTP/2 Edge Prioritization setting.\n", + "operationId": "zone-settings-get-h2_prioritization-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/h2_prioritization" } } } + ] + } + } + }, + "description": "Get HTTP/2 Edge Prioritization setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get HTTP/2 Edge Prioritization setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get HTTP/2 Edge Prioritization setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Gets HTTP/2 Edge Prioritization setting.\n", + "operationId": "zone-settings-change-h2_prioritization-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/h2_prioritization" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/h2_prioritization" } } } + ] + } + } + }, + "description": "Change HTTP/2 Edge Prioritization setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change HTTP/2 Edge Prioritization setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change HTTP/2 Edge Prioritization setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/hotlink_protection": { + "get": { + "description": "When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it's not another site requesting them. People will still be able to download and view images from your page, but other sites won't be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026).", + "operationId": "zone-settings-get-hotlink-protection-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/hotlink_protection" } } } + ] + } + } + }, + "description": "Get Hotlink Protection setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Hotlink Protection setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Hotlink Protection setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it's not another site requesting them. People will still be able to download and view images from your page, but other sites won't be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026).", + "operationId": "zone-settings-change-hotlink-protection-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/hotlink_protection_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/hotlink_protection" } } } + ] + } + } + }, + "description": "Change Hotlink Protection setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Hotlink Protection setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Hotlink Protection setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/http2": { + "get": { + "description": "Value of the HTTP2 setting.", + "operationId": "zone-settings-get-h-t-t-p-2-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/http2" } } } + ] + } + } + }, + "description": "Get HTTP2 setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get HTTP2 setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get HTTP2 setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Value of the HTTP2 setting.", + "operationId": "zone-settings-change-h-t-t-p-2-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/http2_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/http2" } } } + ] + } + } + }, + "description": "Change HTTP2 setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change HTTP2 setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change HTTP2 setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/http3": { + "get": { + "description": "Value of the HTTP3 setting.", + "operationId": "zone-settings-get-h-t-t-p-3-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/http3" } } } + ] + } + } + }, + "description": "Get HTTP3 setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get HTTP3 setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get HTTP3 setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Value of the HTTP3 setting.", + "operationId": "zone-settings-change-h-t-t-p-3-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/http3_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/http3" } } } + ] + } + } + }, + "description": "Change HTTP3 setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change HTTP3 setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change HTTP3 setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/image_resizing": { + "get": { + "description": "Image Resizing provides on-demand resizing, conversion and optimisation\nfor images served through Cloudflare's network. Refer to the\n[Image Resizing documentation](https://developers.cloudflare.com/images/)\nfor more information.\n", + "operationId": "zone-settings-get-image_resizing-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/image_resizing" } } } + ] + } + } + }, + "description": "Get Image Resizing setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Image Resizing setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Image Resizing setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Image Resizing provides on-demand resizing, conversion and optimisation\nfor images served through Cloudflare's network. Refer to the\n[Image Resizing documentation](https://developers.cloudflare.com/images/)\nfor more information.\n", + "operationId": "zone-settings-change-image_resizing-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/image_resizing" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/image_resizing" } } } + ] + } + } + }, + "description": "Change Image Resizing setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Image Resizing setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Image Resizing setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/ip_geolocation": { + "get": { + "description": "Enable IP Geolocation to have Cloudflare geolocate visitors to your website and pass the country code to you. (https://support.cloudflare.com/hc/en-us/articles/200168236).", + "operationId": "zone-settings-get-ip-geolocation-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/ip_geolocation" } } } + ] + } + } + }, + "description": "Get IP Geolocation setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get IP Geolocation setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get IP Geolocation setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Enable IP Geolocation to have Cloudflare geolocate visitors to your website and pass the country code to you. (https://support.cloudflare.com/hc/en-us/articles/200168236).", + "operationId": "zone-settings-change-ip-geolocation-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/ip_geolocation_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/ip_geolocation" } } } + ] + } + } + }, + "description": "Change IP Geolocation setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change IP Geolocation setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change IP Geolocation setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/ipv6": { + "get": { + "description": "Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586).", + "operationId": "zone-settings-get-i-pv6-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/ipv6" } } } + ] + } + } + }, + "description": "Get IPv6 setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get IPv6 setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get IPv6 setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Enable IPv6 on all subdomains that are Cloudflare enabled. (https://support.cloudflare.com/hc/en-us/articles/200168586).", + "operationId": "zone-settings-change-i-pv6-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/ipv6_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/ipv6" } } } + ] + } + } + }, + "description": "Change IPv6 setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change IPv6 setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change IPv6 setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/min_tls_version": { + "get": { + "description": "Gets Minimum TLS Version setting.", + "operationId": "zone-settings-get-minimum-tls-version-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/min_tls_version" } } } + ] + } + } + }, + "description": "Get Minimum TLS Version setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Minimum TLS Version setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Minimum TLS Version setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Changes Minimum TLS Version setting.", + "operationId": "zone-settings-change-minimum-tls-version-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/min_tls_version_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/min_tls_version" } } } + ] + } + } + }, + "description": "Change Minimum TLS Version setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Minimum TLS Version setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Minimum TLS Version setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/minify": { + "get": { + "description": "Automatically minify certain assets for your website. Refer to [Using Cloudflare Auto Minify](https://support.cloudflare.com/hc/en-us/articles/200168196) for more information.", + "operationId": "zone-settings-get-minify-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/minify" } } } + ] + } + } + }, + "description": "Get Minify setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Minify setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Minify setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Automatically minify certain assets for your website. Refer to [Using Cloudflare Auto Minify](https://support.cloudflare.com/hc/en-us/articles/200168196) for more information.", + "operationId": "zone-settings-change-minify-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/minify_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/minify" } } } + ] + } + } + }, + "description": "Change Minify setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Minify setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Minify setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/mirage": { + "get": { + "description": "Automatically optimize image loading for website visitors on mobile\ndevices. Refer to our [blog post](http://blog.cloudflare.com/mirage2-solving-mobile-speed)\nfor more information.\n", + "operationId": "zone-settings-get-mirage-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/mirage" } } } + ] + } + } + }, + "description": "Get Mirage setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Mirage setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Mirage setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Automatically optimize image loading for website visitors on mobile devices. Refer to our [blog post](http://blog.cloudflare.com/mirage2-solving-mobile-speed) for more information.", + "operationId": "zone-settings-change-web-mirage-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/mirage_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/mirage" } } } + ] + } + } + }, + "description": "Change Mirage setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Mirage setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Mirage setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/mobile_redirect": { + "get": { + "description": "Automatically redirect visitors on mobile devices to a mobile-optimized subdomain. Refer to [Understanding Cloudflare Mobile Redirect](https://support.cloudflare.com/hc/articles/200168336) for more information.", + "operationId": "zone-settings-get-mobile-redirect-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/mobile_redirect" } } } + ] + } + } + }, + "description": "Get Mobile Redirect setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Mobile Redirect setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Mobile Redirect setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Automatically redirect visitors on mobile devices to a mobile-optimized subdomain. Refer to [Understanding Cloudflare Mobile Redirect](https://support.cloudflare.com/hc/articles/200168336) for more information.", + "operationId": "zone-settings-change-mobile-redirect-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/mobile_redirect_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/mobile_redirect" } } } + ] + } + } + }, + "description": "Change Mobile Redirect setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Mobile Redirect setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Mobile Redirect setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/nel": { + "get": { + "description": "Enable Network Error Logging reporting on your zone. (Beta)\n", + "operationId": "zone-settings-get-nel-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/nel" } } } + ] + } + } + }, + "description": "Get Network Error Logging setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Network Error Logging setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Network Error Logging setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Automatically optimize image loading for website visitors on mobile devices. Refer to our [blog post](http://blog.cloudflare.com/nel-solving-mobile-speed) for more information.", + "operationId": "zone-settings-change-nel-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { "properties": { "value": { "$ref": "#/components/schemas/nel" } }, "required": ["value"] } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/nel" } } } + ] + } + } + }, + "description": "Change Network Error Logging setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Network Error Logging setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Network Error Logging setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/opportunistic_encryption": { + "get": { + "description": "Gets Opportunistic Encryption setting.", + "operationId": "zone-settings-get-opportunistic-encryption-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/opportunistic_encryption" } } } + ] + } + } + }, + "description": "Get Opportunistic Encryption setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Opportunistic Encryption setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Opportunistic Encryption setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Changes Opportunistic Encryption setting.", + "operationId": "zone-settings-change-opportunistic-encryption-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/opportunistic_encryption_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/opportunistic_encryption" } } } + ] + } + } + }, + "description": "Change Opportunistic Encryption setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Opportunistic Encryption setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Opportunistic Encryption setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/opportunistic_onion": { + "get": { + "description": "Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes.", + "operationId": "zone-settings-get-opportunistic-onion-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/opportunistic_onion" } } } + ] + } + } + }, + "description": "Get Opportunistic Onion setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Opportunistic Onion setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Opportunistic Onion setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes.", + "operationId": "zone-settings-change-opportunistic-onion-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/opportunistic_onion_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/opportunistic_onion" } } } + ] + } + } + }, + "description": "Change Opportunistic Onion setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Opportunistic Onion setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Opportunistic Onion setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/orange_to_orange": { + "get": { + "description": "Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other\nzones also on Cloudflare.\n", + "operationId": "zone-settings-get-orange_to_orange-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/orange_to_orange" } } } + ] + } + } + }, + "description": "Get Orange to Orange (O2O) setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Orange to Orange (O2O) setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Orange to Orange (O2O) setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other\nzones also on Cloudflare.\n", + "operationId": "zone-settings-change-orange_to_orange-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/orange_to_orange" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/orange_to_orange" } } } + ] + } + } + }, + "description": "Change Orange to Orange (O2O) setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Orange to Orange (O2O) setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Orange to Orange (O2O) setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/origin_error_page_pass_thru": { + "get": { + "description": "Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones.", + "operationId": "zone-settings-get-enable-error-pages-on-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/origin_error_page_pass_thru" } } } + ] + } + } + }, + "description": "Get Enable Error Pages On setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Enable Error Pages On setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Enable Error Pages On setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "patch": { + "description": "Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones.", + "operationId": "zone-settings-change-enable-error-pages-on-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/origin_error_page_pass_thru_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/origin_error_page_pass_thru" } } } + ] + } + } + }, + "description": "Change Enable Error Pages On setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Enable Error Pages On setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Enable Error Pages On setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/settings/origin_max_http_version": { + "get": { + "description": "The highest HTTP version Cloudflare will attempt to use with your\norigin. This setting allows Cloudflare to make HTTP/2 requests to your\norigin. (Refer to \n[Enable HTTP/2 to Origin](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/),\nfor more information.).\n", + "operationId": "zone-settings-get-origin_max_http_version-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/origin_max_http_version" } } } + ] + } + } + }, + "description": "Get Origin Max HTTP Version setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Origin Max HTTP Version setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Origin Max HTTP Version setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "The highest HTTP version Cloudflare will attempt to use with your\norigin. This setting allows Cloudflare to make HTTP/2 requests to your\norigin. (Refer to \n[Enable HTTP/2 to Origin](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/),\nfor more information.).\n", + "operationId": "zone-settings-change-origin_max_http_version-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/origin_max_http_version" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/origin_max_http_version" } } } + ] + } + } + }, + "description": "Change Origin Max HTTP Version setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Origin Max HTTP Version setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Origin Max HTTP Version setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/polish": { + "get": { + "description": "Automatically optimize image loading for website visitors on mobile\ndevices. Refer to our [blog post](http://blog.cloudflare.com/polish-solving-mobile-speed)\nfor more information.\n", + "operationId": "zone-settings-get-polish-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/polish" } } } + ] + } + } + }, + "description": "Get Polish setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Polish setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Polish setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Automatically optimize image loading for website visitors on mobile devices. Refer to our [blog post](http://blog.cloudflare.com/polish-solving-mobile-speed) for more information.", + "operationId": "zone-settings-change-polish-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { "properties": { "value": { "$ref": "#/components/schemas/polish" } }, "required": ["value"] } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/polish" } } } + ] + } + } + }, + "description": "Change Polish setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Polish setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Polish setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/prefetch_preload": { + "get": { + "description": "Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones.", + "operationId": "zone-settings-get-prefetch-preload-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/prefetch_preload" } } } + ] + } + } + }, + "description": "Get prefetch preload setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get prefetch preload setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get prefetch preload setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "patch": { + "description": "Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones.", + "operationId": "zone-settings-change-prefetch-preload-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/prefetch_preload_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/prefetch_preload" } } } + ] + } + } + }, + "description": "Change prefetch preload setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change prefetch preload setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change prefetch preload setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/settings/privacy_pass": { + "get": { + "description": "Privacy Pass is a browser extension developed by the Privacy Pass Team to improve the browsing experience for your visitors. Enabling Privacy Pass will reduce the number of CAPTCHAs shown to your visitors. (https://support.cloudflare.com/hc/en-us/articles/115001992652-Privacy-Pass).", + "operationId": "zone-settings-get-privacy-pass-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/privacy_pass" } } } + ] + } + } + }, + "description": "Get Privacy Pass setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Privacy Pass setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Privacy Pass setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Privacy Pass is a browser extension developed by the Privacy Pass Team to improve the browsing experience for your visitors. Enabling Privacy Pass will reduce the number of CAPTCHAs shown to your visitors. (https://support.cloudflare.com/hc/en-us/articles/115001992652-Privacy-Pass).", + "operationId": "zone-settings-change-privacy-pass-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/privacy_pass_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/privacy_pass" } } } + ] + } + } + }, + "description": "Change Privacy Pass setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Privacy Pass setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Privacy Pass setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/proxy_read_timeout": { + "get": { + "description": "Maximum time between two read operations from origin.\n", + "operationId": "zone-settings-get-proxy_read_timeout-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/proxy_read_timeout" } } } + ] + } + } + }, + "description": "Get Proxy Read Timeout setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Proxy Read Timeout setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Proxy Read Timeout setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Maximum time between two read operations from origin.\n", + "operationId": "zone-settings-change-proxy_read_timeout-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/proxy_read_timeout" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/proxy_read_timeout" } } } + ] + } + } + }, + "description": "Change Proxy Read Timeout setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Proxy Read Timeout setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Proxy Read Timeout setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/pseudo_ipv4": { + "get": { + "description": "Value of the Pseudo IPv4 setting.", + "operationId": "zone-settings-get-pseudo-i-pv4-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/pseudo_ipv4" } } } + ] + } + } + }, + "description": "Get Pseudo IPv4 setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Pseudo IPv4 setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Pseudo IPv4 setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Value of the Pseudo IPv4 setting.", + "operationId": "zone-settings-change-pseudo-i-pv4-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/pseudo_ipv4_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/pseudo_ipv4" } } } + ] + } + } + }, + "description": "Change Pseudo IPv4 setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Pseudo IPv4 setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Pseudo IPv4 setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/response_buffering": { + "get": { + "description": "Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones.", + "operationId": "zone-settings-get-response-buffering-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/response_buffering" } } } + ] + } + } + }, + "description": "Get Response Buffering setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Response Buffering setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Response Buffering setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "patch": { + "description": "Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones.", + "operationId": "zone-settings-change-response-buffering-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/response_buffering_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/response_buffering" } } } + ] + } + } + }, + "description": "Change Response Buffering setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Response Buffering setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Response Buffering setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/settings/rocket_loader": { + "get": { + "description": "Rocket Loader is a general-purpose asynchronous JavaScript optimisation\nthat prioritises rendering your content while loading your site's\nJavascript asynchronously. Turning on Rocket Loader will immediately\nimprove a web page's rendering time sometimes measured as Time to First\nPaint (TTFP), and also the `window.onload` time (assuming there is\nJavaScript on the page). This can have a positive impact on your Google\nsearch ranking. When turned on, Rocket Loader will automatically defer\nthe loading of all Javascript referenced in your HTML, with no\nconfiguration required. Refer to \n[Understanding Rocket Loader](https://support.cloudflare.com/hc/articles/200168056)\nfor more information.\n", + "operationId": "zone-settings-get-rocket_loader-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/rocket_loader" } } } + ] + } + } + }, + "description": "Get Rocket Loader setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Rocket Loader setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Rocket Loader setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Rocket Loader is a general-purpose asynchronous JavaScript optimisation\nthat prioritises rendering your content while loading your site's\nJavascript asynchronously. Turning on Rocket Loader will immediately\nimprove a web page's rendering time sometimes measured as Time to First\nPaint (TTFP), and also the `window.onload` time (assuming there is\nJavaScript on the page). This can have a positive impact on your Google\nsearch ranking. When turned on, Rocket Loader will automatically defer\nthe loading of all Javascript referenced in your HTML, with no\nconfiguration required. Refer to \n[Understanding Rocket Loader](https://support.cloudflare.com/hc/articles/200168056)\nfor more information.\n", + "operationId": "zone-settings-change-rocket_loader-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/rocket_loader" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/rocket_loader" } } } + ] + } + } + }, + "description": "Change Rocket Loader setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Rocket Loader setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Rocket Loader setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/security_header": { + "get": { + "description": "Cloudflare security header for a zone.", + "operationId": "zone-settings-get-security-header-(-hsts)-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/security_header" } } } + ] + } + } + }, + "description": "Get Security Header (HSTS) setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Security Header (HSTS) setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Security Header (HSTS) setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Cloudflare security header for a zone.", + "operationId": "zone-settings-change-security-header-(-hsts)-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/security_header_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/security_header" } } } + ] + } + } + }, + "description": "Change Security Header (HSTS) setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Security Header (HSTS) setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Security Header (HSTS) setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/security_level": { + "get": { + "description": "Choose the appropriate security profile for your website, which will automatically adjust each of the security settings. If you choose to customize an individual security setting, the profile will become Custom. (https://support.cloudflare.com/hc/en-us/articles/200170056).", + "operationId": "zone-settings-get-security-level-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/security_level" } } } + ] + } + } + }, + "description": "Get Security Level setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Security Level setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Security Level setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Choose the appropriate security profile for your website, which will automatically adjust each of the security settings. If you choose to customize an individual security setting, the profile will become Custom. (https://support.cloudflare.com/hc/en-us/articles/200170056).", + "operationId": "zone-settings-change-security-level-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/security_level_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/security_level" } } } + ] + } + } + }, + "description": "Change Security Level setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Security Level setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Security Level setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/server_side_exclude": { + "get": { + "description": "If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: \u003c!--sse--\u003e\u003c!--/sse--\u003e. For example: \u003c!--sse--\u003e Bad visitors won't see my phone number, 555-555-5555 \u003c!--/sse--\u003e. Note: SSE only will work with HTML. If you have HTML minification enabled, you won't see the SSE tags in your HTML source when it's served through Cloudflare. SSE will still function in this case, as Cloudflare's HTML minification and SSE functionality occur on-the-fly as the resource moves through our network to the visitor's computer. (https://support.cloudflare.com/hc/en-us/articles/200170036).", + "operationId": "zone-settings-get-server-side-exclude-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/server_side_exclude" } } } + ] + } + } + }, + "description": "Get Server Side Exclude setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Server Side Exclude setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Server Side Exclude setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: \u003c!--sse--\u003e\u003c!--/sse--\u003e. For example: \u003c!--sse--\u003e Bad visitors won't see my phone number, 555-555-5555 \u003c!--/sse--\u003e. Note: SSE only will work with HTML. If you have HTML minification enabled, you won't see the SSE tags in your HTML source when it's served through Cloudflare. SSE will still function in this case, as Cloudflare's HTML minification and SSE functionality occur on-the-fly as the resource moves through our network to the visitor's computer. (https://support.cloudflare.com/hc/en-us/articles/200170036).", + "operationId": "zone-settings-change-server-side-exclude-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/server_side_exclude_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/server_side_exclude" } } } + ] + } + } + }, + "description": "Change Server Side Exclude setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Server Side Exclude setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Server Side Exclude setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/sort_query_string_for_cache": { + "get": { + "description": "Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones.", + "operationId": "zone-settings-get-enable-query-string-sort-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/sort_query_string_for_cache" } } } + ] + } + } + }, + "description": "Get Enable Query String Sort setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Enable Query String Sort setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Enable Query String Sort setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "patch": { + "description": "Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones.", + "operationId": "zone-settings-change-enable-query-string-sort-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/sort_query_string_for_cache_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/sort_query_string_for_cache" } } } + ] + } + } + }, + "description": "Change Enable Query String Sort setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Enable Query String Sort setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Enable Query String Sort setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/settings/ssl": { + "get": { + "description": "SSL encrypts your visitor's connection and safeguards credit card numbers and other personal data to and from your website. SSL can take up to 5 minutes to fully activate. Requires Cloudflare active on your root domain or www domain. Off: no SSL between the visitor and Cloudflare, and no SSL between Cloudflare and your web server (all HTTP traffic). Flexible: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, but no SSL between Cloudflare and your web server. You don't need to have an SSL cert on your web server, but your vistors will still see the site as being HTTPS enabled. Full: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have your own SSL cert or self-signed cert at the very least. Full (Strict): SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have a valid SSL certificate installed on your web server. This certificate must be signed by a certificate authority, have an expiration date in the future, and respond for the request domain name (hostname). (https://support.cloudflare.com/hc/en-us/articles/200170416).", + "operationId": "zone-settings-get-ssl-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/ssl" } } } + ] + } + } + }, + "description": "Get SSL setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get SSL setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get SSL setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "SSL encrypts your visitor's connection and safeguards credit card numbers and other personal data to and from your website. SSL can take up to 5 minutes to fully activate. Requires Cloudflare active on your root domain or www domain. Off: no SSL between the visitor and Cloudflare, and no SSL between Cloudflare and your web server (all HTTP traffic). Flexible: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, but no SSL between Cloudflare and your web server. You don't need to have an SSL cert on your web server, but your vistors will still see the site as being HTTPS enabled. Full: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have your own SSL cert or self-signed cert at the very least. Full (Strict): SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You'll need to have a valid SSL certificate installed on your web server. This certificate must be signed by a certificate authority, have an expiration date in the future, and respond for the request domain name (hostname). (https://support.cloudflare.com/hc/en-us/articles/200170416).", + "operationId": "zone-settings-change-ssl-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/ssl_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/ssl" } } } + ] + } + } + }, + "description": "Change SSL setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change SSL setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change SSL setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/ssl_recommender": { + "get": { + "description": "Enrollment in the SSL/TLS Recommender service which tries to detect and\nrecommend (by sending periodic emails) the most secure SSL/TLS setting\nyour origin servers support.\n", + "operationId": "zone-settings-get-ssl_recommender-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/ssl_recommender" } } } + ] + } + } + }, + "description": "Get SSL/TLS Recommender enrollment setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get SSL/TLS Recommender enrollment setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get SSL/TLS Recommender enrollment setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Enrollment in the SSL/TLS Recommender service which tries to detect and\nrecommend (by sending periodic emails) the most secure SSL/TLS setting\nyour origin servers support.\n", + "operationId": "zone-settings-change-ssl_recommender-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/ssl_recommender" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/ssl_recommender" } } } + ] + } + } + }, + "description": "Change SSL/TLS Recommender enrollment setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change SSL/TLS Recommender enrollment setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change SSL/TLS Recommender enrollment setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/tls_1_3": { + "get": { + "description": "Gets TLS 1.3 setting enabled for a zone.", + "operationId": "zone-settings-get-tls-1.-3-setting-enabled-for-a-zone", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/tls_1_3" } } } + ] + } + } + }, + "description": "Get TLS 1.3 setting enabled for a zone response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get TLS 1.3 setting enabled for a zone response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get TLS 1.3 setting enabled for a zone", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Changes TLS 1.3 setting.", + "operationId": "zone-settings-change-tls-1.-3-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/tls_1_3_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/tls_1_3" } } } + ] + } + } + }, + "description": "Change TLS 1.3 setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change TLS 1.3 setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change TLS 1.3 setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/tls_client_auth": { + "get": { + "description": "TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only).", + "operationId": "zone-settings-get-tls-client-auth-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/tls_client_auth" } } } + ] + } + } + }, + "description": "Get TLS Client Auth setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get TLS Client Auth setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get TLS Client Auth setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "patch": { + "description": "TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only).", + "operationId": "zone-settings-change-tls-client-auth-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/tls_client_auth_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/tls_client_auth" } } } + ] + } + } + }, + "description": "Change TLS Client Auth setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change TLS Client Auth setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change TLS Client Auth setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/settings/true_client_ip_header": { + "get": { + "description": "Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones.", + "operationId": "zone-settings-get-true-client-ip-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/true_client_ip_header" } } } + ] + } + } + }, + "description": "Get True Client IP setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get True Client IP setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get True Client IP setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "patch": { + "description": "Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones.", + "operationId": "zone-settings-change-true-client-ip-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/true_client_ip_header_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/true_client_ip_header" } } } + ] + } + } + }, + "description": "Change True Client IP setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change True Client IP setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change True Client IP setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/settings/waf": { + "get": { + "description": "The WAF examines HTTP requests to your website. It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will 'challenge' the web visitor with a page that asks them to submit a CAPTCHA successfully to continue their action. If the challenge is failed, the action will be stopped. What this means is that Cloudflare's WAF will block any traffic identified as illegitimate before it reaches your origin web server. (https://support.cloudflare.com/hc/en-us/articles/200172016).", + "operationId": "zone-settings-get-web-application-firewall-(-waf)-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/waf" } } } + ] + } + } + }, + "description": "Get Web Application Firewall (WAF) setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get Web Application Firewall (WAF) setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Web Application Firewall (WAF) setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + }, + "patch": { + "description": "The WAF examines HTTP requests to your website. It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will 'challenge' the web visitor with a page that asks them to submit a CAPTCHA successfully to continue their action. If the challenge is failed, the action will be stopped. What this means is that Cloudflare's WAF will block any traffic identified as illegitimate before it reaches your origin web server. (https://support.cloudflare.com/hc/en-us/articles/200172016).", + "operationId": "zone-settings-change-web-application-firewall-(-waf)-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/waf_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/waf" } } } + ] + } + } + }, + "description": "Change Web Application Firewall (WAF) setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change Web Application Firewall (WAF) setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change Web Application Firewall (WAF) setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/webp": { + "get": { + "description": "When the client requesting the image supports the WebP image codec, and WebP offers a performance advantage over the original image format, Cloudflare will serve a WebP version of the original image.", + "operationId": "zone-settings-get-web-p-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/webp" } } } + ] + } + } + }, + "description": "Get WebP setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get WebP setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get WebP setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "When the client requesting the image supports the WebP image codec, and WebP offers a performance advantage over the original image format, Cloudflare will serve a WebP version of the original image.", + "operationId": "zone-settings-change-web-p-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/webp_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/webp" } } } + ] + } + } + }, + "description": "Change WebP setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change WebP setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change WebP setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + } + }, + "/zones/{zone_identifier}/settings/websockets": { + "get": { + "description": "Gets Websockets setting. For more information about Websockets, please refer to [Using Cloudflare with WebSockets](https://support.cloudflare.com/hc/en-us/articles/200169466-Using-Cloudflare-with-WebSockets).", + "operationId": "zone-settings-get-web-sockets-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/websockets" } } } + ] + } + } + }, + "description": "Get WebSockets setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Get WebSockets setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get WebSockets setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Changes Websockets setting. For more information about Websockets, please refer to [Using Cloudflare with WebSockets](https://support.cloudflare.com/hc/en-us/articles/200169466-Using-Cloudflare-with-WebSockets).", + "operationId": "zone-settings-change-web-sockets-setting", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-MZFDye9j" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { "value": { "$ref": "#/components/schemas/websockets_value" } }, + "required": ["value"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single-WcbmxR67" }, + { "properties": { "result": { "$ref": "#/components/schemas/websockets" } } } + ] + } + } + }, + "description": "Change WebSockets setting response" + }, + "4xx": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-common-failure-3ET5U4FT" } } + }, + "description": "Change WebSockets setting response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Change WebSockets setting", + "tags": ["Zone Settings"], + "x-cfPermissionsRequired": { "enum": ["#zone_settings:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/ssl/certificate_packs": { + "get": { + "description": "For a given zone, list all active certificate packs.", + "operationId": "certificate-packs-list-certificate-packs", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "query", + "name": "status", + "schema": { + "description": "Include Certificate Packs of all statuses, not just active ones.", + "enum": ["all"], + "example": "all" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/certificate_pack_response_collection" } } + }, + "description": "List Certificate Packs response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/certificate_pack_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Certificate Packs response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Certificate Packs", + "tags": ["Certificate Packs"], + "x-cfPermissionsRequired": { "enum": ["#ssl:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/ssl/certificate_packs/order": { + "post": { + "description": "For a given zone, order an advanced certificate pack.", + "operationId": "certificate-packs-order-advanced-certificate-manager-certificate-pack", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "certificate_authority": { "$ref": "#/components/schemas/certificate_authority-VxFhhbhi" }, + "cloudflare_branding": { "$ref": "#/components/schemas/cloudflare_branding" }, + "hosts": { "$ref": "#/components/schemas/schemas-hosts" }, + "type": { "$ref": "#/components/schemas/advanced_type" }, + "validation_method": { "$ref": "#/components/schemas/validation_method" }, + "validity_days": { "$ref": "#/components/schemas/validity_days" } + }, + "required": ["type", "hosts", "validation_method", "validity_days", "certificate_authority"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/advanced_certificate_pack_response_single-M4alsr79" } + } + }, + "description": "Order Advanced Certificate Manager Certificate Pack response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/advanced_certificate_pack_response_single-M4alsr79" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Order Advanced Certificate Manager Certificate Pack response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Order Advanced Certificate Manager Certificate Pack", + "tags": ["Certificate Packs"], + "x-cfPermissionsRequired": { "enum": ["#ssl:read", "#ssl:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/ssl/certificate_packs/quota": { + "get": { + "description": "For a given zone, list certificate pack quotas.", + "operationId": "certificate-packs-get-certificate-pack-quotas", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/certificate_pack_quota_response" } } + }, + "description": "Get Certificate Pack Quotas response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/certificate_pack_quota_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Certificate Pack Quotas response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Certificate Pack Quotas", + "tags": ["Certificate Packs"], + "x-cfPermissionsRequired": { "enum": ["#ssl:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/ssl/certificate_packs/{identifier}": { + "delete": { + "description": "For a given zone, delete an advanced certificate pack.", + "operationId": "certificate-packs-delete-advanced-certificate-manager-certificate-pack", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/certificate-packs_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/delete_advanced_certificate_pack_response_single-AepvbdfN" } + } + }, + "description": "Delete Advanced Certificate Manager Certificate Pack response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/delete_advanced_certificate_pack_response_single-AepvbdfN" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Advanced Certificate Manager Certificate Pack response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Advanced Certificate Manager Certificate Pack", + "tags": ["Certificate Packs"], + "x-cfPermissionsRequired": { "enum": ["#ssl:read", "#ssl:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "get": { + "description": "For a given zone, get a certificate pack.", + "operationId": "certificate-packs-get-certificate-pack", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/certificate-packs_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/certificate_pack_response_single" } } + }, + "description": "Get Certificate Pack response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/certificate_pack_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Certificate Pack response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Certificate Pack", + "tags": ["Certificate Packs"], + "x-cfPermissionsRequired": { "enum": ["#ssl:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "For a given zone, restart validation for an advanced certificate pack. This is only a validation operation for a Certificate Pack in a validation_timed_out status.", + "operationId": "certificate-packs-restart-validation-for-advanced-certificate-manager-certificate-pack", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/certificate-packs_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/advanced_certificate_pack_response_single-M4alsr79" } + } + }, + "description": "Restart Validation for Advanced Certificate Manager Certificate Pack response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/advanced_certificate_pack_response_single-M4alsr79" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Restart Validation for Advanced Certificate Manager Certificate Pack response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Restart Validation for Advanced Certificate Manager Certificate Pack", + "tags": ["Certificate Packs"], + "x-cfPermissionsRequired": { "enum": ["#ssl:read", "#ssl:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/ssl/recommendation": { + "get": { + "description": "Retrieve the SSL/TLS Recommender's recommendation for a zone.", + "operationId": "ssl/-tls-mode-recommendation-ssl/-tls-recommendation", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "id": { "$ref": "#/components/schemas/id-6U71Robk" }, + "modified_on": { "$ref": "#/components/schemas/timestamp" }, + "value": { "$ref": "#/components/schemas/ssl-recommender_components-schemas-value" } + } + } + } + } + ] + } + } + }, + "description": "SSL/TLS Recommendation response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { + "id": { "$ref": "#/components/schemas/id-6U71Robk" }, + "modified_on": { "$ref": "#/components/schemas/timestamp" }, + "value": { "$ref": "#/components/schemas/ssl-recommender_components-schemas-value" } + } + } + } + } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "SSL/TLS Recommendation response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "SSL/TLS Recommendation", + "tags": ["SSL/TLS Mode Recommendation"], + "x-cfPermissionsRequired": { "enum": ["#ssl:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/ssl/universal/settings": { + "get": { + "description": "Get Universal SSL Settings for a Zone.", + "operationId": "universal-ssl-settings-for-a-zone-universal-ssl-settings-details", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ssl_universal_settings_response" } } + }, + "description": "Universal SSL Settings Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/ssl_universal_settings_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Universal SSL Settings Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Universal SSL Settings Details", + "tags": ["Universal SSL Settings for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#ssl:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Patch Universal SSL Settings for a Zone.", + "operationId": "universal-ssl-settings-for-a-zone-edit-universal-ssl-settings", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/universal" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ssl_universal_settings_response" } } + }, + "description": "Edit Universal SSL Settings response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/ssl_universal_settings_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Edit Universal SSL Settings response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Edit Universal SSL Settings", + "tags": ["Universal SSL Settings for a Zone"], + "x-cfPermissionsRequired": { "enum": ["#ssl:read", "#ssl:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/ssl/verification": { + "get": { + "description": "Get SSL Verification Info for a Zone.", + "operationId": "ssl-verification-ssl-verification-details", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "query", + "name": "retry", + "schema": { "description": "Immediately retry SSL Verification.", "enum": [true], "example": true } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/ssl_verification_response_collection" } } + }, + "description": "SSL Verification Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/ssl_verification_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "SSL Verification Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "SSL Verification Details", + "tags": ["SSL Verification"], + "x-cfPermissionsRequired": { "enum": ["#ssl:read"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/ssl/verification/{cert_pack_uuid}": { + "patch": { + "description": "Edit SSL validation method for a certificate pack. A PATCH request will request an immediate validation check on any certificate, and return the updated status. If a validation method is provided, the validation will be immediately attempted using that method.", + "operationId": "ssl-verification-edit-ssl-certificate-pack-validation-method", + "parameters": [ + { + "in": "path", + "name": "cert_pack_uuid", + "required": true, + "schema": { "$ref": "#/components/schemas/cert_pack_uuid" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/components-schemas-validation_method" } } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/ssl_validation_method_response_collection" } + } + }, + "description": "Edit SSL Certificate Pack Validation Method response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/ssl_validation_method_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Edit SSL Certificate Pack Validation Method response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Edit SSL Certificate Pack Validation Method", + "tags": ["SSL Verification"], + "x-cfPermissionsRequired": { "enum": ["#ssl:read", "#ssl:edit"] }, + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/waiting_rooms": { + "get": { + "description": "Lists waiting rooms.", + "operationId": "waiting-room-list-waiting-rooms", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-fzl1amog" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/response_collection-AZRlrYzF" } } + }, + "description": "List waiting rooms response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/response_collection-AZRlrYzF" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List waiting rooms response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List waiting rooms", + "tags": ["Waiting Room"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + }, + "post": { + "description": "Creates a new waiting room.", + "operationId": "waiting-room-create-waiting-room", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-fzl1amog" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/query_waitingroom" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response-ZvEjOvIb" } } + }, + "description": "Create waiting room response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response-ZvEjOvIb" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create waiting room response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create waiting room", + "tags": ["Waiting Room"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/waiting_rooms/preview": { + "post": { + "description": "Creates a waiting room page preview. Upload a custom waiting room page for preview. You will receive a preview URL in the form `http://waitingrooms.dev/preview/\u003cuuid\u003e`. You can use the following query parameters to change the state of the preview:\n1. `force_queue`: Boolean indicating if all users will be queued in the waiting room and no one will be let into the origin website (also known as queueAll).\n2. `queue_is_full`: Boolean indicating if the waiting room's queue is currently full and not accepting new users at the moment.\n3. `queueing_method`: The queueing method currently used by the waiting room.\n\t- **fifo** indicates a FIFO queue.\n\t- **random** indicates a Random queue.\n\t- **passthrough** indicates a Passthrough queue. Keep in mind that the waiting room page will only be displayed if `force_queue=true` or `event=prequeueing` — for other cases the request will pass through to the origin. For our preview, this will be a fake origin website returning \"Welcome\". \n\t- **reject** indicates a Reject queue.\n4. `event`: Used to preview a waiting room event.\n\t- **none** indicates no event is occurring.\n\t- **prequeueing** indicates that an event is prequeueing (between `prequeue_start_time` and `event_start_time`).\n\t- **started** indicates that an event has started (between `event_start_time` and `event_end_time`).\n5. `shuffle_at_event_start`: Boolean indicating if the event will shuffle users in the prequeue when it starts. This can only be set to **true** if an event is active (`event` is not **none**).\n\nFor example, you can make a request to `http://waitingrooms.dev/preview/\u003cuuid\u003e?force_queue=false\u0026queue_is_full=false\u0026queueing_method=random\u0026event=started\u0026shuffle_at_event_start=true`\n6. `waitTime`: Non-zero, positive integer indicating the estimated wait time in minutes. The default value is 10 minutes.\n\nFor example, you can make a request to `http://waitingrooms.dev/preview/\u003cuuid\u003e?waitTime=50` to configure the estimated wait time as 50 minutes.", + "operationId": "waiting-room-create-a-custom-waiting-room-page-preview", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-fzl1amog" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/query_preview" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/preview_response" } } }, + "description": "Create a custom waiting room page preview response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/preview_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create a custom waiting room page preview response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create a custom waiting room page preview", + "tags": ["Waiting Room"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}": { + "delete": { + "description": "Deletes a waiting room.", + "operationId": "waiting-room-delete-waiting-room", + "parameters": [ + { + "in": "path", + "name": "waiting_room_id", + "required": true, + "schema": { "$ref": "#/components/schemas/waiting_room_id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-fzl1amog" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/waiting_room_id_response" } } + }, + "description": "Delete waiting room response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/waiting_room_id_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete waiting room response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete waiting room", + "tags": ["Waiting Room"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + }, + "get": { + "description": "Fetches a single configured waiting room.", + "operationId": "waiting-room-waiting-room-details", + "parameters": [ + { + "in": "path", + "name": "waiting_room_id", + "required": true, + "schema": { "$ref": "#/components/schemas/waiting_room_id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-fzl1amog" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response-ZvEjOvIb" } } + }, + "description": "Waiting room details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response-ZvEjOvIb" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Waiting room details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Waiting room details", + "tags": ["Waiting Room"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + }, + "patch": { + "description": "Patches a configured waiting room.", + "operationId": "waiting-room-patch-waiting-room", + "parameters": [ + { + "in": "path", + "name": "waiting_room_id", + "required": true, + "schema": { "$ref": "#/components/schemas/waiting_room_id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-fzl1amog" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/query_waitingroom" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response-ZvEjOvIb" } } + }, + "description": "Patch waiting room response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response-ZvEjOvIb" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Patch waiting room response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Patch waiting room", + "tags": ["Waiting Room"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + }, + "put": { + "description": "Updates a configured waiting room.", + "operationId": "waiting-room-update-waiting-room", + "parameters": [ + { + "in": "path", + "name": "waiting_room_id", + "required": true, + "schema": { "$ref": "#/components/schemas/waiting_room_id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-fzl1amog" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/query_waitingroom" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response-ZvEjOvIb" } } + }, + "description": "Update waiting room response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response-ZvEjOvIb" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update waiting room response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update waiting room", + "tags": ["Waiting Room"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events": { + "get": { + "description": "Lists events for a waiting room.", + "operationId": "waiting-room-list-events", + "parameters": [ + { + "in": "path", + "name": "waiting_room_id", + "required": true, + "schema": { "$ref": "#/components/schemas/waiting_room_id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-fzl1amog" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/event_response_collection" } } + }, + "description": "List events response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/event_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List events response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List events", + "tags": ["Waiting Room"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "post": { + "description": "Only available for the Waiting Room Advanced subscription. Creates an event for a waiting room. An event takes place during a specified period of time, temporarily changing the behavior of a waiting room. While the event is active, some of the properties in the event's configuration may either override or inherit from the waiting room's configuration. Note that events cannot overlap with each other, so only one event can be active at a time.", + "operationId": "waiting-room-create-event", + "parameters": [ + { + "in": "path", + "name": "waiting_room_id", + "required": true, + "schema": { "$ref": "#/components/schemas/waiting_room_id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-fzl1amog" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/query_event" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/event_response" } } }, + "description": "Create event response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/event_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create event response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create event", + "tags": ["Waiting Room"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events/{event_id}": { + "delete": { + "description": "Deletes an event for a waiting room.", + "operationId": "waiting-room-delete-event", + "parameters": [ + { "in": "path", "name": "event_id", "required": true, "schema": { "$ref": "#/components/schemas/event_id" } }, + { + "in": "path", + "name": "waiting_room_id", + "required": true, + "schema": { "$ref": "#/components/schemas/waiting_room_id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-fzl1amog" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/event_id_response" } } }, + "description": "Delete event response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/event_id_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete event response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete event", + "tags": ["Waiting Room"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "get": { + "description": "Fetches a single configured event for a waiting room.", + "operationId": "waiting-room-event-details", + "parameters": [ + { "in": "path", "name": "event_id", "required": true, "schema": { "$ref": "#/components/schemas/event_id" } }, + { + "in": "path", + "name": "waiting_room_id", + "required": true, + "schema": { "$ref": "#/components/schemas/waiting_room_id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-fzl1amog" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/event_response" } } }, + "description": "Event details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/event_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Event details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Event details", + "tags": ["Waiting Room"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "patch": { + "description": "Patches a configured event for a waiting room.", + "operationId": "waiting-room-patch-event", + "parameters": [ + { "in": "path", "name": "event_id", "required": true, "schema": { "$ref": "#/components/schemas/event_id" } }, + { + "in": "path", + "name": "waiting_room_id", + "required": true, + "schema": { "$ref": "#/components/schemas/waiting_room_id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-fzl1amog" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/query_event" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/event_response" } } }, + "description": "Patch event response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/event_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Patch event response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Patch event", + "tags": ["Waiting Room"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "put": { + "description": "Updates a configured event for a waiting room.", + "operationId": "waiting-room-update-event", + "parameters": [ + { "in": "path", "name": "event_id", "required": true, "schema": { "$ref": "#/components/schemas/event_id" } }, + { + "in": "path", + "name": "waiting_room_id", + "required": true, + "schema": { "$ref": "#/components/schemas/waiting_room_id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-fzl1amog" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/query_event" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/event_response" } } }, + "description": "Update event response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/event_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update event response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update event", + "tags": ["Waiting Room"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events/{event_id}/details": { + "get": { + "description": "Previews an event's configuration as if it was active. Inherited fields from the waiting room will be displayed with their current values.", + "operationId": "waiting-room-preview-active-event-details", + "parameters": [ + { "in": "path", "name": "event_id", "required": true, "schema": { "$ref": "#/components/schemas/event_id" } }, + { + "in": "path", + "name": "waiting_room_id", + "required": true, + "schema": { "$ref": "#/components/schemas/waiting_room_id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-fzl1amog" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/event_details_response" } } }, + "description": "Preview active event details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/event_details_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Preview active event details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Preview active event details", + "tags": ["Waiting Room"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/rules": { + "get": { + "description": "Lists rules for a waiting room.", + "operationId": "waiting-room-list-waiting-room-rules", + "parameters": [ + { + "in": "path", + "name": "waiting_room_id", + "required": true, + "schema": { "$ref": "#/components/schemas/waiting_room_id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-fzl1amog" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/rules_response_collection" } } + }, + "description": "List Waiting Room Rules response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/rules_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Waiting Room Rules response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Waiting Room Rules", + "tags": ["Waiting Room"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "post": { + "description": "Only available for the Waiting Room Advanced subscription. Creates a rule for a waiting room.", + "operationId": "waiting-room-create-waiting-room-rule", + "parameters": [ + { + "in": "path", + "name": "waiting_room_id", + "required": true, + "schema": { "$ref": "#/components/schemas/waiting_room_id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-fzl1amog" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_rule" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/rules_response_collection" } } + }, + "description": "Create Waiting Room Rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/rules_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Waiting Room Rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Waiting Room Rule", + "tags": ["Waiting Room"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "put": { + "description": "Only available for the Waiting Room Advanced subscription. Replaces all rules for a waiting room.", + "operationId": "waiting-room-replace-waiting-room-rules", + "parameters": [ + { + "in": "path", + "name": "waiting_room_id", + "required": true, + "schema": { "$ref": "#/components/schemas/waiting_room_id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-fzl1amog" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_rules" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/rules_response_collection" } } + }, + "description": "Replace Waiting Room Rules response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/rules_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Replace Waiting Room Rules response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Replace Waiting Room Rules", + "tags": ["Waiting Room"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/rules/{rule_id}": { + "delete": { + "description": "Deletes a rule for a waiting room.", + "operationId": "waiting-room-delete-waiting-room-rule", + "parameters": [ + { "in": "path", "name": "rule_id", "required": true, "schema": { "$ref": "#/components/schemas/rule_id" } }, + { + "in": "path", + "name": "waiting_room_id", + "required": true, + "schema": { "$ref": "#/components/schemas/waiting_room_id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-fzl1amog" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/rules_response_collection" } } + }, + "description": "Delete Waiting Room Rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/rules_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Waiting Room Rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Waiting Room Rule", + "tags": ["Waiting Room"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "patch": { + "description": "Patches a rule for a waiting room.", + "operationId": "waiting-room-patch-waiting-room-rule", + "parameters": [ + { "in": "path", "name": "rule_id", "required": true, "schema": { "$ref": "#/components/schemas/rule_id" } }, + { + "in": "path", + "name": "waiting_room_id", + "required": true, + "schema": { "$ref": "#/components/schemas/waiting_room_id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-fzl1amog" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/patch_rule" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/rules_response_collection" } } + }, + "description": "Patch Waiting Room Rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/rules_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Patch Waiting Room Rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Patch Waiting Room Rule", + "tags": ["Waiting Room"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/status": { + "get": { + "description": "Fetches the status of a configured waiting room. Response fields include:\n1. `status`: String indicating the status of the waiting room. The possible status are:\n\t- **not_queueing** indicates that the configured thresholds have not been met and all users are going through to the origin.\n\t- **queueing** indicates that the thresholds have been met and some users are held in the waiting room.\n\t- **event_prequeueing** indicates that an event is active and is currently prequeueing users before it starts.\n2. `event_id`: String of the current event's `id` if an event is active, otherwise an empty string.\n3. `estimated_queued_users`: Integer of the estimated number of users currently waiting in the queue.\n4. `estimated_total_active_users`: Integer of the estimated number of users currently active on the origin.\n5. `max_estimated_time_minutes`: Integer of the maximum estimated time currently presented to the users.", + "operationId": "waiting-room-get-waiting-room-status", + "parameters": [ + { + "in": "path", + "name": "waiting_room_id", + "required": true, + "schema": { "$ref": "#/components/schemas/waiting_room_id" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-fzl1amog" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/status_response" } } }, + "description": "Get waiting room status response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/status_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get waiting room status response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get waiting room status", + "tags": ["Waiting Room"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/web3/hostnames": { + "get": { + "operationId": "web3-hostname-list-web3-hostnames", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-collection_response" } + } + }, + "description": "List Web3 Hostnames response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-collection_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Web3 Hostnames response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Web3 Hostnames", + "tags": ["Web3 Hostname"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "post": { + "operationId": "web3-hostname-create-web3-hostname", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_request" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/web3-hostname_components-schemas-single_response" } + } + }, + "description": "Create Web3 Hostname response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/web3-hostname_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Web3 Hostname response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Web3 Hostname", + "tags": ["Web3 Hostname"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/web3/hostnames/{identifier}": { + "delete": { + "operationId": "web3-hostname-delete-web3-hostname", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single-id-u7jsvBJu" } } + }, + "description": "Delete Web3 Hostname response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single-id-u7jsvBJu" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Web3 Hostname response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Web3 Hostname", + "tags": ["Web3 Hostname"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "get": { + "operationId": "web3-hostname-web3-hostname-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/web3-hostname_components-schemas-single_response" } + } + }, + "description": "Web3 Hostname Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/web3-hostname_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Web3 Hostname Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Web3 Hostname Details", + "tags": ["Web3 Hostname"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "operationId": "web3-hostname-edit-web3-hostname", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/modify_request" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/web3-hostname_components-schemas-single_response" } + } + }, + "description": "Edit Web3 Hostname response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/web3-hostname_components-schemas-single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Edit Web3 Hostname response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Edit Web3 Hostname", + "tags": ["Web3 Hostname"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list": { + "get": { + "operationId": "web3-hostname-ipfs-universal-path-gateway-content-list-details", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/content_list_details_response" } } + }, + "description": "IPFS Universal Path Gateway Content List Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/content_list_details_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "IPFS Universal Path Gateway Content List Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "IPFS Universal Path Gateway Content List Details", + "tags": ["Web3 Hostname"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "put": { + "operationId": "web3-hostname-update-ipfs-universal-path-gateway-content-list", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/content_list_update_request" } } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/content_list_details_response" } } + }, + "description": "Update IPFS Universal Path Gateway Content List response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/content_list_details_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update IPFS Universal Path Gateway Content List response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update IPFS Universal Path Gateway Content List", + "tags": ["Web3 Hostname"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries": { + "get": { + "operationId": "web3-hostname-list-ipfs-universal-path-gateway-content-list-entries", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/content_list_entry_collection_response" } + } + }, + "description": "List IPFS Universal Path Gateway Content List Entries response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/content_list_entry_collection_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List IPFS Universal Path Gateway Content List Entries response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List IPFS Universal Path Gateway Content List Entries", + "tags": ["Web3 Hostname"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "post": { + "operationId": "web3-hostname-create-ipfs-universal-path-gateway-content-list-entry", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/content_list_entry_create_request" } } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/content_list_entry_single_response" } } + }, + "description": "Create IPFS Universal Path Gateway Content List Entry response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/content_list_entry_single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create IPFS Universal Path Gateway Content List Entry response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create IPFS Universal Path Gateway Content List Entry", + "tags": ["Web3 Hostname"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries/{content_list_entry_identifier}": { + "delete": { + "operationId": "web3-hostname-delete-ipfs-universal-path-gateway-content-list-entry", + "parameters": [ + { + "in": "path", + "name": "content_list_entry_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single-id-u7jsvBJu" } } + }, + "description": "Delete IPFS Universal Path Gateway Content List Entry response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single-id-u7jsvBJu" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete IPFS Universal Path Gateway Content List Entry response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete IPFS Universal Path Gateway Content List Entry", + "tags": ["Web3 Hostname"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "get": { + "operationId": "web3-hostname-ipfs-universal-path-gateway-content-list-entry-details", + "parameters": [ + { + "in": "path", + "name": "content_list_entry_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/content_list_entry_single_response" } } + }, + "description": "IPFS Universal Path Gateway Content List Entry Details response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/content_list_entry_single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "IPFS Universal Path Gateway Content List Entry Details response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "IPFS Universal Path Gateway Content List Entry Details", + "tags": ["Web3 Hostname"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "put": { + "operationId": "web3-hostname-edit-ipfs-universal-path-gateway-content-list-entry", + "parameters": [ + { + "in": "path", + "name": "content_list_entry_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/content_list_entry_create_request" } } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/content_list_entry_single_response" } } + }, + "description": "Edit IPFS Universal Path Gateway Content List Entry response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/content_list_entry_single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Edit IPFS Universal Path Gateway Content List Entry response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Edit IPFS Universal Path Gateway Content List Entry", + "tags": ["Web3 Hostname"], + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_identifier}/workers/script": { + "delete": { + "deprecated": true, + "description": "Delete your worker. This call has no response body on a successful delete.", + "operationId": "worker-script-(-deprecated)-delete-worker", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { "content": { "application/json": {} }, "description": "Delete Worker response" }, + "4xx": { "content": { "application/json": {} }, "description": "Delete Worker response failure" } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Worker", + "tags": ["Worker Script (Deprecated)"], + "x-cfDeprecation": { + "description": "This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs. These APIs are for use with the previously limited single-script zones.", + "display": true, + "id": "worker_script_deprecation" + } + }, + "get": { + "deprecated": true, + "description": "Fetch raw script content for your worker. Note this is the original script content, not JSON encoded.", + "operationId": "worker-script-(-deprecated)-download-worker", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "undefined": { + "schema": { + "example": "addEventListener('fetch', event =\u003e { event.respondWith(fetch(event.request)) })" + } + } + }, + "description": "Download Worker response" + }, + "4xx": { + "content": { + "undefined": { + "schema": { + "example": "addEventListener('fetch', event =\u003e { event.respondWith(fetch(event.request)) })" + } + } + }, + "description": "Download Worker response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Download Worker", + "tags": ["Worker Script (Deprecated)"], + "x-cfDeprecation": { + "description": "This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs. These APIs are for use with the previously limited single-script zones.", + "display": true, + "id": "worker_script_deprecation" + } + }, + "put": { + "deprecated": true, + "description": "Upload a worker, or a new version of a worker.", + "operationId": "worker-script-(-deprecated)-upload-worker", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/javascript": { + "schema": { + "example": "addEventListener('fetch', event =\u003e { event.respondWith(fetch(event.request)) })" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/script-response-single-qkojssqp" } } + }, + "description": "Upload Worker response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/script-response-single-qkojssqp" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Upload Worker response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Upload Worker", + "tags": ["Worker Script (Deprecated)"], + "x-cfDeprecation": { + "description": "This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs. These APIs are for use with the previously limited single-script zones.", + "display": true, + "id": "worker_script_deprecation" + } + } + }, + "/zones/{zone_identifier}/workers/script/bindings": { + "get": { + "deprecated": true, + "description": "List the bindings for a Workers script.", + "operationId": "worker-binding-(-deprecated)-list-bindings", + "parameters": [ + { + "in": "path", + "name": "zone_identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/binding" }, "type": "array" } + }, + "type": "object" + } + ] + } + } + }, + "description": "List Bindings response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-common" }, + { + "properties": { + "result": { "items": { "$ref": "#/components/schemas/binding" }, "type": "array" } + }, + "type": "object" + } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Bindings response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Bindings", + "tags": ["Worker Binding (Deprecated)"], + "x-cfDeprecation": { + "description": "This endpoint and its related APIs are deprecated in favor of the `/accounts` equivalent APIs. These APIs are for use with the previously limited single-script zones.", + "display": true, + "id": "worker_binding_deprecation" + } + } + }, + "/zones/{zone_id}/activation_check": { + "put": { + "description": "Triggeres a new activation check for a PENDING Zone. This can be\ntriggered every 5 min for paygo/ent customers, every hour for FREE\nZones.", + "operationId": "put-zones-zone_id-activation_check", + "parameters": [ + { + "description": "Zone ID", + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-JiolAARC" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { "id": { "$ref": "#/components/schemas/identifier-JiolAARC" } }, + "type": "object" + } + }, + "type": "object" + } + ] + } + } + }, + "description": "Successful Response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { "allOf": [{ "$ref": "#/components/schemas/api-response-common-failure" }] } + } + }, + "description": "Client Error" + } + }, + "summary": "Rerun the Activation Check", + "tags": ["Client"] + } + }, + "/zones/{zone_id}/api_gateway/configuration": { + "get": { + "operationId": "api-shield-settings-retrieve-information-about-specific-configuration-properties", + "parameters": [ + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { "in": "query", "name": "properties", "schema": { "$ref": "#/components/schemas/properties" } } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/single_response-lMJq2fgM" } } + }, + "description": "Retrieve information about specific configuration properties response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/single_response-lMJq2fgM" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Retrieve information about specific configuration properties response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Retrieve information about specific configuration properties", + "tags": ["API Shield Settings"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.api-gateway.read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "put": { + "operationId": "api-shield-settings-set-configuration-properties", + "parameters": [ + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/configuration" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/default_response" } } }, + "description": "Set configuration properties response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/default_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Set configuration properties response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Set configuration properties", + "tags": ["API Shield Settings"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.api-gateway.update"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_id}/api_gateway/discovery": { + "get": { + "description": "Retrieve the most up to date view of API Discovery on a zone.", + "operationId": "api-shield-endpoint-management-retrieve-api-discovery-results-for-a-zone", + "parameters": [ + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schema_response_discovery" } } + }, + "description": "Retrieve API Discovery results for a zone response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schema_response_discovery" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Retrieve API Discovery results for a zone response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Retrieve API Discovery results for a zone", + "tags": ["API Shield Endpoint Management"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.api-gateway.read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_id}/api_gateway/operations": { + "get": { + "operationId": "api-shield-endpoint-management-retrieve-information-about-all-operations-on-a-zone", + "parameters": [ + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { "in": "query", "name": "per_page", "schema": { "$ref": "#/components/schemas/per_page" } }, + { + "in": "query", + "name": "order", + "schema": { + "description": "Field to order by. When requesting a feature, the feature keys are available for ordering as well, e.g., thresholds.suggested_threshold.", + "enum": ["method", "host", "endpoint", "thresholds.$key"], + "example": "method", + "type": "string" + } + }, + { + "in": "query", + "name": "host", + "schema": { + "description": "Filter results to only include the specified hosts.", + "items": { "example": "api.cloudflare.com", "type": "string" }, + "type": "array", + "uniqueItems": true + } + }, + { + "in": "query", + "name": "method", + "schema": { + "description": "Filter results to only include the specified HTTP methods.", + "items": { "example": "GET", "type": "string" }, + "type": "array", + "uniqueItems": true + } + }, + { + "in": "query", + "name": "endpoint", + "schema": { + "description": "Filter results to only include endpoints containing this pattern.", + "example": "/api/v1", + "type": "string" + } + }, + { + "in": "query", + "name": "page", + "schema": { + "default": 1, + "description": "Page number of paginated results.", + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "feature", + "schema": { + "description": "Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.", + "example": ["thresholds"], + "items": { "enum": ["thresholds", "parameter_schemas"], "example": "thresholds", "type": "string" }, + "type": "array", + "uniqueItems": true + } + }, + { + "in": "query", + "name": "direction", + "schema": { + "description": "Direction to order results.", + "enum": ["asc", "desc"], + "example": "desc", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/collection_response_paginated" } } + }, + "description": "Retrieve information about all operations on a zone response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/collection_response_paginated" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Retrieve information about all operations on a zone response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Retrieve information about all operations on a zone", + "tags": ["API Shield Endpoint Management"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.api-gateway.read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "post": { + "description": "Add one or more operations to a zone. Endpoints can contain path variables. Host, method, endpoint will be normalized to a canoncial form when creating an operation and must be unique on the zone. Inserting an operation that matches an existing one will return the record of the already existing operation and update its last_updated date.", + "operationId": "api-shield-endpoint-management-add-operations-to-a-zone", + "parameters": [ + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "items": { + "properties": { + "endpoint": { "$ref": "#/components/schemas/endpoint" }, + "host": { "$ref": "#/components/schemas/host-nm3Leu3G" }, + "method": { "$ref": "#/components/schemas/method" } + }, + "type": "object" + }, + "required": ["host", "method", "endpoint"], + "type": "array" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/collection_response" } } }, + "description": "Add operations to a zone response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/collection_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Add operations to a zone response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Add operations to a zone", + "tags": ["API Shield Endpoint Management"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.api-gateway.create"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_id}/api_gateway/operations/{operation_id}": { + "delete": { + "operationId": "api-shield-endpoint-management-delete-an-operation", + "parameters": [ + { + "in": "path", + "name": "operation_id", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-s0SXln0q" } + }, + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/default_response" } } }, + "description": "Delete an operation response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/default_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete an operation response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete an operation", + "tags": ["API Shield Endpoint Management"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.api-gateway.delete"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + }, + "get": { + "operationId": "api-shield-endpoint-management-retrieve-information-about-an-operation", + "parameters": [ + { + "in": "path", + "name": "operation_id", + "required": true, + "schema": { "$ref": "#/components/schemas/uuid-s0SXln0q" } + }, + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "query", + "name": "feature", + "schema": { + "description": "Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.", + "example": ["thresholds"], + "items": { "enum": ["thresholds", "parameter_schemas"], "example": "thresholds", "type": "string" }, + "type": "array", + "uniqueItems": true + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schemas-single_response-h7shsYQI" } } + }, + "description": "Retrieve information about an operation response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-single_response-h7shsYQI" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Retrieve information about an operation response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Retrieve information about an operation", + "tags": ["API Shield Endpoint Management"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.api-gateway.read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_id}/api_gateway/schemas": { + "get": { + "operationId": "api-shield-endpoint-management-retrieve-operations-and-features-as-open-api-schemas", + "parameters": [ + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "query", + "name": "host", + "schema": { + "description": "Receive schema only for the given host(s).", + "items": { "example": "www.example.com", "type": "string" }, + "type": "array", + "uniqueItems": true + } + }, + { + "in": "query", + "name": "feature", + "schema": { + "description": "Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.", + "example": ["thresholds"], + "items": { "enum": ["thresholds", "parameter_schemas"], "example": "thresholds", "type": "string" }, + "type": "array", + "uniqueItems": true + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/schema_response_with_thresholds" } } + }, + "description": "Retrieve operations and features as OpenAPI schemas response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schema_response_with_thresholds" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Retrieve operations and features as OpenAPI schemas response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Retrieve operations and features as OpenAPI schemas", + "tags": ["API Shield Endpoint Management"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.api.account.zone.api-gateway.read"] }, + "x-cfPlanAvailability": { "business": false, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_id}/firewall/access_rules/rules": { + "get": { + "description": "Fetches IP Access rules of a zone. You can filter the results using several optional parameters.", + "operationId": "ip-access-rules-for-a-zone-list-ip-access-rules", + "parameters": [ + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { "in": "query", "name": "filters", "schema": { "$ref": "#/components/schemas/schemas-filters" } }, + { "in": "query", "name": "egs-pagination.json", "schema": { "$ref": "#/components/schemas/egs-pagination" } }, + { + "in": "query", + "name": "page", + "schema": { + "description": "Requested page within paginated list of results.", + "example": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { "description": "Maximum number of results requested.", "example": 20, "type": "number" } + }, + { + "in": "query", + "name": "order", + "schema": { + "description": "The field used to sort returned rules.", + "enum": ["configuration.target", "configuration.value", "mode"], + "example": "mode", + "type": "string" + } + }, + { + "in": "query", + "name": "direction", + "schema": { + "description": "The direction used to sort returned rules.", + "enum": ["asc", "desc"], + "example": "desc", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/rule_collection_response" } } + }, + "description": "List IP Access rules response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/rule_collection_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List IP Access rules response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List IP Access rules", + "tags": ["IP Access rules for a zone"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "post": { + "description": "Creates a new IP Access rule for a zone.\n\nNote: To create an IP Access rule that applies to multiple zones, refer to [IP Access rules for a user](#ip-access-rules-for-a-user) or [IP Access rules for an account](#ip-access-rules-for-an-account) as appropriate.", + "operationId": "ip-access-rules-for-a-zone-create-an-ip-access-rule", + "parameters": [ + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "configuration": { "$ref": "#/components/schemas/schemas-configuration" }, + "mode": { "$ref": "#/components/schemas/schemas-mode" }, + "notes": { "$ref": "#/components/schemas/notes" } + }, + "required": ["mode", "configuration", "notes"] + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rule_single_response" } } }, + "description": "Create an IP Access rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/rule_single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create an IP Access rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create an IP Access rule", + "tags": ["IP Access rules for a zone"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_id}/firewall/access_rules/rules/{identifier}": { + "delete": { + "description": "Deletes an IP Access rule defined at the zone level.\n\nOptionally, you can use the `cascade` property to specify that you wish to delete similar rules in other zones managed by the same zone owner.", + "operationId": "ip-access-rules-for-a-zone-delete-an-ip-access-rule", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/rule_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "cascade": { + "default": "none", + "description": "The level to attempt to delete similar rules defined for other zones with the same owner. The default value is `none`, which will only delete the current rule. Using `basic` will delete rules that match the same action (mode) and configuration, while using `aggressive` will delete rules that match the same configuration.", + "enum": ["none", "basic", "aggressive"], + "type": "string" + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rule_single_id_response" } } }, + "description": "Delete an IP Access rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/rule_single_id_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete an IP Access rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete an IP Access rule", + "tags": ["IP Access rules for a zone"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Updates an IP Access rule defined at the zone level. You can only update the rule action (`mode` parameter) and notes.", + "operationId": "ip-access-rules-for-a-zone-update-an-ip-access-rule", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/rule_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "mode": { "$ref": "#/components/schemas/schemas-mode" }, + "notes": { "$ref": "#/components/schemas/notes" } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rule_single_response" } } }, + "description": "Update an IP Access rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/rule_single_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update an IP Access rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update an IP Access rule", + "tags": ["IP Access rules for a zone"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_id}/firewall/waf/packages/{package_id}/rules": { + "get": { + "description": "Fetches WAF rules in a WAF package.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).", + "operationId": "waf-rules-list-waf-rules", + "parameters": [ + { + "in": "path", + "name": "package_id", + "required": true, + "schema": { "$ref": "#/components/schemas/package_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "query", + "name": "mode", + "schema": { + "description": "The action/mode a rule has been overridden to perform.", + "enum": ["DIS", "CHL", "BLK", "SIM"], + "example": "CHL", + "type": "string" + } + }, + { + "in": "query", + "name": "group_id", + "schema": { "$ref": "#/components/schemas/group_components-schemas-identifier" } + }, + { + "in": "query", + "name": "page", + "schema": { + "default": 1, + "description": "The page number of paginated results.", + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { + "default": 50, + "description": "The number of rules per page.", + "maximum": 100, + "minimum": 5, + "type": "number" + } + }, + { + "in": "query", + "name": "order", + "schema": { + "description": "The field used to sort returned rules.", + "enum": ["priority", "group_id", "description"], + "example": "status", + "type": "string" + } + }, + { + "in": "query", + "name": "direction", + "schema": { + "description": "The direction used to sort returned rules.", + "enum": ["asc", "desc"], + "example": "desc", + "type": "string" + } + }, + { + "in": "query", + "name": "match", + "schema": { + "default": "all", + "description": "When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match.", + "enum": ["any", "all"], + "type": "string" + } + }, + { + "in": "query", + "name": "description", + "schema": { + "description": "The public description of the WAF rule.", + "example": "SQL injection prevention for SELECT statements", + "readOnly": true, + "type": "string" + } + }, + { + "in": "query", + "name": "priority", + "schema": { + "description": "The order in which the individual WAF rule is executed within its rule group.", + "readOnly": true, + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/rule_response_collection" } } + }, + "description": "List WAF rules response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/rule_response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List WAF rules response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List WAF rules", + "tags": ["WAF rules"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + } + }, + "/zones/{zone_id}/firewall/waf/packages/{package_id}/rules/{identifier}": { + "get": { + "description": "Fetches the details of a WAF rule in a WAF package.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).", + "operationId": "waf-rules-get-a-waf-rule", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/rule_components-schemas-identifier-2" } + }, + { + "in": "path", + "name": "package_id", + "required": true, + "schema": { "$ref": "#/components/schemas/package_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rule_response_single" } } }, + "description": "Get a WAF rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/rule_response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get a WAF rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a WAF rule", + "tags": ["WAF rules"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + }, + "patch": { + "description": "Updates a WAF rule. You can only update the mode/action of the rule.\n\n**Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).", + "operationId": "waf-rules-update-a-waf-rule", + "parameters": [ + { + "in": "path", + "name": "identifier", + "required": true, + "schema": { "$ref": "#/components/schemas/rule_components-schemas-identifier-2" } + }, + { + "in": "path", + "name": "package_id", + "required": true, + "schema": { "$ref": "#/components/schemas/package_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "mode": { + "description": "The mode/action of the rule when triggered. You must use a value from the `allowed_modes` array of the current rule.", + "enum": ["default", "disable", "simulate", "block", "challenge", "on", "off"], + "example": "on" + } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/rule_response_single" }, + { + "properties": { + "result": { + "oneOf": [ + { "$ref": "#/components/schemas/anomaly_rule" }, + { "$ref": "#/components/schemas/traditional_deny_rule" }, + { "$ref": "#/components/schemas/traditional_allow_rule" } + ] + } + } + } + ] + } + } + }, + "description": "Update a WAF rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/rule_response_single" }, + { + "properties": { + "result": { + "oneOf": [ + { "$ref": "#/components/schemas/anomaly_rule" }, + { "$ref": "#/components/schemas/traditional_deny_rule" }, + { "$ref": "#/components/schemas/traditional_allow_rule" } + ] + } + } + } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update a WAF rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update a WAF rule", + "tags": ["WAF rules"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + } + }, + "/zones/{zone_id}/managed_headers": { + "get": { + "description": "Fetches a list of all Managed Transforms.", + "operationId": "managed-transforms-list-managed-transforms", + "parameters": [ + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "managed_request_headers": { "$ref": "#/components/schemas/request_list" }, + "managed_response_headers": { "$ref": "#/components/schemas/request_list" } + }, + "type": "object" + } + } + }, + "description": "List Managed Transforms response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "properties": { + "managed_request_headers": { "$ref": "#/components/schemas/request_list" }, + "managed_response_headers": { "$ref": "#/components/schemas/request_list" } + }, + "type": "object" + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Managed Transforms response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Managed Transforms", + "tags": ["Managed Transforms"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Updates the status of one or more Managed Transforms.", + "operationId": "managed-transforms-update-status-of-managed-transforms", + "parameters": [ + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "managed_request_headers": { "$ref": "#/components/schemas/request_list" }, + "managed_response_headers": { "$ref": "#/components/schemas/request_list" } + }, + "required": ["managed_request_headers", "managed_response_headers"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "properties": { + "managed_request_headers": { "$ref": "#/components/schemas/response_list" }, + "managed_response_headers": { "$ref": "#/components/schemas/response_list" } + }, + "type": "object" + } + } + }, + "description": "Update status of Managed Transforms response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "properties": { + "managed_request_headers": { "$ref": "#/components/schemas/response_list" }, + "managed_response_headers": { "$ref": "#/components/schemas/response_list" } + }, + "type": "object" + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update status of Managed Transforms response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update status of Managed Transforms", + "tags": ["Managed Transforms"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_id}/page_shield": { + "get": { + "description": "Fetches the Page Shield settings.", + "operationId": "page-shield-get-page-shield-settings", + "parameters": [ + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-jnfvAiHn" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single" }, + { "properties": { "result": { "$ref": "#/components/schemas/get-zone-settings-response" } } } + ] + } + } + }, + "description": "Get Page Shield settings response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single" }, + { "properties": { "result": { "$ref": "#/components/schemas/get-zone-settings-response" } } } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Page Shield settings response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Page Shield settings", + "tags": ["Page Shield"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + }, + "put": { + "description": "Updates Page Shield settings.", + "operationId": "page-shield-update-page-shield-settings", + "parameters": [ + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-jnfvAiHn" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "enabled": { "$ref": "#/components/schemas/enabled-N6CliIvj" }, + "use_cloudflare_reporting_endpoint": { + "$ref": "#/components/schemas/use_cloudflare_reporting_endpoint" + }, + "use_connection_url_path": { "$ref": "#/components/schemas/use_connection_url_path" } + } + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single" }, + { "properties": { "result": { "$ref": "#/components/schemas/update-zone-settings-response" } } } + ] + } + } + }, + "description": "Update Page Shield settings response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/zone_settings_response_single" }, + { "properties": { "result": { "$ref": "#/components/schemas/update-zone-settings-response" } } } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Page Shield settings response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Page Shield settings", + "tags": ["Page Shield"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + } + }, + "/zones/{zone_id}/page_shield/connections": { + "get": { + "description": "Lists all connections detected by Page Shield.", + "operationId": "page-shield-list-page-shield-connections", + "parameters": [ + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-jnfvAiHn" } + }, + { + "in": "query", + "name": "exclude_urls", + "schema": { + "description": "Excludes connections whose URL contains one the URL-encoded URL substrings (separated by commas) from the returned connections.", + "example": "blog.cloudflare.com,www.example", + "type": "string" + } + }, + { + "in": "query", + "name": "urls", + "schema": { + "description": "Filters the returned connections by one or more URL-encoded URL substrings separated by commas.", + "example": "blog.cloudflare.com,www.example", + "type": "string" + } + }, + { + "in": "query", + "name": "hosts", + "schema": { + "description": "Filters the returned connections by one or more URL-encoded hostname substrings separated by commas.", + "example": "blog.cloudflare.com,www.example", + "type": "string" + } + }, + { + "in": "query", + "name": "page", + "schema": { + "description": "The current page number of the paginated results.", + "example": 2, + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { + "description": "The number of results per page.", + "example": 100, + "maximum": 100, + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "order_by", + "schema": { + "description": "The field used to sort returned connections.", + "enum": ["first_seen_at", "last_seen_at"], + "example": "first_seen_at", + "type": "string" + } + }, + { + "in": "query", + "name": "direction", + "schema": { + "description": "The direction used to sort returned connections.", + "enum": ["asc", "desc"], + "example": "asc", + "type": "string" + } + }, + { + "in": "query", + "name": "prioritize_malicious", + "schema": { + "description": "When true, malicious connections appear first in the returned connections.", + "example": true, + "type": "boolean" + } + }, + { + "in": "query", + "name": "exclude_cdn_cgi", + "schema": { + "description": "When true, excludes connections seen in a `/cdn-cgi` path from the returned connections. The default value is true.", + "example": true, + "type": "boolean" + } + }, + { + "in": "query", + "name": "status", + "schema": { + "description": "Filters the returned connections using a comma-separated list of connection statuses. Accepted values: `active`, `infrequent`, and `inactive`. The default value is `active`.", + "example": "active,inactive", + "type": "string" + } + }, + { + "in": "query", + "name": "page_url", + "schema": { + "description": "Filters the returned connections by the page URL where they were last seen.", + "example": "example.com/page", + "type": "string" + } + }, + { + "in": "query", + "name": "export", + "schema": { + "description": "Export the list of connections as a file. Cannot be used with per_page or page options.", + "enum": ["csv"], + "example": "csv", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/list-zone-connections-response" } } + }, + "description": "List Page Shield connections response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/list-zone-connections-response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Page Shield connections response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Page Shield connections", + "tags": ["Page Shield"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_id}/page_shield/connections/{id}": { + "get": { + "description": "Fetches a connection detected by Page Shield by connection ID.", + "operationId": "page-shield-get-a-page-shield-connection", + "parameters": [ + { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/id-ZJpijMo1" } }, + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-jnfvAiHn" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/get-zone-connection-response" } } + }, + "description": "Get a Page Shield connection response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/get-zone-connection-response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get a Page Shield connection response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a Page Shield connection", + "tags": ["Page Shield"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": false } + } + }, + "/zones/{zone_id}/page_shield/scripts": { + "get": { + "description": "Lists all scripts detected by Page Shield.", + "operationId": "page-shield-list-page-shield-scripts", + "parameters": [ + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-jnfvAiHn" } + }, + { + "in": "query", + "name": "exclude_urls", + "schema": { + "description": "Excludes scripts whose URL contains one the URL-encoded URL substrings (separated by commas) from the returned scripts.", + "example": "blog.cloudflare.com,www.example", + "type": "string" + } + }, + { + "in": "query", + "name": "urls", + "schema": { + "description": "Filters the returned scripts by one or more URL-encoded URL substrings separated by commas.", + "example": "blog.cloudflare.com,www.example", + "type": "string" + } + }, + { + "in": "query", + "name": "hosts", + "schema": { + "description": "Filters the returned scripts by one or more URL-encoded hostname substrings separated by commas.", + "example": "blog.cloudflare.com,www.example", + "type": "string" + } + }, + { + "in": "query", + "name": "page", + "schema": { + "description": "The current page number of the paginated results.", + "example": 2, + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { + "description": "The number of results per page.", + "example": 100, + "maximum": 100, + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "order_by", + "schema": { + "description": "The field used to sort returned scripts.", + "enum": ["first_seen_at", "last_seen_at"], + "example": "first_seen_at", + "type": "string" + } + }, + { + "in": "query", + "name": "direction", + "schema": { + "description": "The direction used to sort returned scripts.", + "enum": ["asc", "desc"], + "example": "asc", + "type": "string" + } + }, + { + "in": "query", + "name": "prioritize_malicious", + "schema": { + "description": "When true, malicious scripts appear first in the returned scripts.", + "example": true, + "type": "boolean" + } + }, + { + "in": "query", + "name": "exclude_cdn_cgi", + "schema": { + "description": "When true, excludes scripts seen in a `/cdn-cgi` path from the returned scripts. The default value is true.", + "example": true, + "type": "boolean" + } + }, + { + "in": "query", + "name": "status", + "schema": { + "description": "Filters the returned scripts using a comma-separated list of scripts statuses. Accepted values: `active`, `infrequent`, and `inactive`. The default value is `active`.", + "example": "active,inactive", + "type": "string" + } + }, + { + "in": "query", + "name": "page_url", + "schema": { + "description": "Filters the returned scripts by the page URL where they were last seen.", + "example": "example.com/page", + "type": "string" + } + }, + { + "in": "query", + "name": "export", + "schema": { + "description": "Export the list of scripts as a file. Cannot be used with per_page or page options.", + "enum": ["csv"], + "example": "csv", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/list-zone-scripts-response" } } + }, + "description": "List Page Shield scripts response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/list-zone-scripts-response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Page Shield scripts response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Page Shield scripts", + "tags": ["Page Shield"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + } + }, + "/zones/{zone_id}/page_shield/scripts/{id}": { + "get": { + "description": "Fetches a script detected by Page Shield by script ID.", + "operationId": "page-shield-get-a-page-shield-script", + "parameters": [ + { "in": "path", "name": "id", "required": true, "schema": { "$ref": "#/components/schemas/id-ZJpijMo1" } }, + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/identifier-jnfvAiHn" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/get-zone-script-response" } } + }, + "description": "Get a Page Shield script response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/get-zone-script-response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get a Page Shield script response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a Page Shield script", + "tags": ["Page Shield"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": false, "pro": true } + } + }, + "/zones/{zone_id}/rulesets": { + "get": { + "description": "Fetches all rulesets at the zone level.", + "operationId": "zone-rulesets-list-zone-rulesets", + "parameters": [ + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rulesets_response" } } }, + "description": "List zone rulesets response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/rulesets_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List zone rulesets response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List zone rulesets", + "tags": ["Zone Rulesets"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "post": { + "description": "Creates a ruleset at the zone level.", + "operationId": "zone-rulesets-create-a-zone-ruleset", + "parameters": [ + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_ruleset" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } }, + "description": "Create a zone ruleset response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/ruleset_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create a zone ruleset response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create a zone ruleset", + "tags": ["Zone Rulesets"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_id}/rulesets/phases/http_config_settings/entrypoint": { + "get": { + "description": "Fetches all Config Rules in a zone.", + "operationId": "config-rules-list-config-rules", + "parameters": [ + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/config-rules_components-schemas-ruleset" } + } + }, + "description": "List Config Rules response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/config-rules_components-schemas-ruleset" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Config Rules response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Config Rules", + "tags": ["Config Rules"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "put": { + "description": "Updates the Config Rules of a zone.", + "operationId": "config-rules-update-config-rules", + "parameters": [ + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_ruleset" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single" } } }, + "description": "Update Config Rules response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Config Rules response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Config Rules", + "tags": ["Config Rules"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_id}/rulesets/phases/http_custom_errors/entrypoint": { + "get": { + "description": "Fetches all Custom Error Responses in a zone.", + "operationId": "custom-error-responses-get-custom-error-responses", + "parameters": [ + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/custom-error-responses_components-schemas-ruleset" } + } + }, + "description": "Get Custom Error Responses response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/custom-error-responses_components-schemas-ruleset" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Custom Error Responses response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Custom Error Responses", + "tags": ["Custom Error Responses"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "put": { + "description": "Updates the Custom Error Responses of a zone.", + "operationId": "custom-error-responses-update-custom-error-responses", + "parameters": [ + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_ruleset" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single" } } }, + "description": "Update Custom Error Responses response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Custom Error Responses response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Custom Error Responses", + "tags": ["Custom Error Responses"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_id}/rulesets/phases/http_request_cache_settings/entrypoint": { + "get": { + "description": "Fetches all Cache Rules in a zone.", + "operationId": "cache-rules-list-cache-rules", + "parameters": [ + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/cache-rules_components-schemas-ruleset" } + } + }, + "description": "List Cache Rules response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/cache-rules_components-schemas-ruleset" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Cache Rules response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Cache Rules", + "tags": ["Cache Rules"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "put": { + "description": "Updates the Cache Rules of a zone.", + "operationId": "cache-rules-update-cache-rules", + "parameters": [ + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_ruleset" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single" } } }, + "description": "Update Cache Rules response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Cache Rules response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Cache Rules", + "tags": ["Cache Rules"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_id}/rulesets/phases/http_request_dynamic_redirect/entrypoint": { + "get": { + "description": "Fetches all Single Redirect Rules in a zone.", + "operationId": "single-redirect-rules-list-single-redirect-rules", + "parameters": [ + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/components-schemas-ruleset" } } + }, + "description": "List Single Redirect Rules response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-ruleset" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Single Redirect Rules response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Single Redirect Rules", + "tags": ["Single Redirect Rules"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "put": { + "description": "Updates the Single Redirect Rules of a zone.", + "operationId": "single-redirect-rules-update-single-redirect-rules", + "parameters": [ + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_ruleset" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single" } } }, + "description": "Update Single Redirect Rules response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Single Redirect Rules response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Single Redirect Rules", + "tags": ["Single Redirect Rules"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_id}/rulesets/phases/http_request_origin/entrypoint": { + "get": { + "description": "Fetches all Origin Rules in a zone.", + "operationId": "origin-rules-list-origin-rules", + "parameters": [ + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-ruleset" } } }, + "description": "List Origin Rules response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-ruleset" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Origin Rules response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Origin Rules", + "tags": ["Origin Rules"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "put": { + "description": "Updates the Origin Rules of a zone.", + "operationId": "origin-rules-update-origin-rules", + "parameters": [ + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_ruleset" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single" } } }, + "description": "Update Origin Rules response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Origin Rules response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Origin Rules", + "tags": ["Origin Rules"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint": { + "get": { + "description": "Fetches all Transform Rules in a zone.", + "operationId": "transform-rules-list-transform-rules", + "parameters": [ + { + "in": "path", + "name": "phase", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-phase" } + }, + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/transform-rules_components-schemas-ruleset" } + } + }, + "description": "List Transform Rules response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/transform-rules_components-schemas-ruleset" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Transform Rules response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Transform Rules", + "tags": ["Transform Rules"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "put": { + "description": "Updates the Transform Rules of a zone.", + "operationId": "transform-rules-update-transform-rules", + "parameters": [ + { + "in": "path", + "name": "phase", + "required": true, + "schema": { "$ref": "#/components/schemas/schemas-phase" } + }, + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_ruleset" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single" } } }, + "description": "Update Transform Rules response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Transform Rules response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Transform Rules", + "tags": ["Transform Rules"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions": { + "get": { + "description": "Fetches the versions of a zone entry point ruleset.", + "operationId": "zone-rulesets-list-a-zone-entry-point-ruleset'-s-versions", + "parameters": [ + { + "in": "path", + "name": "ruleset_phase", + "required": true, + "schema": { "$ref": "#/components/schemas/phase" } + }, + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rulesets_response" } } }, + "description": "List a zone entry point ruleset's versions response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/rulesets_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List a zone entry point ruleset's versions response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List a zone entry point ruleset's versions", + "tags": ["Zone Rulesets"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions/{ruleset_version}": { + "get": { + "description": "Fetches a specific version of a zone entry point ruleset.", + "operationId": "zone-rulesets-get-a-zone-entry-point-ruleset-version", + "parameters": [ + { + "in": "path", + "name": "ruleset_version", + "required": true, + "schema": { "$ref": "#/components/schemas/version-VHkxmcSG" } + }, + { + "in": "path", + "name": "ruleset_phase", + "required": true, + "schema": { "$ref": "#/components/schemas/phase" } + }, + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } }, + "description": "Get a zone entry point ruleset version response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/ruleset_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get a zone entry point ruleset version response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a zone entry point ruleset version", + "tags": ["Zone Rulesets"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_id}/rulesets/{ruleset_id}": { + "delete": { + "description": "Deletes all versions of an existing zone ruleset.", + "operationId": "zone-rulesets-delete-a-zone-ruleset", + "parameters": [ + { + "in": "path", + "name": "ruleset_id", + "required": true, + "schema": { "$ref": "#/components/schemas/rulesets_components-schemas-id" } + }, + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { "content": { "application/json": {} }, "description": "Delete a zone ruleset response" }, + "4xx": { "content": { "application/json": {} }, "description": "Delete a zone ruleset response failure" } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete a zone ruleset", + "tags": ["Zone Rulesets"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "get": { + "description": "Fetches the latest version of a zone ruleset.", + "operationId": "zone-rulesets-get-a-zone-ruleset", + "parameters": [ + { + "in": "path", + "name": "ruleset_id", + "required": true, + "schema": { "$ref": "#/components/schemas/rulesets_components-schemas-id" } + }, + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } }, + "description": "Get a zone ruleset response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/ruleset_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get a zone ruleset response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a zone ruleset", + "tags": ["Zone Rulesets"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "put": { + "description": "Updates a zone ruleset, creating a new version.", + "operationId": "zone-rulesets-update-a-zone-ruleset", + "parameters": [ + { + "in": "path", + "name": "ruleset_id", + "required": true, + "schema": { "$ref": "#/components/schemas/rulesets_components-schemas-id" } + }, + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_ruleset" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } }, + "description": "Update a zone ruleset response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/ruleset_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update a zone ruleset response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update a zone ruleset", + "tags": ["Zone Rulesets"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_id}/rulesets/{ruleset_id}/rules": { + "post": { + "description": "Adds a new rule to a zone ruleset. The rule will be added to the end of the existing list of rules in the ruleset.", + "operationId": "zone-rulesets-create-a-zone-ruleset-rule", + "parameters": [ + { + "in": "path", + "name": "ruleset_id", + "required": true, + "schema": { "$ref": "#/components/schemas/rulesets_components-schemas-id" } + }, + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_update_rule" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } }, + "description": "Create a zone ruleset rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/ruleset_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create a zone ruleset rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create a zone ruleset rule", + "tags": ["Zone Rulesets"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id}": { + "delete": { + "description": "Deletes an existing rule from a zone ruleset.", + "operationId": "zone-rulesets-delete-a-zone-ruleset-rule", + "parameters": [ + { + "in": "path", + "name": "rule_id", + "required": true, + "schema": { "$ref": "#/components/schemas/rules_components-schemas-id" } + }, + { + "in": "path", + "name": "ruleset_id", + "required": true, + "schema": { "$ref": "#/components/schemas/rulesets_components-schemas-id" } + }, + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } }, + "description": "Delete a zone ruleset rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/ruleset_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete a zone ruleset rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete a zone ruleset rule", + "tags": ["Zone Rulesets"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "patch": { + "description": "Updates an existing rule in a zone ruleset.", + "operationId": "zone-rulesets-update-a-zone-ruleset-rule", + "parameters": [ + { + "in": "path", + "name": "rule_id", + "required": true, + "schema": { "$ref": "#/components/schemas/rules_components-schemas-id" } + }, + { + "in": "path", + "name": "ruleset_id", + "required": true, + "schema": { "$ref": "#/components/schemas/rulesets_components-schemas-id" } + }, + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/create_update_rule" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } }, + "description": "Update a zone ruleset rule response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/ruleset_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update a zone ruleset rule response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update a zone ruleset rule", + "tags": ["Zone Rulesets"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_id}/rulesets/{ruleset_id}/versions": { + "get": { + "description": "Fetches the versions of a zone ruleset.", + "operationId": "zone-rulesets-list-a-zone-ruleset'-s-versions", + "parameters": [ + { + "in": "path", + "name": "ruleset_id", + "required": true, + "schema": { "$ref": "#/components/schemas/rulesets_components-schemas-id" } + }, + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rulesets_response" } } }, + "description": "List a zone ruleset's versions response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/rulesets_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List a zone ruleset's versions response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List a zone ruleset's versions", + "tags": ["Zone Rulesets"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}": { + "delete": { + "description": "Deletes an existing version of a zone ruleset.", + "operationId": "zone-rulesets-delete-a-zone-ruleset-version", + "parameters": [ + { + "in": "path", + "name": "ruleset_version", + "required": true, + "schema": { "$ref": "#/components/schemas/version-VHkxmcSG" } + }, + { + "in": "path", + "name": "ruleset_id", + "required": true, + "schema": { "$ref": "#/components/schemas/rulesets_components-schemas-id" } + }, + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { "content": { "application/json": {} }, "description": "Delete a zone ruleset version response" }, + "4xx": { + "content": { "application/json": {} }, + "description": "Delete a zone ruleset version response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete a zone ruleset version", + "tags": ["Zone Rulesets"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "get": { + "description": "Fetches a specific version of a zone ruleset.", + "operationId": "zone-rulesets-get-a-zone-ruleset-version", + "parameters": [ + { + "in": "path", + "name": "ruleset_version", + "required": true, + "schema": { "$ref": "#/components/schemas/version-VHkxmcSG" } + }, + { + "in": "path", + "name": "ruleset_id", + "required": true, + "schema": { "$ref": "#/components/schemas/rulesets_components-schemas-id" } + }, + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ruleset_response" } } }, + "description": "Get a zone ruleset version response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/ruleset_response" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get a zone ruleset version response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get a zone ruleset version", + "tags": ["Zone Rulesets"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_id}/url_normalization": { + "get": { + "description": "Fetches the current URL normalization settings.", + "operationId": "url-normalization-get-url-normalization-settings", + "parameters": [ + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-response_model" } } }, + "description": "Get URL normalization settings response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-response_model" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get URL normalization settings response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get URL normalization settings", + "tags": ["URL Normalization"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + }, + "put": { + "description": "Updates the URL normalization settings.", + "operationId": "url-normalization-update-url-normalization-settings", + "parameters": [ + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-request_model" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-response_model" } } }, + "description": "Update URL normalization settings response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-response_model" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update URL normalization settings response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update URL normalization settings", + "tags": ["URL Normalization"], + "x-cfPlanAvailability": { "business": true, "enterprise": true, "free": true, "pro": true } + } + }, + "/zones/{zone_id}/workers/filters": { + "get": { + "deprecated": true, + "operationId": "worker-filters-(-deprecated)-list-filters", + "parameters": [ + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/filter-response-collection" } } + }, + "description": "List Filters response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/filter-response-collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Filters response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Filters", + "tags": ["Worker Filters (Deprecated)"], + "x-cfDeprecation": { + "description": "This endpoint and its related APIs are deprecated in favor of the `/routes` equivalent APIs. These APIs are for use with the previously limited single-script zones.", + "display": true, + "id": "worker_filter_deprecation" + } + }, + "post": { + "deprecated": true, + "operationId": "worker-filters-(-deprecated)-create-filter", + "parameters": [ + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/filter-no-id" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single-id-u7jsvBJu" } } + }, + "description": "Create Filter response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single-id-u7jsvBJu" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Filter response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Filter", + "tags": ["Worker Filters (Deprecated)"], + "x-cfDeprecation": { + "description": "This endpoint and its related APIs are deprecated in favor of the `/routes` equivalent APIs. These APIs are for use with the previously limited single-script zones.", + "display": true, + "id": "worker_filter_deprecation" + } + } + }, + "/zones/{zone_id}/workers/filters/{filter_id}": { + "delete": { + "deprecated": true, + "operationId": "worker-filters-(-deprecated)-delete-filter", + "parameters": [ + { + "in": "path", + "name": "filter_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single-id-u7jsvBJu" } } + }, + "description": "Delete Filter response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single-id-u7jsvBJu" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Filter response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Filter", + "tags": ["Worker Filters (Deprecated)"], + "x-cfDeprecation": { + "description": "This endpoint and its related APIs are deprecated in favor of the `/routes` equivalent APIs. These APIs are for use with the previously limited single-script zones.", + "display": true, + "id": "worker_filter_deprecation" + } + }, + "put": { + "deprecated": true, + "operationId": "worker-filters-(-deprecated)-update-filter", + "parameters": [ + { + "in": "path", + "name": "filter_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/filter-no-id" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/filter-response-single" } } }, + "description": "Update Filter response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/filter-response-single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Filter response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Filter", + "tags": ["Worker Filters (Deprecated)"], + "x-cfDeprecation": { + "description": "This endpoint and its related APIs are deprecated in favor of the `/routes` equivalent APIs. These APIs are for use with the previously limited single-script zones.", + "display": true, + "id": "worker_filter_deprecation" + } + } + }, + "/zones/{zone_id}/workers/routes": { + "get": { + "operationId": "worker-routes-list-routes", + "parameters": [ + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/route-response-collection" } } + }, + "description": "List Routes response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/route-response-collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Routes response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Routes", + "tags": ["Worker Routes"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.route.list"] } + }, + "post": { + "operationId": "worker-routes-create-route", + "parameters": [ + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/route-no-id" } } }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single-id-u7jsvBJu" } } + }, + "description": "Create Route response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single-id-u7jsvBJu" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Route response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Route", + "tags": ["Worker Routes"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.route.create"] } + } + }, + "/zones/{zone_id}/workers/routes/{route_id}": { + "delete": { + "operationId": "worker-routes-delete-route", + "parameters": [ + { + "in": "path", + "name": "route_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single-id-u7jsvBJu" } } + }, + "description": "Delete Route response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single-id-u7jsvBJu" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Route response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Route", + "tags": ["Worker Routes"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.route.delete"] } + }, + "get": { + "operationId": "worker-routes-get-route", + "parameters": [ + { + "in": "path", + "name": "route_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/route-response-single" } } }, + "description": "Get Route response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/route-response-single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Route response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Route", + "tags": ["Worker Routes"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.route.read"] } + }, + "put": { + "operationId": "worker-routes-update-route", + "parameters": [ + { + "in": "path", + "name": "route_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "path", + "name": "zone_id", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/route-no-id" } } }, + "required": true + }, + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/route-response-single" } } }, + "description": "Update Route response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/route-response-single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Route response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Route", + "tags": ["Worker Routes"], + "x-cfPermissionsRequired": { "enum": ["com.cloudflare.edge.worker.route.update"] } + } + }, + "/zones/{zone}/spectrum/analytics/aggregate/current": { + "get": { + "description": "Retrieves analytics aggregated from the last minute of usage on Spectrum applications underneath a given zone.", + "operationId": "spectrum-aggregate-analytics-get-current-aggregated-analytics", + "parameters": [ + { + "in": "path", + "name": "zone", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { "in": "query", "name": "appID", "schema": { "$ref": "#/components/schemas/app_id_param" } }, + { "in": "query", "name": "app_id_param", "schema": { "$ref": "#/components/schemas/app_id_param" } }, + { + "in": "query", + "name": "colo_name", + "schema": { "description": "Co-location identifier.", "example": "PDX", "maxLength": 3, "type": "string" } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/analytics-aggregate_components-schemas-response_collection" } + } + }, + "description": "Get current aggregated analytics response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/analytics-aggregate_components-schemas-response_collection" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get current aggregated analytics response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get current aggregated analytics", + "tags": ["Spectrum Aggregate Analytics"] + } + }, + "/zones/{zone}/spectrum/analytics/events/bytime": { + "get": { + "description": "Retrieves a list of aggregate metrics grouped by time interval.", + "operationId": "spectrum-analytics-(-by-time)-get-analytics-by-time", + "parameters": [ + { + "in": "path", + "name": "zone", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { "in": "query", "name": "dimensions", "schema": { "$ref": "#/components/schemas/dimensions-ICwErPf5" } }, + { "in": "query", "name": "sort", "schema": { "$ref": "#/components/schemas/sort-KhE8n2c0" } }, + { "in": "query", "name": "until", "schema": { "$ref": "#/components/schemas/schemas-until" } }, + { + "in": "query", + "name": "metrics", + "schema": { + "description": "One or more metrics to compute. Options are: \n\nMetric | Name | Example | Unit\n--------------------------|-------------------------------------|--------------------------|--------------------------\ncount | Count of total events | 1000 | Count\nbytesIngress | Sum of ingress bytes | 1000 | Sum\nbytesEgress | Sum of egress bytes | 1000 | Sum\ndurationAvg | Average connection duration | 1.0 | Time in milliseconds\ndurationMedian | Median connection duration | 1.0 | Time in milliseconds\nduration90th | 90th percentile connection duration | 1.0 | Time in milliseconds\nduration99th | 99th percentile connection duration | 1.0 | Time in milliseconds.", + "example": ["count", "bytesIngress"], + "items": { + "enum": [ + "count", + "bytesIngress", + "bytesEgress", + "durationAvg", + "durationMedian", + "duration90th", + "duration99th" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "in": "query", + "name": "filters", + "schema": { + "description": "Used to filter rows by one or more dimensions. Filters can be combined using OR and AND boolean logic. AND takes precedence over OR in all the expressions. The OR operator is defined using a comma (,) or OR keyword surrounded by whitespace. The AND operator is defined using a semicolon (;) or AND keyword surrounded by whitespace. Note that the semicolon is a reserved character in URLs (rfc1738) and needs to be percent-encoded as %3B. Comparison options are: \n\nOperator | Name | URL Encoded\n--------------------------|---------------------------------|--------------------------\n== | Equals | %3D%3D\n!= | Does not equals | !%3D\n\u003e | Greater Than | %3E\n\u003c | Less Than | %3C\n\u003e= | Greater than or equal to | %3E%3D\n\u003c= | Less than or equal to | %3C%3D .", + "example": "event==disconnect%20AND%20coloName!=SFO", + "type": "string" + } + }, + { + "in": "query", + "name": "since", + "schema": { + "description": "Start of time interval to query, defaults to `until` - 6 hours. Timestamp must be in RFC3339 format and uses UTC unless otherwise specified.", + "example": "2014-01-02T02:20:00Z", + "format": "date-time", + "type": "string" + } + }, + { + "in": "query", + "name": "time_delta", + "schema": { + "description": "Used to select time series resolution.", + "enum": ["year", "quarter", "month", "week", "day", "hour", "dekaminute", "minute"], + "example": "minute", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single" } } }, + "description": "Get analytics by time response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get analytics by time response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get analytics by time", + "tags": ["Spectrum Analytics (By Time)"] + } + }, + "/zones/{zone}/spectrum/analytics/events/summary": { + "get": { + "description": "Retrieves a list of summarised aggregate metrics over a given time period.", + "operationId": "spectrum-analytics-(-summary)-get-analytics-summary", + "parameters": [ + { + "in": "path", + "name": "zone", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { "in": "query", "name": "dimensions", "schema": { "$ref": "#/components/schemas/dimensions-ICwErPf5" } }, + { "in": "query", "name": "sort", "schema": { "$ref": "#/components/schemas/sort-KhE8n2c0" } }, + { "in": "query", "name": "until", "schema": { "$ref": "#/components/schemas/schemas-until" } }, + { + "in": "query", + "name": "metrics", + "schema": { + "description": "One or more metrics to compute. Options are: \n\nMetric | Name | Example | Unit\n--------------------------|-------------------------------------|--------------------------|--------------------------\ncount | Count of total events | 1000 | Count\nbytesIngress | Sum of ingress bytes | 1000 | Sum\nbytesEgress | Sum of egress bytes | 1000 | Sum\ndurationAvg | Average connection duration | 1.0 | Time in milliseconds\ndurationMedian | Median connection duration | 1.0 | Time in milliseconds\nduration90th | 90th percentile connection duration | 1.0 | Time in milliseconds\nduration99th | 99th percentile connection duration | 1.0 | Time in milliseconds.", + "example": ["count", "bytesIngress"], + "items": { + "enum": [ + "count", + "bytesIngress", + "bytesEgress", + "durationAvg", + "durationMedian", + "duration90th", + "duration99th" + ], + "type": "string" + }, + "type": "array" + } + }, + { + "in": "query", + "name": "filters", + "schema": { + "description": "Used to filter rows by one or more dimensions. Filters can be combined using OR and AND boolean logic. AND takes precedence over OR in all the expressions. The OR operator is defined using a comma (,) or OR keyword surrounded by whitespace. The AND operator is defined using a semicolon (;) or AND keyword surrounded by whitespace. Note that the semicolon is a reserved character in URLs (rfc1738) and needs to be percent-encoded as %3B. Comparison options are: \n\nOperator | Name | URL Encoded\n--------------------------|---------------------------------|--------------------------\n== | Equals | %3D%3D\n!= | Does not equals | !%3D\n\u003e | Greater Than | %3E\n\u003c | Less Than | %3C\n\u003e= | Greater than or equal to | %3E%3D\n\u003c= | Less than or equal to | %3C%3D .", + "example": "event==disconnect%20AND%20coloName!=SFO", + "type": "string" + } + }, + { + "in": "query", + "name": "since", + "schema": { + "description": "Start of time interval to query, defaults to `until` - 6 hours. Timestamp must be in RFC3339 format and uses UTC unless otherwise specified.", + "example": "2014-01-02T02:20:00Z", + "format": "date-time", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api-response-single" } } }, + "description": "Get analytics summary response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get analytics summary response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get analytics summary", + "tags": ["Spectrum Analytics (Summary)"] + } + }, + "/zones/{zone}/spectrum/apps": { + "get": { + "description": "Retrieves a list of currently existing Spectrum applications inside a zone.", + "operationId": "spectrum-applications-list-spectrum-applications", + "parameters": [ + { + "in": "path", + "name": "zone", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + }, + { + "in": "query", + "name": "page", + "schema": { + "description": "Page number of paginated results. This parameter is required in order to use other pagination parameters. If included in the query, `result_info` will be present in the response.", + "example": 1, + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "per_page", + "schema": { + "default": 20, + "description": "Sets the maximum number of results per page.", + "maximum": 100, + "minimum": 1, + "type": "number" + } + }, + { + "in": "query", + "name": "direction", + "schema": { + "default": "asc", + "description": "Sets the direction by which results are ordered.", + "enum": ["asc", "desc"], + "example": "desc", + "type": "string" + } + }, + { + "in": "query", + "name": "order", + "schema": { + "default": "dns", + "description": "Application field by which results are ordered.", + "enum": ["protocol", "app_id", "created_on", "modified_on", "dns"], + "example": "protocol", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { "$ref": "#/components/schemas/components-schemas-response_collection-7Rg5C3fo" } + } + }, + "description": "List Spectrum applications response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/components-schemas-response_collection-7Rg5C3fo" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "List Spectrum applications response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "List Spectrum applications", + "tags": ["Spectrum Applications"] + }, + "post": { + "description": "Creates a new Spectrum application from a configuration using a name for the origin.", + "operationId": "spectrum-applications-create-spectrum-application-using-a-name-for-the-origin", + "parameters": [ + { + "in": "path", + "name": "zone", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "argo_smart_routing": { "$ref": "#/components/schemas/argo_smart_routing" }, + "dns": { "$ref": "#/components/schemas/dns" }, + "edge_ips": { "$ref": "#/components/schemas/edge_ips" }, + "ip_firewall": { "$ref": "#/components/schemas/ip_firewall" }, + "origin_dns": { "$ref": "#/components/schemas/origin_dns" }, + "origin_port": { "$ref": "#/components/schemas/origin_port" }, + "protocol": { "$ref": "#/components/schemas/protocol" }, + "proxy_protocol": { "$ref": "#/components/schemas/proxy_protocol" }, + "tls": { "$ref": "#/components/schemas/tls" }, + "traffic_type": { "$ref": "#/components/schemas/traffic_type" } + }, + "required": ["protocol", "dns", "origin_dns", "origin_port"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/response_single_origin_dns" } } + }, + "description": "Create Spectrum application using a name for the origin response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/response_single_origin_dns" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Create Spectrum application using a name for the origin response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Create Spectrum application using a name for the origin", + "tags": ["Spectrum Applications"] + } + }, + "/zones/{zone}/spectrum/apps/{app_id}": { + "delete": { + "description": "Deletes a previously existing application.", + "operationId": "spectrum-applications-delete-spectrum-application", + "parameters": [ + { + "in": "path", + "name": "app_id", + "required": true, + "schema": { "$ref": "#/components/schemas/app_id-yTGvAfYO" } + }, + { + "in": "path", + "name": "zone", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { "content": { "application/json": {} }, "required": true }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { "id": { "$ref": "#/components/schemas/app_id-yTGvAfYO" } }, + "type": "object" + } + }, + "type": "object" + } + ] + } + } + }, + "description": "Delete Spectrum application response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "allOf": [ + { "$ref": "#/components/schemas/api-response-single" }, + { + "properties": { + "result": { + "properties": { "id": { "$ref": "#/components/schemas/app_id-yTGvAfYO" } }, + "type": "object" + } + }, + "type": "object" + } + ] + }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Delete Spectrum application response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Delete Spectrum application", + "tags": ["Spectrum Applications"] + }, + "get": { + "description": "Gets the application configuration of a specific application inside a zone.", + "operationId": "spectrum-applications-get-spectrum-application-configuration", + "parameters": [ + { + "in": "path", + "name": "app_id", + "required": true, + "schema": { "$ref": "#/components/schemas/app_id-yTGvAfYO" } + }, + { + "in": "path", + "name": "zone", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "responses": { + "200": { + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/schemas-response_single" } } }, + "description": "Get Spectrum application configuration response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/schemas-response_single" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Get Spectrum application configuration response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Get Spectrum application configuration", + "tags": ["Spectrum Applications"] + }, + "put": { + "description": "Updates a previously existing application's configuration that uses a name for the origin.", + "operationId": "spectrum-applications-update-spectrum-application-configuration-using-a-name-for-the-origin", + "parameters": [ + { + "in": "path", + "name": "app_id", + "required": true, + "schema": { "$ref": "#/components/schemas/app_id-yTGvAfYO" } + }, + { + "in": "path", + "name": "zone", + "required": true, + "schema": { "$ref": "#/components/schemas/common_components-schemas-identifier" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "argo_smart_routing": { "$ref": "#/components/schemas/argo_smart_routing" }, + "dns": { "$ref": "#/components/schemas/dns" }, + "edge_ips": { "$ref": "#/components/schemas/edge_ips" }, + "ip_firewall": { "$ref": "#/components/schemas/ip_firewall" }, + "origin_dns": { "$ref": "#/components/schemas/origin_dns" }, + "origin_port": { "$ref": "#/components/schemas/origin_port" }, + "protocol": { "$ref": "#/components/schemas/protocol" }, + "proxy_protocol": { "$ref": "#/components/schemas/proxy_protocol" }, + "tls": { "$ref": "#/components/schemas/tls" }, + "traffic_type": { "$ref": "#/components/schemas/traffic_type" } + }, + "required": ["protocol", "dns", "origin_dns", "origin_port"], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/response_single_origin_dns" } } + }, + "description": "Update Spectrum application configuration using a name for the origin response" + }, + "4xx": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { "$ref": "#/components/schemas/response_single_origin_dns" }, + { "$ref": "#/components/schemas/api-response-common-failure" } + ] + } + } + }, + "description": "Update Spectrum application configuration using a name for the origin response failure" + } + }, + "security": [{ "api_email": [], "api_key": [] }, { "api_token": [] }], + "summary": "Update Spectrum application configuration using a name for the origin", + "tags": ["Spectrum Applications"] + } + } + }, + "servers": [{ "description": "Client API", "url": "https://api.cloudflare.com/client/v4" }] +} diff --git a/test/specs/large-file-memory-leak/large-file-memory-leak.spec.js b/test/specs/large-file-memory-leak/large-file-memory-leak.spec.js new file mode 100644 index 00000000..cea8288e --- /dev/null +++ b/test/specs/large-file-memory-leak/large-file-memory-leak.spec.js @@ -0,0 +1,36 @@ +const { expect } = require('chai'); + +const OpenAPIParser = require('../../..'); +const helper = require('../../utils/helper'); +const path = require('../../utils/path'); + +describe('Large file memory leak protection', function () { + this.timeout(20000); + + const tests = [ + { + name: 'cloudflare spec (stringified to a single line)', + file: 'cloudflare-stringified.json', + }, + { + name: 'cloudflare spec', + file: 'cloudflare.json', + }, + ]; + + for (const test of tests) { + it(test.name, async function () { + try { + await OpenAPIParser.validate(path.rel(`specs/large-file-memory-leak/${test.file}`)); + helper.shouldNotGetCalled(); + } catch (err) { + expect(err).to.be.an.instanceOf(SyntaxError); + expect(err.message).to.match(/^OpenAPI schema validation failed.\n(.*)+/); + expect((err.message.match(/4xx is not expected to be here!/g) || []).length).to.equal(20); + expect(err.message).to.contain( + 'Plus an additional 1016 errors. Please resolve the above and re-run validation to see more.' + ); + } + }); + } +});